Package org.cytoscape.filter.model
Interface ElementTransformer<C,E>
-
- Type Parameters:
C
- The context type of the elements this {code ElementTransformer} operates on.E
- The element type this {code ElementTransformer} operates on.
- All Superinterfaces:
Transformer<C,E>
public interface ElementTransformer<C,E> extends Transformer<C,E>
A transformer that transforms its input one element at a time and pushes the results into the given sink. To make a customElementTransformer
available in Cytoscape, create anElementTransformerFactory
that constructs the customElementTransformer
, 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. TheElementTransformer
,ElementTransformerFactory
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, E element, TransformerSink<E> sink)
Transforms the givenelement
.-
Methods inherited from interface org.cytoscape.filter.model.Transformer
addListener, getContextType, getElementType, getId, getName, removeListener
-
-
-
-
Method Detail
-
apply
void apply(C context, E element, TransformerSink<E> sink)
Transforms the givenelement
. The results of the transformation are collected bysink
.- Parameters:
context
- the context object of the transformed element.element
- the element to transform.sink
- collects the results of the transformation.
-
-