Package 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, SelectEdgesBetweenSelectedNodesTaskFactory, 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.

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.

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>

  • Method Summary

    Modifier and Type
    Method
    Description
    TaskIterator
    createTaskIterator(CyNetwork network)
    Provisions this factory with the CyNetwork that will be passed into any task created by it.
    default boolean
    isOn(CyNetwork network)
    If this task factory implements the Togglable interface then this method determines if the button or check box is on or off.
    boolean
    isReady(CyNetwork network)
    Returns true if this task factory is ready to produce a TaskIterator.

  • Method Details

    • 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.

    • isOn

      default boolean isOn(CyNetwork network)
      If this task factory implements the Togglable interface then this method determines if the button or check box is on or off.
      Since:
      3.9