org.cytoscape.task

Interface NetworkViewCollectionTaskFactory

All Known Subinterfaces:

ApplyPreferredLayoutTaskFactory, ApplyVisualStyleTaskFactory, DestroyNetworkViewTaskFactory

All Known Implementing Classes:

AbstractNetworkViewCollectionTaskFactory

public interface NetworkViewCollectionTaskFactory

A task factory that creates one or more tasks that operate on the specified collection of network views.

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

Method Detail

createTaskIterator

TaskIterator createTaskIterator(Collection<CyNetworkView> networkViews)

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

Parameters:

networkViews - a non-null collection of CyNetworkViews

Returns:

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

isReady

boolean isReady(Collection<CyNetworkView> networkViews)

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

Parameters:

networkViews - a non-null collection of CyNetworkViews

Returns:

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