Package org.cytoscape.task
Interface TableColumnTaskFactory
-
- All Known Subinterfaces:
DeleteColumnTaskFactory
,RenameColumnTaskFactory
- All Known Implementing Classes:
AbstractTableColumnTaskFactory
public interface TableColumnTaskFactory
A task factory that creates one or more tasks that operate on the specified CyColumn.Module:
core-task-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>core-task-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 TaskIterator
createTaskIterator(CyColumn column)
Used to provision this factory with aCyColumn
that will be used to create tasks.boolean
isReady(CyColumn column)
Returns true if this task factory is ready to produce a TaskIterator.
-
-
-
Method Detail
-
createTaskIterator
TaskIterator createTaskIterator(CyColumn column)
Used to provision this factory with aCyColumn
that will be used to create tasks.- Parameters:
column
- a non-null CyColumn.- Returns:
- A TaskIterator object containing one or more
Task
objects to execute.
-
isReady
boolean isReady(CyColumn column)
Returns true if this task factory is ready to produce a TaskIterator.- Parameters:
column
- a non-null CyColumn.- Returns:
- true if this task factory is ready to produce a TaskIterator.
-
-