org.trianacode.taskgraph.imp

Class TaskImp

java.lang.Object

org.trianacode.taskgraph.imp.ToolImp

org.trianacode.taskgraph.imp.TaskImp

All Implemented Interfaces:

Task, Tool

Direct Known Subclasses:

AbstractRunnableTask, NonRunnableTask, TaskGraphImp

public class TaskImp
extends ToolImp
implements Task

A task within a taskgraph.

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

Method Summary

Methods

Modifier and Type	Method and Description
Node	addDataInputNode() Adds a data input node.
Node	addDataOutputNode() Adds a data output node.
void	addDeclaredNodeProperty(java.lang.String prop)
ParameterNode	addParameterInputNode(java.lang.String paramname) Adds a parameter input node for the specified parameter name.
ParameterNode	addParameterOutputNode(java.lang.String paramname) Adds a parameter output node for the specified paramter name.
void	addTaskListener(TaskListener listener) Adds a task listener to this task.
void	dispose() cleans up any operations associated with this task
int	getAbsoluteNodeIndex(Node node) This is a convience method to provide backward compatibility with TrianaGUI, in which parameter nodes where indexed after data nodes.
TaskGraphContext	getContext()
java.lang.Object	getContextProperty(java.lang.String name)
Node	getDataInputNode(int index)
int	getDataInputNodeCount()
Node[]	getDataInputNodes()
Node	getDataOutputNode(int index)
int	getDataOutputNodeCount()
Node[]	getDataOutputNodes()
java.util.List<java.lang.String>	getDeclaredNodeProperties()
java.lang.String	getDefaultNodeRequirement()
java.lang.String	getErrorMessage()
int	getExecutionCount()
int	getExecutionRequestCount()
ExecutionState	getExecutionState()
Node	getInputNode(int absoluteindex)
Node[]	getInputNodes()
java.lang.String	getInstanceID() All copies of a task within a parameter space (sharing the same parameters) have the same intance id.
int	getNodeIndex(Node node) Returns the index of the specified node within the data input/output and parameter input/output nodes; or -1 if not attached to this task.
java.lang.String	getNodeRequirement(int index)
Node	getOutputNode(int absoluteindex)
Node[]	getOutputNodes()
java.lang.String	getParameterInputName(int index)
ParameterNode	getParameterInputNode(int index)
int	getParameterInputNodeCount()
ParameterNode[]	getParameterInputNodes()
java.lang.String	getParameterOutputName(int index)
ParameterNode	getParameterOutputNode(int index)
int	getParameterOutputNodeCount()
ParameterNode[]	getParameterOutputNodes()
TaskGraph	getParent()
java.lang.String	getQualifiedTaskName()
TaskGraph	getUltimateParent()
void	init() Initialisation method is called immediately after the parent is set
boolean	isDataInputNode(Node node)
boolean	isDataOutputNode(Node node)
boolean	isParameterInputNode(Node node)
boolean	isParameterOutputNode(Node node)
boolean	isParameterTriggerNode(int index)
boolean	isRunContinuously()
protected void	notifyNodeAdded(Node node) Notifies all the task listeners that a node has been added.
protected void	notifyNodeRemoved(Node node) Notifies all the task listeners that a node has been removed.
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.
protected void	notifyPropertyUpdate(int property, java.lang.Object oldval, java.lang.Object newval) Notifies all the task listeners that a task property has been updated.
protected void	notifyTaskDisposed() Notifies all the task listeners that the task is about to be disposed
void	removeDataInputNode(Node node) Removes a data input node.
void	removeDataOutputNode(Node node) Removes a data output node.
void	removeNode(Node node) Removes the specified node
void	removeParameter(java.lang.String name) Removes the value associated with the specified parameter name.
void	removeParameterInputNode(ParameterNode node) Removes a parameter input node.
void	removeParameterOutputNode(ParameterNode node) Removes a parameter output node.
void	removeProxy() Removes the proxy for this tool
void	removeTaskListener(TaskListener listener) Removes a task listener from this task.
void	setContextProperty(java.lang.String name, java.lang.Object value)
void	setDataInputNodeCount(int nodeCount) Used by ToolFactory to set the number of input nodes.
void	setDataOutputNodeCount(int nodeCount) Used by ToolFactory to set the number of output nodes.
void	setDeclaredNodeProperties(java.util.List<java.lang.String> props)
void	setDefaultNodeRequirement(java.lang.String requirement) Sets the default input node requirement for this task (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)
void	setNodeRequirement(int index, java.lang.String requirement) Sets the input node requirement for the specified node index (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)
void	setParameter(java.lang.String name, java.lang.Object value) Sets the value for the specified parameter name.
void	setParameterInputs(java.lang.String[] names, boolean[] trigger) Used to set the names/number of input parameter nodes
void	setParameterOutputNames(java.lang.String[] names) Used to set the names/number of output parameter nodes
void	setParent(TaskGraph taskgraph) Sets the taskgraph that this task is located within
void	setProxy(Proxy proxy) Adds a proxy this tool
void	setRunContinuously(boolean state) Sets whether this task runs continuously.
void	setSubTitle(java.lang.String subtext)
void	setToolName(java.lang.String toolname) Sets the name associated with this Task.
void	updateProxy() Refreshes the proxy

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

TaskImp

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

Throws:

TaskException

Method Detail

init

public void init()
          throws TaskException

Initialisation method is called immediately after the parent is set

Specified by:

init in interface Task

Throws:

TaskException

setToolName

public void setToolName(java.lang.String toolname)

Sets the name associated with this Task.

Specified by:

setToolName in interface Tool

Overrides:

setToolName in class ToolImp

getQualifiedTaskName

public java.lang.String getQualifiedTaskName()

Specified by:

getQualifiedTaskName in interface Task

Returns:

the qualified name for this task (e.g. groupname1.groupname2.toolname).

getParent

public TaskGraph getParent()

Specified by:

getParent in interface Task

Returns:

the taskgraph that this task is located within

getUltimateParent

public TaskGraph getUltimateParent()

Specified by:

getUltimateParent in interface Task

setParent

public void setParent(TaskGraph taskgraph)

Sets the taskgraph that this task is located within

Specified by:

setParent in interface Task

getInstanceID

public java.lang.String getInstanceID()

All copies of a task within a parameter space (sharing the same parameters) have the same intance id.

Specified by:

getInstanceID in interface Task

Returns:

the instance id of this task

setProxy

public void setProxy(Proxy proxy)
              throws TaskException

Adds a proxy this tool

Specified by:

setProxy in interface Tool

Overrides:

setProxy in class ToolImp

Throws:

TaskException

updateProxy

public void updateProxy()

Refreshes the proxy

Specified by:

updateProxy in interface Task

removeProxy

public void removeProxy()
                 throws TaskException

Removes the proxy for this tool

Specified by:

removeProxy in interface Tool

Overrides:

removeProxy in class ToolImp

Throws:

TaskException

addTaskListener

public void addTaskListener(TaskListener listener)

Adds a task listener to this task.

Specified by:

addTaskListener in interface Task

removeTaskListener

public void removeTaskListener(TaskListener listener)

Removes a task listener from this task.

Specified by:

removeTaskListener in interface Task

setParameter

public void setParameter(java.lang.String name,
                java.lang.Object value)

Sets the value for the specified parameter name.

Specified by:

setParameter in interface Tool

Overrides:

setParameter in class ToolImp

removeParameter

public void removeParameter(java.lang.String name)

Removes the value associated with the specified parameter name.

Specified by:

removeParameter in interface Tool

Overrides:

removeParameter in class ToolImp

addDataInputNode

public Node addDataInputNode()
                      throws NodeException

Adds a data input node.

Specified by:

addDataInputNode in interface Task

Throws:

NodeException

removeDataInputNode

public void removeDataInputNode(Node node)

Removes a data input node.

Specified by:

removeDataInputNode in interface Task

getDataInputNode

public Node getDataInputNode(int index)

Specified by:

getDataInputNode in interface Task

Returns:

the data input node at the specified index

getDataInputNodes

public Node[] getDataInputNodes()

Specified by:

getDataInputNodes in interface Task

Returns:

an array of data input nodes

getDataInputNodeCount

public int getDataInputNodeCount()

Specified by:

getDataInputNodeCount in interface Tool

Overrides:

getDataInputNodeCount in class ToolImp

Returns:

the number of data input nodes

setDataInputNodeCount

public void setDataInputNodeCount(int nodeCount)
                           throws NodeException

Used by ToolFactory to set the number of input nodes.

Overrides:

setDataInputNodeCount in class ToolImp

Throws:

NodeException

addDataOutputNode

public Node addDataOutputNode()
                       throws NodeException

Adds a data output node.

Specified by:

addDataOutputNode in interface Task

Throws:

NodeException

removeDataOutputNode

public void removeDataOutputNode(Node node)

Removes a data output node.

Specified by:

removeDataOutputNode in interface Task

getDataOutputNode

public Node getDataOutputNode(int index)

Specified by:

getDataOutputNode in interface Task

Returns:

the data output node at the specified index

getDataOutputNodes

public Node[] getDataOutputNodes()

Specified by:

getDataOutputNodes in interface Task

Returns:

an array of data output nodes

getDataOutputNodeCount

public int getDataOutputNodeCount()

Specified by:

getDataOutputNodeCount in interface Tool

Overrides:

getDataOutputNodeCount in class ToolImp

Returns:

the number of data output nodes

setDataOutputNodeCount

public void setDataOutputNodeCount(int nodeCount)
                            throws NodeException

Used by ToolFactory to set the number of output nodes.

Overrides:

setDataOutputNodeCount in class ToolImp

Throws:

NodeException

addParameterInputNode

public ParameterNode addParameterInputNode(java.lang.String paramname)
                                    throws NodeException

Adds a parameter input node for the specified parameter name.

Specified by:

addParameterInputNode in interface Task

Throws:

NodeException

removeParameterInputNode

public void removeParameterInputNode(ParameterNode node)

Removes a parameter input node.

Specified by:

removeParameterInputNode in interface Task

setParameterInputs

public void setParameterInputs(java.lang.String[] names,
                      boolean[] trigger)
                        throws NodeException

Used to set the names/number of input parameter nodes

Specified by:

setParameterInputs in interface Tool

Overrides:

setParameterInputs in class ToolImp

Throws:

NodeException

getParameterInputNode

public ParameterNode getParameterInputNode(int index)

Specified by:

getParameterInputNode in interface Task

Returns:

the parameter input node at the specified index

getParameterInputName

public java.lang.String getParameterInputName(int index)

Specified by:

getParameterInputName in interface Tool

Overrides:

getParameterInputName in class ToolImp

Returns:

the parameter name input on the specified node index

isParameterTriggerNode

public boolean isParameterTriggerNode(int index)

Specified by:

isParameterTriggerNode in interface Tool

Overrides:

isParameterTriggerNode in class ToolImp

Returns:

true if the specified parameter input node is a trigger node

getParameterInputNodes

public ParameterNode[] getParameterInputNodes()

Specified by:

getParameterInputNodes in interface Task

Returns:

an array of parameter input nodes

getParameterInputNodeCount

public int getParameterInputNodeCount()

Specified by:

getParameterInputNodeCount in interface Tool

Overrides:

getParameterInputNodeCount in class ToolImp

Returns:

the number of parameter input nodes

addParameterOutputNode

public ParameterNode addParameterOutputNode(java.lang.String paramname)
                                     throws NodeException

Adds a parameter output node for the specified paramter name.

Specified by:

addParameterOutputNode in interface Task

Throws:

NodeException

removeParameterOutputNode

public void removeParameterOutputNode(ParameterNode node)

Removes a parameter output node.

Specified by:

removeParameterOutputNode in interface Task

setParameterOutputNames

public void setParameterOutputNames(java.lang.String[] names)
                             throws NodeException

Used to set the names/number of output parameter nodes

Throws:

NodeException

getParameterOutputName

public java.lang.String getParameterOutputName(int index)

Specified by:

getParameterOutputName in interface Tool

Overrides:

getParameterOutputName in class ToolImp

Returns:

the parameter name input on the specified node index

getParameterOutputNode

public ParameterNode getParameterOutputNode(int index)

Specified by:

getParameterOutputNode in interface Task

Returns:

the parameter output node at the specified index

getParameterOutputNodes

public ParameterNode[] getParameterOutputNodes()

Specified by:

getParameterOutputNodes in interface Task

Returns:

an array of parameter output nodes

getParameterOutputNodeCount

public int getParameterOutputNodeCount()

Specified by:

getParameterOutputNodeCount in interface Tool

Overrides:

getParameterOutputNodeCount in class ToolImp

Returns:

the number of parameter output nodes

getNodeIndex

public int getNodeIndex(Node node)

Returns the index of the specified node within the data input/output and parameter input/output nodes; or -1 if not attached to this task. The index returned is not unique, e.g. the first data input node and the first data output nodes will both return 0.

Specified by:

getNodeIndex in interface Task

getAbsoluteNodeIndex

public int getAbsoluteNodeIndex(Node node)

This is a convience method to provide backward compatibility with TrianaGUI, in which parameter nodes where indexed after data nodes.

The absolute index of a data node is the same as its standard index. The absolute index of a parameter node is its standard index + the total number of data input nodes.

Specified by:

getAbsoluteNodeIndex in interface Task

Returns:

the absolute index of this node within its associated task.

isDataInputNode

public boolean isDataInputNode(Node node)

Specified by:

isDataInputNode in interface Task

Returns:

true if the specified node is a data input node for this task

isDataOutputNode

public boolean isDataOutputNode(Node node)

Specified by:

isDataOutputNode in interface Task

Returns:

true if the specified node is a data output node for this task

isParameterInputNode

public boolean isParameterInputNode(Node node)

Specified by:

isParameterInputNode in interface Task

Returns:

true if the specified node is a parameter input node for this task

isParameterOutputNode

public boolean isParameterOutputNode(Node node)

Specified by:

isParameterOutputNode in interface Task

Returns:

true if the specified node is a parameter output node for this task

getInputNodes

public Node[] getInputNodes()

Specified by:

getInputNodes in interface Task

Returns:

all input nodes (data and parameter)

getInputNode

public Node getInputNode(int absoluteindex)

Specified by:

getInputNode in interface Task

Returns:

the input node at the specified absolute index (data/parameter)

getOutputNodes

public Node[] getOutputNodes()

Specified by:

getOutputNodes in interface Task

Returns:

all output nodes (data and parameter)

getOutputNode

public Node getOutputNode(int absoluteindex)

Specified by:

getOutputNode in interface Task

Returns:

the output node at the specified absolute index (data/parameter)

removeNode

public void removeNode(Node node)

Removes the specified node

Specified by:

removeNode in interface Task

isRunContinuously

public boolean isRunContinuously()

Specified by:

isRunContinuously in interface Task

Returns:

true if this task is set to run continuously

setRunContinuously

public void setRunContinuously(boolean state)

Sets whether this task runs continuously.

Specified by:

setRunContinuously in interface Task

setDefaultNodeRequirement

public void setDefaultNodeRequirement(java.lang.String requirement)

Sets the default input node requirement for this task (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)

Specified by:

setDefaultNodeRequirement in interface Task

getDefaultNodeRequirement

public java.lang.String getDefaultNodeRequirement()

Specified by:

getDefaultNodeRequirement in interface Task

Returns:

the default requirement for this task's input nodes

setNodeRequirement

public void setNodeRequirement(int index,
                      java.lang.String requirement)

Sets the input node requirement for the specified node index (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)

Specified by:

setNodeRequirement in interface Task

getNodeRequirement

public java.lang.String getNodeRequirement(int index)

Specified by:

getNodeRequirement in interface Task

Returns:

the requirement for this specified input node index.

getExecutionRequestCount

public int getExecutionRequestCount()

Specified by:

getExecutionRequestCount in interface Task

Returns:

the number of times the task has been requested to execut

getExecutionCount

public int getExecutionCount()

Specified by:

getExecutionCount in interface Task

Returns:

the number of times the task has been executed

getExecutionState

public ExecutionState getExecutionState()

Specified by:

getExecutionState in interface Task

Returns:

the current execution state of the task

getErrorMessage

public java.lang.String getErrorMessage()

Specified by:

getErrorMessage in interface Task

Returns:

the error message associated with the current error (null if the task is not in an error state)

notifyPropertyUpdate

protected void notifyPropertyUpdate(int property,
                        java.lang.Object oldval,
                        java.lang.Object newval)

Notifies all the task listeners that a task property has been updated.

notifyNodeAdded

protected void notifyNodeAdded(Node node)

Notifies all the task listeners that a node has been added.

notifyNodeRemoved

protected void notifyNodeRemoved(Node node)

Notifies all the task listeners that a node has been removed.

notifyParameterSet

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.

notifyTaskDisposed

protected void notifyTaskDisposed()

Notifies all the task listeners that the task is about to be disposed

dispose

public void dispose()

cleans up any operations associated with this task

Specified by:

dispose in interface Task

getContext

public TaskGraphContext getContext()

Specified by:

getContext in interface Task

getContextProperty

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

Specified by:

getContextProperty in interface Task

setContextProperty

public void setContextProperty(java.lang.String name,
                      java.lang.Object value)

Specified by:

setContextProperty in interface Task

setDeclaredNodeProperties

public void setDeclaredNodeProperties(java.util.List<java.lang.String> props)

Specified by:

setDeclaredNodeProperties in interface Task

addDeclaredNodeProperty

public void addDeclaredNodeProperty(java.lang.String prop)

Specified by:

addDeclaredNodeProperty in interface Task

getDeclaredNodeProperties

public java.util.List<java.lang.String> getDeclaredNodeProperties()

Specified by:

getDeclaredNodeProperties in interface Task

setSubTitle

public void setSubTitle(java.lang.String subtext)

Specified by:

setSubTitle in interface Tool

Overrides:

setSubTitle in class ToolImp