org.cytoscape.task

Interface NetworkViewTaskFactory

All Known Subinterfaces:

ExportNetworkImageTaskFactory, ExportNetworkViewTaskFactory, GroupNodesTaskFactory, HideSelectedEdgesTaskFactory, HideSelectedNodesTaskFactory, HideSelectedTaskFactory, HideUnselectedEdgesTaskFactory, HideUnselectedNodesTaskFactory, HideUnselectedTaskFactory, UnGroupTaskFactory, UnHideAllEdgesTaskFactory, UnHideAllNodesTaskFactory, UnHideAllTaskFactory

All Known Implementing Classes:

AbstractNetworkViewTaskFactory

public interface NetworkViewTaskFactory

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

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(CyNetworkView networkView) Creates a new TaskIterator using the given CyNetworkView
boolean	isReady(CyNetworkView networkView) Returns true if this task factory is ready to produce a TaskIterator.

Method Detail

createTaskIterator

TaskIterator createTaskIterator(CyNetworkView networkView)

Creates a new TaskIterator using the given CyNetworkView

Parameters:

networkView - a non-null network view

Returns:

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

isReady

boolean isReady(CyNetworkView networkView)

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

Parameters:

networkView -

Returns:

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