org.trianacode.taskgraph.service

Class RunnableTask

java.lang.Object

org.trianacode.taskgraph.imp.ToolImp

org.trianacode.taskgraph.imp.TaskImp

org.trianacode.taskgraph.service.AbstractRunnableTask

org.trianacode.taskgraph.service.RunnableTask

All Implemented Interfaces:

java.lang.Runnable, ClipableTaskInterface, ControlInterface, RunnableInstance, RunnableInterface, Task, Tool

public class RunnableTask
extends AbstractRunnableTask
implements RunnableInstance, RunnableInterface, ControlInterface, java.lang.Runnable

An extension to Task that allows the underlying OldUnit to be instantiated and run.

Nested Class Summary

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

Task.ConnectionStatus

Field Summary

Fields

Modifier and Type	Field and Description
int	packetsLeft The count for the number of data packets still not output

Fields inherited from class org.trianacode.taskgraph.service.AbstractRunnableTask

execlisteners

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

Modifier	Constructor and Description
protected	RunnableTask(Tool task, TaskFactory factory, boolean preserveinst)

Method Summary

Methods

Modifier and Type	Method and Description
void	afterProcess()
void	beforeProcess() This function is called immediately before the unit's process() function is called
void	dispose() disposes of the running unit
ClipInStore	extractClipInState()
void	finished() Tells the Unit that an output node has finished sending the data.
java.lang.Object	getClipIn(java.lang.Object data, java.lang.String name)
java.lang.Object	getClipIn(java.lang.String name)
ControlInterface	getControlInterface()
java.lang.Object	getInput(int nodeNumber) Returns the data at input node nodeNumber.
protected java.lang.Object	getInput(RunnableNodeInterface node) Returns the data at the specified input node.
Task	getTask()
ToolTable	getToolTable()
void	initUnit() Initializes the unit associated with this runnable task.
boolean	isClipInName(java.lang.String name)
boolean	isInput(int nodeNumber)
boolean	isOutputSent(int outputNode)
protected void	notifyParameterSet(java.lang.String name, java.lang.String type, java.lang.Object oldval, java.lang.Object newval) Notifies all the task listeners that a parameter has been set.
void	output(int outputNode, java.lang.Object data, boolean blocking) Outputs the data to the given node outputNode.
void	output(java.lang.Object data) b Outputs the data from the unit.
void	process() Tries running the process() method.
void	putClipIn(java.lang.String name, java.lang.Object clipin) Put the specified clip-in into this task's clip-in bucket
void	queueClipIn(java.lang.String name, java.lang.Object clipin) Queue the specified clip-in to be inserted into the clip-in bucket when the task is next run
java.lang.Object	removeClipIn(java.lang.String name) Remove the clip-in with the specified name from this task.
void	reset() Order a unit to stop, resets the unit to its pre-run state
void	restoreClipInState(ClipInStore store) Restores a previously stored clip-in bucket state
void	run() This over-rides the RunnableUnit's run method so that we can display the data flow indicators on the icons when we are processing data.
void	runGroup() Runs all the tasks within the group that this task belongs to.
void	runTask(Task task) Runs the specified task.
void	startThread() creates the thread to run the unit, or set a flag to re-run the existing thread
void	wakeUp() Tells a task to wake-up if data has been received on all of its essential nodes.
void	wakeUp(Node node) Tells the Task to wake up if data has been received on all of its essential nodes.

Methods inherited from class org.trianacode.taskgraph.service.AbstractRunnableTask

addExecutionListener, executionFinished, executionRequested, executionReset, executionStarting, getExecutionState, notifyError, pause, removeExecutionListener, resume, setParent, waitPause

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, 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.service.RunnableInstance

addExecutionListener, getExecutionState, pause, removeExecutionListener, resume

Methods inherited from interface org.trianacode.taskgraph.service.RunnableInterface

notifyError

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

packetsLeft

public int packetsLeft

The count for the number of data packets still not output

Constructor Detail

RunnableTask

protected RunnableTask(Tool task,
            TaskFactory factory,
            boolean preserveinst)
                throws TaskException

Throws:

TaskException

Method Detail

initUnit

public void initUnit()
              throws TaskException

Initializes the unit associated with this runnable task.

Throws:

TaskException

getTask

public Task getTask()

Specified by:

getTask in interface RunnableInterface

Returns:

the task interface for this runnable task.

getControlInterface

public ControlInterface getControlInterface()

Specified by:

getControlInterface in interface RunnableInterface

Returns:

the control interface to the scheduler (returns null if the task is not a control task)

getToolTable

public ToolTable getToolTable()

Specified by:

getToolTable in interface RunnableInterface

Returns:

the current tool table

getClipIn

public java.lang.Object getClipIn(java.lang.String name)

Specified by:

getClipIn in interface ClipableTaskInterface

Returns:

the clip-in attached to this task with the specified name (null if not present). The flag indicates whether the clip

getClipIn

public java.lang.Object getClipIn(java.lang.Object data,
                         java.lang.String name)

Specified by:

getClipIn in interface ClipableTaskInterface

Returns:

the clip-in with the specified name that came attached to the the specified data item (null if not present). Only clip-ins for data that has been input in the current process can be retrieved.

isClipInName

public boolean isClipInName(java.lang.String name)

Specified by:

isClipInName in interface ClipableTaskInterface

Returns:

true if a clip-in with the specified name exists in this task's clip-in bucket

putClipIn

public void putClipIn(java.lang.String name,
             java.lang.Object clipin)

Put the specified clip-in into this task's clip-in bucket

Specified by:

putClipIn in interface ClipableTaskInterface

queueClipIn

public void queueClipIn(java.lang.String name,
               java.lang.Object clipin)

Queue the specified clip-in to be inserted into the clip-in bucket when the task is next run

Specified by:

queueClipIn in interface ClipableTaskInterface

removeClipIn

public java.lang.Object removeClipIn(java.lang.String name)

Remove the clip-in with the specified name from this task.

Specified by:

removeClipIn in interface ClipableTaskInterface

Returns:

the removed clip-in (or null if unknown)

extractClipInState

public ClipInStore extractClipInState()

Specified by:

extractClipInState in interface ClipableTaskInterface

Returns:

a copy of the current clip-in bucket

restoreClipInState

public void restoreClipInState(ClipInStore store)

Restores a previously stored clip-in bucket state

Specified by:

restoreClipInState in interface ClipableTaskInterface

finished

public final void finished()

Tells the Unit that an output node has finished sending the data. Here, we simply decrement the packetsLeft variabe which is set to be equal to the number of non-blocking nodes wich are sending the data.

Specified by:

finished in interface RunnableInstance

Specified by:

finished in class AbstractRunnableTask

wakeUp

public final void wakeUp()

Tells a task to wake-up if data has been received on all of its essential nodes.

Specified by:

wakeUp in interface RunnableInstance

Specified by:

wakeUp in class AbstractRunnableTask

wakeUp

public final void wakeUp(Node node)

Tells the Task to wake up if data has been received on all of its essential nodes. The parameter indicates the node that received data to cause this wake-up.

Specified by:

wakeUp in interface RunnableInstance

Specified by:

wakeUp in class AbstractRunnableTask

startThread

public final void startThread()

creates the thread to run the unit, or set a flag to re-run the existing thread

isInput

public boolean isInput(int nodeNumber)

Specified by:

isInput in interface RunnableInterface

Returns:

true if there is data waiting on the specified node

getInput

public java.lang.Object getInput(int nodeNumber)
                          throws OutOfRangeException,
                                 EmptyingException,
                                 NotCompatibleException

Returns the data at input node nodeNumber. If data is not ready, NOT_READY triana type is returned. If there is no cable connected to the input node the NOT_CONNECTED triana type is returned.

Specified by:

getInput in interface RunnableInterface

Parameters:

nodeNumber - the node you want to get the data from.

Returns:

the data input at node nodeNumber

Throws:

OutOfRangeException

EmptyingException

NotCompatibleException

getInput

protected java.lang.Object getInput(RunnableNodeInterface node)

Returns the data at the specified input node. If data is not ready, NOT_READY triana type is returned. If there is no cable connected to the input node the NOT_CONNECTED triana type is returned.

output

public void output(java.lang.Object data)

b Outputs the data from the unit. This passses the given data set to the first output node and then makes copies for any other output nodes.

Specified by:

output in interface RunnableInterface

Parameters:

data - the data to be sent

output

public void output(int outputNode,
          java.lang.Object data,
          boolean blocking)

Outputs the data to the given node outputNode. If specified this method blocks until the data is successfully sent, otherwise, if non-blocking, isOutputSent() can be used to poll whether the data has been successfully sent. This method is used to set the data at each particular output node if this is necessary, otherwise use output(Object data) to copy the data across all nodes.

Specified by:

output in interface RunnableInterface

Parameters:

outputNode - the output node you wish to set

data - the data to be sent

isOutputSent

public boolean isOutputSent(int outputNode)

Specified by:

isOutputSent in interface RunnableInterface

Returns:

true if the data sent with the non-blocking send call has reached its destination

run

public void run()

This over-rides the RunnableUnit's run method so that we can display the data flow indicators on the icons when we are processing data.

Specified by:

run in interface java.lang.Runnable

reset

public void reset()

Order a unit to stop, resets the unit to its pre-run state

Specified by:

reset in interface RunnableInstance

Overrides:

reset in class AbstractRunnableTask

runTask

public void runTask(Task task)
             throws SchedulerException

Runs the specified task.

If execution is paused then this method waits until execution is resumed, or throws a SchedulerException if execution is reset.

Specified by:

runTask in interface ControlInterface

Throws:

SchedulerException

runGroup

public void runGroup()
              throws SchedulerException

Runs all the tasks within the group that this task belongs to.

If execution is paused then this method waits until execution is resumed, or throws a SchedulerException if execution is reset.

Specified by:

runGroup in interface ControlInterface

Throws:

SchedulerException

process

public void process()

Tries running the process() method.

TODO: Better error handling

beforeProcess

public void beforeProcess()

This function is called immediately before the unit's process() function is called

afterProcess

public void afterProcess()

notifyParameterSet

protected void notifyParameterSet(java.lang.String name,
                      java.lang.String type,
                      java.lang.Object oldval,
                      java.lang.Object newval)

Description copied from class: TaskImp

Notifies all the task listeners that a parameter has been set.

Overrides:

notifyParameterSet in class TaskImp

dispose

public void dispose()

disposes of the running unit

Specified by:

dispose in interface Task

Overrides:

dispose in class AbstractRunnableTask