org.trianacode.taskgraph.service

Class NonRunnableTask

java.lang.Object

org.trianacode.taskgraph.imp.ToolImp

org.trianacode.taskgraph.imp.TaskImp

org.trianacode.taskgraph.service.NonRunnableTask

All Implemented Interfaces:

RunnableInstance, Task, Tool

public class NonRunnableTask
extends TaskImp
implements RunnableInstance

A non-runnable task is one that can be included in a runnable taskgraph, but will throw an exception if an attempt to run it is made. This task therefore needs to be removed/replaced before the taskgraph is executed.

Nested Class Summary

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

Task.ConnectionStatus

Field Summary

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
NonRunnableTask(Tool tool, TaskFactory factory, boolean preservinst)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecutionListener(ExecutionListener listener) Adds a execution state listener to this runnable instance
void	finished() Tell the data monitor that this thread monitor has completed outputting the data i.e.
ExecutionState	getExecutionState()
void	pause() Request a runnable instance to stop, this is not an interupt method, halting time of runnable instance is not guaranteed;
void	removeExecutionListener(ExecutionListener listener) Removes a execution state 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	wakeUp() Tells a runnable instance (e.g.
void	wakeUp(Node node) Tells the runnable instance (e.g.

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

addDataInputNode, addDataOutputNode, addDeclaredNodeProperty, addParameterInputNode, addParameterOutputNode, addTaskListener, dispose, 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, setParent, 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

Constructor Detail

NonRunnableTask

public NonRunnableTask(Tool tool,
               TaskFactory factory,
               boolean preservinst)
                throws TaskException

Throws:

TaskException

Method Detail

addExecutionListener

public void addExecutionListener(ExecutionListener listener)

Adds a execution state listener to this runnable instance

Specified by:

addExecutionListener in interface RunnableInstance

removeExecutionListener

public void removeExecutionListener(ExecutionListener listener)

Removes a execution state 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 execution state of the task

wakeUp

public void wakeUp()

Tells a runnable instance (e.g. runnable task) to wake-up if data has been received on all of its essential nodes.

Specified by:

wakeUp in interface RunnableInstance

wakeUp

public void wakeUp(Node node)

Tells the runnable instance (e.g. runnable 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

pause

public void pause()

Request a runnable instance to stop, this is not an interupt method, halting time of runnable instance is not guaranteed;

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 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