Package org.cytoscape.task
Interface TableCellTaskFactory
-
- All Known Implementing Classes:
AbstractTableCellTaskFactory
public interface TableCellTaskFactory
A task factory that creates one or more tasks that operate on the specified CyColumn along with primary key.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, Object primaryKeyValue)
Used to provision this factory with aCyColumn
and a primary key that will be used to create tasks.boolean
isReady(CyColumn column, Object primaryKeyValue)
Returns true if this task factory is ready to produce a TaskIterator.
-
-
-
Method Detail
-
createTaskIterator
TaskIterator createTaskIterator(CyColumn column, Object primaryKeyValue)
Used to provision this factory with aCyColumn
and a primary key that will be used to create tasks.- Parameters:
column
- a non-null CyColumnprimaryKeyValue
- a non-null primary key value- Returns:
- A TaskIterator object containing one or more
Task
objects to execute.
-
-