org.trianacode.taskgraph

Interface Task

All Superinterfaces:

Tool

All Known Subinterfaces:

TaskGraph

All Known Implementing Classes:

AbstractRunnableTask, AbstractServiceTask, NonRunnableTask, PoisonTask, RunnableTask, TaskGraphImp, TaskImp

public interface Task
extends Tool

The interface to tasks within a taskgraph

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Task.ConnectionStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NODE_REQUIREMENT
static java.lang.String	DEPRECATED_GUI_XPOS
static java.lang.String	DEPRECATED_GUI_YPOS
static java.lang.String	ERROR_MESSAGE
static java.lang.String	ESSENTIAL
static java.lang.String	ESSENTIAL_IF_CONNECTED
static java.lang.String	EXECUTION_COUNT
static java.lang.String	EXECUTION_REQUEST_COUNT
static java.lang.String	EXECUTION_STATE
static java.lang.String	GUI_X GUI Position in the Triana co-ordinate space - relative to size of a task component
static java.lang.String	GUI_Y
static java.lang.String	NODE_PROPERTIES
static java.lang.String	NODE_REQUIREMENT
static java.lang.String	OPTIONAL
static java.lang.String	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

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)
Node[]	getDataInputNodes()
Node	getDataOutputNode(int index)
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()
ParameterNode	getParameterInputNode(int index)
ParameterNode[]	getParameterInputNodes()
ParameterNode	getParameterOutputNode(int index)
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	isRunContinuously()
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	removeParameterInputNode(ParameterNode node) Removes a parameter input node.
void	removeParameterOutputNode(ParameterNode node) Removes a parameter output node.
void	removeTaskListener(TaskListener listener) Removes a task listener from this task.
void	setContextProperty(java.lang.String name, java.lang.Object value)
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 node requirement for the specified input node index (ESSENTIAL, ESSENTIAL_IF_CONNECTED or OPTIONAL)
void	setParent(TaskGraph taskgraph) Sets the parent for this task
void	setRunContinuously(boolean state) Sets whether this task runs continuously.
void	updateProxy() Notifies task listeners that the proxy has been updated

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

addExtension, addRenderingHint, getDataInputNodeCount, getDataInputTypes, getDataInputTypes, getDataOutputNodeCount, getDataOutputTypes, getDataOutputTypes, getDefaultDataInputNodes, getDefaultDataOutputNodes, getDefinitionPath, getDefinitionType, getDisplayName, getDisplayPackage, getExtension, getExtensionNames, getHelpFile, getInputNodeCount, getMaxDataInputNodes, getMaxDataOutputNodes, getMinDataInputNodes, getMinDataOutputNodes, getOutputNodeCount, getParameter, getParameterInputName, getParameterInputNodeCount, getParameterNames, getParameterOutputName, getParameterOutputNodeCount, getParameterType, getPopUpDescription, getProperties, getProxy, getQualifiedToolName, getRenderingHint, getRenderingHints, getSubTitle, getToolBox, getToolName, getToolPackage, getVersion, isExtensionName, isParameterName, isParameterTriggerNode, isRenderingHint, removeExtension, removeParameter, removeProxy, removeRenderingHint, setDataInputTypes, setDataOutputTypes, setDefinitionPath, setDefinitionType, setHelpFile, setParameter, setParameterInputs, setParameterOutputs, setParameterType, setPopUpDescription, setProperties, setProxy, setSubTitle, setToolBox, setToolName, setToolPackage, setVersion

Field Detail

GUI_X

static final java.lang.String GUI_X

GUI Position in the Triana co-ordinate space - relative to size of a task component

See Also:

Constant Field Values

GUI_Y

static final java.lang.String GUI_Y

See Also:

Constant Field Values

DEPRECATED_GUI_XPOS

static final java.lang.String DEPRECATED_GUI_XPOS

See Also:

Constant Field Values

DEPRECATED_GUI_YPOS

static final java.lang.String DEPRECATED_GUI_YPOS

See Also:

Constant Field Values

NODE_PROPERTIES

static final java.lang.String NODE_PROPERTIES

See Also:

Constant Field Values

EXECUTION_REQUEST_COUNT

static final java.lang.String EXECUTION_REQUEST_COUNT

See Also:

Constant Field Values

EXECUTION_COUNT

static final java.lang.String EXECUTION_COUNT

See Also:

Constant Field Values

EXECUTION_STATE

static final java.lang.String EXECUTION_STATE

See Also:

Constant Field Values

ERROR_MESSAGE

static final java.lang.String ERROR_MESSAGE

See Also:

Constant Field Values

OUTPUT_TYPE

static final java.lang.String OUTPUT_TYPE

See Also:

Constant Field Values

DEFAULT_NODE_REQUIREMENT

static final java.lang.String DEFAULT_NODE_REQUIREMENT

See Also:

Constant Field Values

NODE_REQUIREMENT

static final java.lang.String NODE_REQUIREMENT

See Also:

Constant Field Values

ESSENTIAL

static final java.lang.String ESSENTIAL

See Also:

Constant Field Values

ESSENTIAL_IF_CONNECTED

static final java.lang.String ESSENTIAL_IF_CONNECTED

See Also:

Constant Field Values

OPTIONAL

static final java.lang.String OPTIONAL

See Also:

Constant Field Values

Method Detail

getQualifiedTaskName

java.lang.String getQualifiedTaskName()

Returns:

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

updateProxy

void updateProxy()

Notifies task listeners that the proxy has been updated

getParent

TaskGraph getParent()

Returns:

the taskgraph that this task is located within

getUltimateParent

TaskGraph getUltimateParent()

getInstanceID

java.lang.String getInstanceID()

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

Returns:

the instance id of this task

addTaskListener

void addTaskListener(TaskListener listener)

Adds a task listener to this task.

removeTaskListener

void removeTaskListener(TaskListener listener)

Removes a task listener from this task.

addDataInputNode

Node addDataInputNode()
                      throws NodeException

Adds a data input node.

Throws:

NodeException

removeDataInputNode

void removeDataInputNode(Node node)

Removes a data input node.

getDataInputNode

Node getDataInputNode(int index)

Returns:

the data input node at the specified index

getDataInputNodes

Node[] getDataInputNodes()

Returns:

an array of data input nodes

addDataOutputNode

Node addDataOutputNode()
                       throws NodeException

Adds a data output node.

Throws:

NodeException

removeDataOutputNode

void removeDataOutputNode(Node node)

Removes a data output node.

getDataOutputNode

Node getDataOutputNode(int index)

Returns:

the data output node at the specified index

getDataOutputNodes

Node[] getDataOutputNodes()

Returns:

an array of data output nodes

addParameterInputNode

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

Adds a parameter input node for the specified parameter name.

Throws:

NodeException

removeParameterInputNode

void removeParameterInputNode(ParameterNode node)

Removes a parameter input node.

getParameterInputNode

ParameterNode getParameterInputNode(int index)

Returns:

the parameter input node at the specified index

getParameterInputNodes

ParameterNode[] getParameterInputNodes()

Returns:

an array of parameter input nodes

addParameterOutputNode

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

Adds a parameter output node for the specified paramter name.

Throws:

NodeException

removeParameterOutputNode

void removeParameterOutputNode(ParameterNode node)

Removes a parameter output node.

getParameterOutputNode

ParameterNode getParameterOutputNode(int index)

Returns:

the parameter output node at the specified index

getParameterOutputNodes

ParameterNode[] getParameterOutputNodes()

Returns:

an array of parameter output nodes

getInputNodes

Node[] getInputNodes()

Returns:

all input nodes (data and parameter)

getInputNode

Node getInputNode(int absoluteindex)

Returns:

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

getOutputNodes

Node[] getOutputNodes()

Returns:

all output nodes (data and parameter)

getOutputNode

Node getOutputNode(int absoluteindex)

Returns:

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

removeNode

void removeNode(Node node)

Removes the specified node

isRunContinuously

boolean isRunContinuously()

Returns:

true if this task is set to run continuously

setRunContinuously

void setRunContinuously(boolean state)

Sets whether this task runs continuously.

setDefaultNodeRequirement

void setDefaultNodeRequirement(java.lang.String requirement)

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

getDefaultNodeRequirement

java.lang.String getDefaultNodeRequirement()

Returns:

the default requirement for this task's input nodes

setNodeRequirement

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

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

getNodeRequirement

java.lang.String getNodeRequirement(int index)

Returns:

the requirement for this specified input node index.

getExecutionRequestCount

int getExecutionRequestCount()

Returns:

the number of times the task has been requested to execut

getExecutionCount

int getExecutionCount()

Returns:

the number of times the task has been executed

getExecutionState

ExecutionState getExecutionState()

Returns:

the current execution state of the task

getErrorMessage

java.lang.String getErrorMessage()

Returns:

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

init

void init()
          throws TaskException

Initialisation method is called immediately after the parent is set

Throws:

TaskException

setParent

void setParent(TaskGraph taskgraph)

Sets the parent for this task

getNodeIndex

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.

getAbsoluteNodeIndex

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.

Returns:

the absolute index of this node within its associated task.

isDataInputNode

boolean isDataInputNode(Node node)

Returns:

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

isDataOutputNode

boolean isDataOutputNode(Node node)

Returns:

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

isParameterInputNode

boolean isParameterInputNode(Node node)

Returns:

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

isParameterOutputNode

boolean isParameterOutputNode(Node node)

Returns:

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

dispose

void dispose()

Cleans up any operations associated with this task

getContext

TaskGraphContext getContext()

getContextProperty

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

setContextProperty

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

setDeclaredNodeProperties

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

addDeclaredNodeProperty

void addDeclaredNodeProperty(java.lang.String prop)

getDeclaredNodeProperties

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