Package org.cytoscape.task
Interface NetworkCollectionTaskFactory
- All Known Subinterfaces:
AnalyzeNetworkCollectionTaskFactory
,CreateNetworkViewTaskFactory
,DestroyNetworkTaskFactory
- All Known Implementing Classes:
AbstractNetworkCollectionTaskFactory
public interface NetworkCollectionTaskFactory
Produces a task iterator for the specified collection of networks.
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.
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>
-
Method Summary
Modifier and TypeMethodDescriptioncreateTaskIterator(Collection<CyNetwork> networks)
Provisions this factory with the collection of networks that will be passed into any task created by it.default boolean
isOn(Collection<CyNetwork> networks)
If this task factory implements theTogglable
interface then this method determines if the button or check box is on or off.boolean
isReady(Collection<CyNetwork> networks)
Returns true if this task factory is ready to produce a task iterator.
-
Method Details
-
createTaskIterator
Provisions this factory with the collection of networks that will be passed into any task created by it. -
isReady
Returns true if this task factory is ready to produce a task iterator.- Parameters:
networks
- a non-null collection ofCyNetwork
s- Returns:
- true if this task factory is ready to produce a task iterator.
-
isOn
If this task factory implements theTogglable
interface then this method determines if the button or check box is on or off.- Since:
- 3.9
-