org.cytoscape.work

Class AbstractTask

java.lang.Object

org.cytoscape.work.AbstractTask

All Implemented Interfaces:

Task

Direct Known Subclasses:

AbstractCyNetworkReader, AbstractEdgeViewTask, AbstractLayoutTask, AbstractNetworkCollectionTask, AbstractNetworkTask, AbstractNetworkViewCollectionTask, AbstractNetworkViewTask, AbstractNodeViewTask, AbstractRowTask, AbstractTableCellTask, AbstractTableColumnTask, AbstractTableTask

public abstract class AbstractTask
extends Object
implements Task

A base class for tasks that need to be able to access the TaskIterator that contains them.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Module: work-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>work-api</artifactId>
</dependency>

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancelled If this is true, we should abort whatever the Task is currently doing in the run() method.

Constructor Summary

Constructors

Constructor and Description
AbstractTask()

Method Summary

Modifier and Type	Method and Description
void	cancel() Calling this attempts to abort the current Task.
TaskIterator	getTaskIterator()
protected void	insertTasksAfterCurrentTask(Task... newTasks) Inserts "newTasks" after the current Task, in the TaskIterator that is being managed by this class.
protected void	insertTasksAfterCurrentTask(TaskIterator newTasks) Inserts "newTasks" after the current Task, in the TaskIterator that is being managed by this class.
abstract void	run(TaskMonitor taskMonitor) This method is called when the Task begins execution.
void	setTaskIterator(TaskIterator taskIterator) This method is used by a TaskIterator to set itself on the newly added Task.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cancelled

protected volatile boolean cancelled

If this is true, we should abort whatever the Task is currently doing in the run() method.

Constructor Detail

AbstractTask

public AbstractTask()

Method Detail

setTaskIterator

public final void setTaskIterator(TaskIterator taskIterator)

This method is used by a TaskIterator to set itself on the newly added Task. This method should not be called by otherwise.

Parameters:

taskIterator - TaskIterator that will set itself on the newly added task.

getTaskIterator

public TaskIterator getTaskIterator()

insertTasksAfterCurrentTask

protected final void insertTasksAfterCurrentTask(Task... newTasks)

Inserts "newTasks" after the current Task, in the TaskIterator that is being managed by this class.

Parameters:

newTasks - tasks to insert after the current task in the TaskIterator that is being managed by this class.

insertTasksAfterCurrentTask

protected final void insertTasksAfterCurrentTask(TaskIterator newTasks)

Inserts "newTasks" after the current Task, in the TaskIterator that is being managed by this class.

Parameters:

newTasks - the TaskIterator to insert after the current task in the TaskIterator that is being managed by this class.

run

public abstract void run(TaskMonitor taskMonitor)
                  throws Exception

Description copied from interface: Task

This method is called when the Task begins execution. This method should not be called by the programmer, as it will be called by the TaskManager.

Specified by:

run in interface Task

Parameters:

taskMonitor - The TaskMonitor provided by TaskManager. to allow the Task to modify its user interface.

Throws:

Exception - The Task is at liberty to throw an exception in run. The exception is caught by TaskManager and is displayed in the interface. If a Task does not throw an exception, the Task implementation does not need to specify the throws Exception clause for the run method. Moreover, exceptions should be the way the Task communicates the occurrence of a fatal error, like a low-level exception or an invalid parameter, to the TaskManager.

cancel

public void cancel()

Calling this attempts to abort the current Task. How well this works depends on the granularity of the implementing Task checking whether the "canceled" is true or not and then taking appropriate action.

Specified by:

cancel in interface Task