Package org.cytoscape.filter.model

Interface HolisticTransformer<C,E>

Type Parameters:

C - The context type of the elements this HolisticTransformer operates on.

E - The element type this HolisticTransformer 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 custom HolisticTransformer available in Cytoscape, create an HolisticTransformerFactory that constructs the custom HolisticTransformer, 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 HolisticTransformer, HolisticTransformerFactory 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, TransformerSource<C,E> source, TransformerSink<E> sink)	Transforms the elements in source from context.

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

addListener, getContextType, getElementType, getId, getName, removeListener

Method Details

apply

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

Transforms the elements in source from context. The results of the transformation are collected by sink.

Parameters:

context - the context object of the transformed element.

source - provides the elements to transform.

sink - collects the results of the transformation.