org.trianacode.taskgraph.service

Class AbstractRunnableTask

java.lang.Object

org.trianacode.taskgraph.imp.ToolImp

org.trianacode.taskgraph.imp.TaskImp

org.trianacode.taskgraph.service.AbstractRunnableTask

All Implemented Interfaces:

RunnableInstance, Task, Tool

Direct Known Subclasses:

AbstractServiceTask, RunnableTask

public abstract class AbstractRunnableTask
extends TaskImp
implements RunnableInstance

An abstract runnable task. Responsible for providing common functionality to runnable tasks, such as execution state listeners.

Nested Class Summary

Nested classes/interfaces inherited from interface org.trianacode.taskgraph.Task

Task.ConnectionStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashSet	execlisteners a list of the execution listeners for this task

Fields inherited from interface org.trianacode.taskgraph.Task

DEFAULT_NODE_REQUIREMENT, DEPRECATED_GUI_XPOS, DEPRECATED_GUI_YPOS, ERROR_MESSAGE, ESSENTIAL, ESSENTIAL_IF_CONNECTED, EXECUTION_COUNT, EXECUTION_REQUEST_COUNT, EXECUTION_STATE, GUI_X, GUI_Y, NODE_PROPERTIES, NODE_REQUIREMENT, OPTIONAL, OUTPUT_TYPE

Fields inherited from interface org.trianacode.taskgraph.tool.Tool

ANY_DATA_TYPE, CLONE_ALL_OUTPUT, CLONE_MULTIPLE_OUTPUT, COPY_OUTPUT, DEFAULT_IN_NODES, DEFAULT_INPUT_NODES, DEFAULT_MAX_NODES, DEFAULT_MIN_NODES, DEFAULT_OUT_NODES, DEFAULT_OUTPUT_NODES, DEFAULT_POP_UP_DESCRIPTION, DEFINITION_JAVA_CLASS, DEFINITION_METADATA, DEFINITION_TRIANA_XML, DEFINITION_UNKNOWN, GUI, GUI_BUILDER, HELP_FILE_PARAM, IMMEDIATE_UPDATE, INTERNAL, LATE_INITIALIZE, MAX_INPUT_NODES, MAX_OUTPUT_NODES, MIN_INPUT_NODES, MIN_OUTPUT_NODES, NO_UPDATE, OLD_GUI_BUILDER, ON_TASK_INSTANTIATION, ON_USER_ACCESS, OUTPUT_POLICY, PANEL_INSTANCE, PARAM_PANEL_CLASS, PARAM_PANEL_HIDE, PARAM_PANEL_INSTANTIATE, PARAM_PANEL_SHOW, PARAM_UPDATE_POLICY, POP_UP_DESCRIPTION, PROCESS_UPDATE, TOOL_VERSION, TRANSIENT, TRANSIENT_ACCESSIBLE, UNKNOWN_DATA_TYPE, UNKNOWN_TYPE, USER_ACCESSIBLE

Constructor Summary

Constructors

Constructor and Description
AbstractRunnableTask(Tool tool, TaskFactory factory, boolean preserveinst)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecutionListener(ExecutionListener listener) Adds a execution listener to this runnable instance
void	dispose() cleans up any operations associated with this task
protected void	executionFinished() Called by subclass when execution is finished
protected void	executionRequested() Called by subclass when execution is requested
protected void	executionReset() Called by subclass when execution is reset
protected void	executionStarting() Called by subclass when execution is starting
abstract void	finished() Tell the data monitor that this thread monitor has completed outputting the data i.e.
ExecutionState	getExecutionState()
void	notifyError(java.lang.String message) Stops the scheduler.
void	pause() Request a runnable instance to pause
void	removeExecutionListener(ExecutionListener listener) Removes a execution listener from this runnable instance
void	reset() Order a runnable instance to stop and reset it to its pre-run state
void	resume() Request a runnable instance to resume (unpause)
void	setParent(TaskGraph taskgraph) Sets the taskgraph that this task is located within
protected void	waitPause() waits until the task is unpaused
abstract void	wakeUp() Indicates to the runnable instance that a wake-up signal has been received from the scheduler.
abstract void	wakeUp(Node node) Indicates to the runnable instance that a wake-up signal has been received from the specified node (e.g.

Methods inherited from class org.trianacode.taskgraph.imp.TaskImp

addDataInputNode, addDataOutputNode, addDeclaredNodeProperty, addParameterInputNode, addParameterOutputNode, addTaskListener, getAbsoluteNodeIndex, getContext, getContextProperty, getDataInputNode, getDataInputNodeCount, getDataInputNodes, getDataOutputNode, getDataOutputNodeCount, getDataOutputNodes, getDeclaredNodeProperties, getDefaultNodeRequirement, getErrorMessage, getExecutionCount, getExecutionRequestCount, getInputNode, getInputNodes, getInstanceID, getNodeIndex, getNodeRequirement, getOutputNode, getOutputNodes, getParameterInputName, getParameterInputNode, getParameterInputNodeCount, getParameterInputNodes, getParameterOutputName, getParameterOutputNode, getParameterOutputNodeCount, getParameterOutputNodes, getParent, getQualifiedTaskName, getUltimateParent, init, isDataInputNode, isDataOutputNode, isParameterInputNode, isParameterOutputNode, isParameterTriggerNode, isRunContinuously, notifyNodeAdded, notifyNodeRemoved, notifyParameterSet, notifyPropertyUpdate, notifyTaskDisposed, removeDataInputNode, removeDataOutputNode, removeNode, removeParameter, removeParameterInputNode, removeParameterOutputNode, removeProxy, removeTaskListener, setContextProperty, setDataInputNodeCount, setDataOutputNodeCount, setDeclaredNodeProperties, setDefaultNodeRequirement, setNodeRequirement, setParameter, setParameterInputs, setParameterOutputNames, setProxy, setRunContinuously, setSubTitle, setToolName, updateProxy

Methods inherited from class org.trianacode.taskgraph.imp.ToolImp

addExtension, addRenderingHint, getDataInputTypes, getDataInputTypes, getDataOutputTypes, getDataOutputTypes, getDefaultDataInputNodes, getDefaultDataOutputNodes, getDefinitionPath, getDefinitionType, getDisplayName, getDisplayPackage, getExtension, getExtensionNames, getHelpFile, getInputNodeCount, getMaxDataInputNodes, getMaxDataOutputNodes, getMinDataInputNodes, getMinDataOutputNodes, getOutputNodeCount, getParameter, getParameterNames, getParameterType, getPopUpDescription, getProperties, getProxy, getQualifiedToolName, getRenderingHint, getRenderingHints, getSubTitle, getToolBox, getToolName, getToolPackage, getUnitName, getUnitPackage, getVersion, isExtensionName, isParameterName, isRenderingHint, removeExtension, removeRenderingHint, setDataInputTypes, setDataInputTypes, setDataOutputTypes, setDataOutputTypes, setDefaultDataInputNodes, setDefaultDataOutputNodes, setDefinitionPath, setDefinitionType, setDisplayName, setDisplayPackage, setHelpFile, setMaxDataInputNodes, setMaxDataOutputNodes, setMinDataInputNodes, setMinDataOutputNodes, setParameterOutputs, setParameterType, setPopUpDescription, setProperties, setToolBox, setToolPackage, setVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.trianacode.taskgraph.tool.Tool

addExtension, addRenderingHint, getDataInputTypes, getDataInputTypes, getDataOutputTypes, getDataOutputTypes, getDefaultDataInputNodes, getDefaultDataOutputNodes, getDefinitionPath, getDefinitionType, getDisplayName, getDisplayPackage, getExtension, getExtensionNames, getHelpFile, getInputNodeCount, getMaxDataInputNodes, getMaxDataOutputNodes, getMinDataInputNodes, getMinDataOutputNodes, getOutputNodeCount, getParameter, getParameterNames, getParameterType, getPopUpDescription, getProperties, getProxy, getQualifiedToolName, getRenderingHint, getRenderingHints, getSubTitle, getToolBox, getToolName, getToolPackage, getVersion, isExtensionName, isParameterName, isRenderingHint, removeExtension, removeRenderingHint, setDataInputTypes, setDataOutputTypes, setDefinitionPath, setDefinitionType, setHelpFile, setParameterOutputs, setParameterType, setPopUpDescription, setProperties, setToolBox, setToolPackage, setVersion

Field Detail

execlisteners

protected java.util.HashSet execlisteners

a list of the execution listeners for this task

Constructor Detail

AbstractRunnableTask

public AbstractRunnableTask(Tool tool,
                    TaskFactory factory,
                    boolean preserveinst)
                     throws TaskException

Throws:

TaskException

Method Detail

setParent

public void setParent(TaskGraph taskgraph)

Description copied from class: TaskImp

Sets the taskgraph that this task is located within

Specified by:

setParent in interface Task

Overrides:

setParent in class TaskImp

addExecutionListener

public void addExecutionListener(ExecutionListener listener)

Adds a execution listener to this runnable instance

Specified by:

addExecutionListener in interface RunnableInstance

removeExecutionListener

public void removeExecutionListener(ExecutionListener listener)

Removes a execution listener from this runnable instance

Specified by:

removeExecutionListener in interface RunnableInstance

getExecutionState

public ExecutionState getExecutionState()

Specified by:

getExecutionState in interface RunnableInstance

Specified by:

getExecutionState in interface Task

Overrides:

getExecutionState in class TaskImp

Returns:

the current state of the runnable instance (e.g. runnable task)

executionRequested

protected void executionRequested()

Called by subclass when execution is requested

executionStarting

protected void executionStarting()

Called by subclass when execution is starting

executionFinished

protected void executionFinished()

Called by subclass when execution is finished

executionReset

protected void executionReset()

Called by subclass when execution is reset

wakeUp

public abstract void wakeUp()

Indicates to the runnable instance that a wake-up signal has been received from the scheduler. It is up to a task to respond to this wake-up, or to ignore it if wake-ups have not been received from all the nodes a task requires to execute.

Specified by:

wakeUp in interface RunnableInstance

wakeUp

public abstract void wakeUp(Node node)

Indicates to the runnable instance that a wake-up signal has been received from the specified node (e.g. data is available on that node). A runnable instance should only run when it has received wake-ups from all the nodes it requires to execute.

Specified by:

wakeUp in interface RunnableInstance

pause

public void pause()

Request a runnable instance to pause

Specified by:

pause in interface RunnableInstance

resume

public void resume()

Request a runnable instance to resume (unpause)

Specified by:

resume in interface RunnableInstance

reset

public void reset()

Order a runnable instance to stop and reset it to its pre-run state

Specified by:

reset in interface RunnableInstance

finished

public abstract void finished()

Tell the data monitor that this thread monitor has completed outputting the data i.e. the data has been received by the receiving process.

Specified by:

finished in interface RunnableInstance

waitPause

protected void waitPause()

waits until the task is unpaused

notifyError

public void notifyError(java.lang.String message)
                 throws NotifyErrorException

Stops the scheduler. This maybe needed if your unit produced some exception and you may want the algorithm to stop and ask the user to sort the problem out before resuming.

Throws:

NotifyErrorException

dispose

public void dispose()

cleans up any operations associated with this task

Specified by:

dispose in interface Task

Overrides:

dispose in class TaskImp