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 custom ElementTransformer available in Cytoscape, create an ElementTransformerFactory that constructs the custom ElementTransformer, and register the factory as an OSGi service. To make the transformer show up in the UI, create a TransformerViewFactory and register it as an OSGi service. The ElementTransformer, ElementTransformerFactory and TransformerViewFactory need to have the same id.

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.

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>

Method Summary

Modifier and Type	Method	Description
void	apply(C context, E element, TransformerSink<E> sink)	Transforms the given element.

Methods inherited from interface org.cytoscape.filter.model.Transformer

addListener, getContextType, getElementType, getId, getName, removeListener

Method Details

apply

void apply(C context,
 E element,
 TransformerSink<E> sink)

Transforms the given element. The results of the transformation are collected by sink.

Parameters:

context - the context object of the transformed element.

element - the element to transform.

sink - collects the results of the transformation.