Package org.cytoscape.filter

Interface TransformerContainer<C,E>

Type Parameters:

C - The context type for transformers this TransformerContainer contains.

E - The element type for transformers this TransformerContainer contains.

public interface TransformerContainer<C,E>

A class that contains and manages a list of Transformers. Typically these transformers will show up in the Select tab of the Cytoscape UI. How to acquire this service in your CyActivator:

 TransformerContainer<CyNetwork,CyIdentifiable> filterContainer = getService(TransformerContainer.class, "(container.type=filter)");
 TransformerContainer<CyNetwork,CyIdentifiable> chainTransformerContainer = getService(TransformerContainer.class, "(container.type=chain)");
 

Method Summary

Modifier and Type	Method	Description
void	addNamedTransformer(NamedTransformer<C,E> transformer)	Add a NamedTransformer to this container.
NamedTransformer<C,E>	getNamedTransformer(String name)	Returns the transformer with the given name, or null if a transformer with the given name does not exist in this container.
List<NamedTransformer<C,E>>	getNamedTransformers()	Returns the list of transformers contained in this container.
boolean	removeNamedTransformer(String name)	Remove a transformer from this container.

Method Details

addNamedTransformer

void addNamedTransformer(NamedTransformer<C,E> transformer)

Add a NamedTransformer to this container. A NamedTransformer can be created using TransformerManager.createNamedTransformer(String, java.util.List) or loaded from a JSON file using CyTransformerReader.

See Also:

TransformerManager.createNamedTransformer(String, java.util.List), CyTransformerReader

removeNamedTransformer

boolean removeNamedTransformer(String name)

Remove a transformer from this container.

Returns:

true if the transformer with the given name exists and was removed, false otherwise.

getNamedTransformer

NamedTransformer<C,E> getNamedTransformer(String name)

Returns the transformer with the given name, or null if a transformer with the given name does not exist in this container.

getNamedTransformers

List<NamedTransformer<C,E>> getNamedTransformers()

Returns the list of transformers contained in this container.