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.

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

Modifier and Type	Method and Description
TaskIterator	createTaskIterator(Collection<CyNetwork> networks) Provisions this factory with the collection of networks that will be passed into any task created by it.
boolean	isReady(Collection<CyNetwork> networks) Returns true if this task factory is ready to produce a task iterator.

Method Detail

createTaskIterator

TaskIterator createTaskIterator(Collection<CyNetwork> networks)

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

Parameters:

networks - a non-null collection of CyNetworks

Returns:

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

isReady

boolean isReady(Collection<CyNetwork> networks)

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

Parameters:

networks - a non-null collection of CyNetworks

Returns:

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