Package org.cytoscape.filter.model
Interface HolisticTransformer<C,E>
-
- Type Parameters:
C
- The context type of the elements thisHolisticTransformer
operates on.E
- The element type thisHolisticTransformer
operates on.
- All Superinterfaces:
Transformer<C,E>
public interface HolisticTransformer<C,E> extends Transformer<C,E>
A transformer that takes its input altogether, transforms it, and pushes the results into the given sink. To make a customHolisticTransformer
available in Cytoscape, create anHolisticTransformerFactory
that constructs the customHolisticTransformer
, and register the factory as an OSGi service. To make the transformer show up in the UI, create aTransformerViewFactory
and register it as an OSGi service. TheHolisticTransformer
,HolisticTransformerFactory
andTransformerViewFactory
need to have the same id.Module:
filter-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>filter-api</artifactId> </dependency>
Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
apply(C context, TransformerSource<C,E> source, TransformerSink<E> sink)
Transforms the elements insource
fromcontext
.-
Methods inherited from interface org.cytoscape.filter.model.Transformer
addListener, getContextType, getElementType, getId, getName, removeListener
-
-
-
-
Method Detail
-
apply
void apply(C context, TransformerSource<C,E> source, TransformerSink<E> sink)
Transforms the elements insource
fromcontext
. The results of the transformation are collected bysink
.- Parameters:
context
- the context object of the transformed element.source
- provides the elements to transform.sink
- collects the results of the transformation.
-
-