org.cytoscape.task

Interface RootNetworkCollectionTaskFactory

All Known Implementing Classes:

AbstractRootNetworkCollectionTaskFactory

public interface RootNetworkCollectionTaskFactory

Produces a task iterator for the specified collection of root-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 Type	Method and Description
TaskIterator	createTaskIterator(Collection<CyRootNetwork> networks) Provisions this factory with the collection of root-networks that will be passed into any task created by it.
boolean	isReady(Collection<CyRootNetwork> networks) Returns true if this task factory is ready to produce a task iterator.

Method Detail

createTaskIterator

TaskIterator createTaskIterator(Collection<CyRootNetwork> networks)

Provisions this factory with the collection of root-networks that will be passed into any task created by it.

Parameters:

networks - a non-null collection of CyRootNetworks

Returns:

A TaskIterator object containing one or more Task objects to execute.

isReady

boolean isReady(Collection<CyRootNetwork> networks)

Returns true if this task factory is ready to produce a task iterator.

Parameters:

networks - a non-null collection of CyRootNetworks

Returns:

true if this task factory is ready to produce a task iterator.