Package org.cytoscape.task

Interface RowTaskFactory

public interface RowTaskFactory
A task factory that creates one or more tasks that operate on the specified CyRow.

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(CyRow row)
    Provisions this factory with the CyRow that will be passed into any task created by it.
    default boolean
    isOn(CyRow row)
    If this task factory implements the Togglable interface then this method determines if the button or check box is on or off.
    boolean
    isReady(CyRow row)
    Returns true if this task factory is ready to produce a TaskIterator.

  • Method Details

    • createTaskIterator

      TaskIterator createTaskIterator(CyRow row)
      Provisions this factory with the CyRow that will be passed into any task created by it.
      Parameters:
      row - a non-null CyRow
      Returns:
      A TaskIterator object containing one or more Task objects to execute.

    • isReady

      boolean isReady(CyRow row)
      Returns true if this task factory is ready to produce a TaskIterator.
      Parameters:
      row - a non-null CyRow
      Returns:
      true if this task factory is ready to produce a TaskIterator.

    • isOn

      default boolean isOn(CyRow row)
      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