Package org.cytoscape.filter.model
Interface TransformerSource<C,E>
-
- Type Parameters:
C
- The context type of the elements thisFilter
operates on.E
- The element type thisFilter
operates on.
public interface TransformerSource<C,E>
Provides a sequence of elements from a context. Instances of this interface must be threadsafe.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 (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Class<C>
getContextType()
Returns the type of the context object thisTransformerSource
is compatible with.int
getElementCount(C context)
Returns the number of elements that could be produced from the given context.List<E>
getElementList(C context)
Returns aList
of elements from the given context.Class<E>
getElementType()
Returns the type of the elements thisTransformerSource
is compatible with.
-
-
-
Method Detail
-
getElementList
List<E> getElementList(C context)
Returns aList
of elements from the given context.- Parameters:
context
- the source of the elements.- Returns:
- a
List
of elements.
-
getContextType
Class<C> getContextType()
Returns the type of the context object thisTransformerSource
is compatible with.- Returns:
- the type of the context object.
-
getElementType
Class<E> getElementType()
Returns the type of the elements thisTransformerSource
is compatible with.- Returns:
- the type of the elements.
-
getElementCount
int getElementCount(C context)
Returns the number of elements that could be produced from the given context.- Parameters:
context
- the context whose elements should be counted.- Returns:
- the number of elements that could be produced from the given context.
-
-