Package 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
,AbstractRootNetworkCollectionTask
,AbstractRowTask
,AbstractTableCellTask
,AbstractTableColumnTask
,AbstractTableTask
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
Modifier and TypeFieldDescriptionprotected boolean
If this is true, we should abort whatever theTask
is currently doing in the run() method. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
cancel()
Calling this attempts to abort the currentTask
.protected final void
insertTasksAfterCurrentTask
(Task... newTasks) Inserts "newTasks" after the current Task, in the TaskIterator that is being managed by this class.protected final 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 theTask
begins execution.final void
setTaskIterator
(TaskIterator taskIterator) This method is used by aTaskIterator
to set itself on the newly added Task.
-
Field Details
-
cancelled
protected volatile boolean cancelledIf this is true, we should abort whatever theTask
is currently doing in the run() method.
-
-
Constructor Details
-
AbstractTask
public AbstractTask()
-
-
Method Details
-
setTaskIterator
This method is used by aTaskIterator
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
-
insertTasksAfterCurrentTask
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
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
Description copied from interface:Task
This method is called when theTask
begins execution. This method should not be called by the programmer, as it will be called by theTaskManager
.- Specified by:
run
in interfaceTask
- Parameters:
taskMonitor
- TheTaskMonitor
provided byTaskManager
. to allow theTask
to modify its user interface.- Throws:
Exception
- TheTask
is at liberty to throw an exception inrun
. The exception is caught byTaskManager
and is displayed in the interface. If aTask
does not throw an exception, theTask
implementation does not need to specify thethrows Exception
clause for therun
method. Moreover, exceptions should be the way theTask
communicates the occurrence of a fatal error, like a low-level exception or an invalid parameter, to theTaskManager
.
-
cancel
public void cancel()Calling this attempts to abort the currentTask
. How well this works depends on the granularity of the implementingTask
checking whether the "canceled" is true or not and then taking appropriate action.
-