Package org.cytoscape.task
Interface TableTaskFactory
-
- All Known Subinterfaces:
DeleteTableTaskFactory,ExportTableTaskFactory,ImportDataTableTaskFactory,JoinTablesTaskTaskFactory,MapGlobalToLocalTableTaskFactory,MapTableToNetworkTablesTaskFactory
- All Known Implementing Classes:
AbstractTableTaskFactory
public interface TableTaskFactoryA task factory that creates one or more tasks that operate on the specified CyTable.Module:
core-task-apiTo 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 TaskIteratorcreateTaskIterator(CyTable table)Used to provision this factory with aCyTablethat will be used to create tasks.booleanisReady(CyTable table)Returns true if this task factory is ready to produce a TaskIterator.
-
-
-
Method Detail
-
createTaskIterator
TaskIterator createTaskIterator(CyTable table)
Used to provision this factory with aCyTablethat will be used to create tasks.- Parameters:
table- a non-null CyTable- Returns:
- A TaskIterator object containing one or more
Taskobjects to execute.
-
isReady
boolean isReady(CyTable table)
Returns true if this task factory is ready to produce a TaskIterator.- Parameters:
table- a non-null CyTable- Returns:
- true if this task factory is ready to produce a TaskIterator.
-
-