Package org.cytoscape.task

Interface TableCellTaskFactory

All Known Implementing Classes:
AbstractTableCellTaskFactory
public interface TableCellTaskFactory
A task factory that creates one or more tasks that operate on the specified CyColumn along with primary key.

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(CyColumn column, Object primaryKeyValue)
    Used to provision this factory with a CyColumn and a primary key that will be used to create tasks.
    default boolean
    isOn(CyColumn column, Object primaryKeyValue)
    If this task factory implements the Togglable interface then this method determines if the button or check box is on or off.
    boolean
    isReady(CyColumn column, Object primaryKeyValue)
    Returns true if this task factory is ready to produce a TaskIterator.

  • Method Details

    • createTaskIterator

      TaskIterator createTaskIterator(CyColumn column, Object primaryKeyValue)
      Used to provision this factory with a CyColumn and a primary key that will be used to create tasks.
      Parameters:
      column - a non-null CyColumn
      primaryKeyValue - a non-null primary key value
      Returns:
      A TaskIterator object containing one or more Task objects to execute.

    • isReady

      boolean isReady(CyColumn column, Object primaryKeyValue)
      Returns true if this task factory is ready to produce a TaskIterator.
      Parameters:
      column - a non-null CyColumn
      primaryKeyValue - a non-null primary key value
      Returns:
      true if this task factory is ready to produce a TaskIterator.

    • isOn

      default boolean isOn(CyColumn column, Object primaryKeyValue)
      If this task factory implements the Togglable interface then this method determines if the button or check box is on or off.
      Parameters:
      primaryKeyValue - a non-null primary key value
      Returns:
      true if the toggle state of this task is "on".
      Since:
      3.9