org.cytoscape.task
Interface EdgeViewTaskFactory

All Known Implementing Classes:

AbstractEdgeViewTaskFactory

public interface EdgeViewTaskFactory

A task factory that creates one or more tasks that operate on the specified View<CyEdge> within the specified CyNetworkView.

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

TaskIterator	createTaskIterator(View<CyEdge> edgeView, CyNetworkView networkView) Creates a new TaskIterator using the given edge view and network view.
boolean	isReady(View<CyEdge> edgeView, CyNetworkView networkView) Returns true if this task factory is ready to produce a TaskIterator.

Method Detail

createTaskIterator

TaskIterator createTaskIterator(View<CyEdge> edgeView,
                                CyNetworkView networkView)

Creates a new TaskIterator using the given edge view and network view.

Parameters:

edgeView - a non-null edge view

networkView - a non-null network view

Returns:

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

isReady

boolean isReady(View<CyEdge> edgeView,
                CyNetworkView networkView)

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

Parameters:

edgeView - a non-null edge view

networkView - a non-null network view

Returns:

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