org.cytoscape.task

Interface NetworkTaskFactory

All Known Subinterfaces:

CloneNetworkTaskFactory, ConnectSelectedNodesTaskFactory, DeleteSelectedNodesAndEdgesTaskFactory, DeselectAllEdgesTaskFactory, DeselectAllNodesTaskFactory, DeselectAllTaskFactory, EditNetworkTitleTaskFactory, ExportNetworkTaskFactory, InvertSelectedEdgesTaskFactory, InvertSelectedNodesTaskFactory, NewNetworkSelectedNodesAndEdgesTaskFactory, NewNetworkSelectedNodesOnlyTaskFactory, SelectAdjacentEdgesTaskFactory, SelectAllEdgesTaskFactory, SelectAllNodesTaskFactory, SelectAllTaskFactory, SelectConnectedNodesTaskFactory, SelectFirstNeighborsTaskFactory, SelectFromFileListTaskFactory

All Known Implementing Classes:

AbstractNetworkTaskFactory

public interface NetworkTaskFactory

A task factory that creates one or more tasks that operate on the specified CyNetwork.

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(CyNetwork network) Provisions this factory with the CyNetwork that will be passed into any task created by it.
boolean	isReady(CyNetwork network) Returns true if this task factory is ready to produce a TaskIterator.

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyNetwork network)

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

Parameters:

network - a non-null CyNetwork

Returns:

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

isReady

boolean isReady(CyNetwork network)

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

Parameters:

network - a non-null CyNetwork

Returns:

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