Package org.cytoscape.task

Interface TableColumnTaskFactory

All Known Subinterfaces:
DeleteColumnTaskFactory, RenameColumnTaskFactory
All Known Implementing Classes:
AbstractTableColumnTaskFactory
public interface TableColumnTaskFactory
A task factory that creates one or more tasks that operate on the specified CyColumn.

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)
    Used to provision this factory with a CyColumn that will be used to create tasks.
    default boolean
    isOn(CyColumn column)
    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)
    Returns true if this task factory is ready to produce a TaskIterator.

  • Method Details

    • createTaskIterator

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

    • isReady

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

    • isOn

      default boolean isOn(CyColumn column)
      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