org.trianacode.taskgraph

Interface TaskGraph

All Superinterfaces:

ExecutionListener, Task, Tool

All Known Implementing Classes:

TaskGraphImp

public interface TaskGraph
extends Task, ExecutionListener

An interface to TaskGraphs

Nested Class Summary

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

Task.ConnectionStatus

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTROL_TASK_CONNECTED
static int	CONTROL_TASK_DISCONNECTED
static int	CONTROL_TASK_UNSTABLE

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

Method Summary

Methods

Modifier and Type	Method and Description
Node	addDataInputNode(Node parent) Adds a data input node, with the specified node as a parent
Node	addDataOutputNode(Node parent) Adds a data output node, with the specified node as a parent
void	addExecutionListener(ExecutionListener listener) Adds a execution listener to this runnable instance
void	addTaskGraphListener(TaskGraphListener listener) Adds a taskgraph listener to this taskgraph.
Cable	connect(Node sendnode, Node recnode) Create a cable connecting sendnode to recnode
boolean	containsNode(Node node)
boolean	containsTask(java.lang.String identifier)
boolean	containsTask(Task task)
boolean	containsTaskInstance(java.lang.String instanceid)
Task	createControlTask(Tool tool, boolean preserveinst) Constructs a new task for looping over the group, optionally preserving the original instance id in the new task.
Task	createTask(Tool tool) Create a new task in this taskgraph.
Task	createTask(Tool tool, boolean preserveinst) Create a new task in this taskgraph, optionally preserving the instance id from the original task in the new task.
void	disconnect(Cable cable) Disconnects the specified cable from its nodes.
void	dispose() cleans up any operations associated with this taskgraph and the tasks within it
Task	getControlTask()
int	getControlTaskState()
Node	getGroupNodeParent(Node groupnode)
Task	getTask(Node node)
Task	getTask(java.lang.String name)
Task	getTaskInstance(java.lang.String instanceid)
Task[]	getTasks(boolean includecontrol)
TaskGraph	groupTasks(java.lang.String[] tasknames, java.lang.String groupname) Groups the specified tasks, returning the taskgraph created.
boolean	isControlTask()
boolean	isControlTaskConnected()
boolean	isControlTaskUnstable()
void	removeControlTask() Removes the loop task from the group
void	removeExecutionListener(ExecutionListener listener) Removes a execution listener from this runnable instance
void	removeTask(Task task) Remove the specified task from the taskgraph.
void	removeTaskGraphListener(TaskGraphListener listener) Removes a taskgraph listener from this taskgraph.
void	setControlTaskState(int state) Sets the state of the control task (CONTROL_TASK_CONNECTED, CONTROL_TASK_DISCONNECTED or CONTROL_TASK_UNSTABLE)
void	setGroupNodeParent(Node groupnode, Node parent) Sets the parent of a group input/output node
void	swapGroupNodeParents(Node groupnode1, Node groupnode2) Swaps the parents of two group nodes (without disconnecting either).
void	ungroup() removes tasks and notifies listeners when the taskgraph is ungrouped, but does not dispose of the tasks
void	unGroupTask(java.lang.String groupname) Ungroups the specified group task

Methods inherited from interface org.trianacode.taskgraph.Task

addDataInputNode, addDataOutputNode, addDeclaredNodeProperty, addParameterInputNode, addParameterOutputNode, addTaskListener, getAbsoluteNodeIndex, getContext, getContextProperty, getDataInputNode, getDataInputNodes, getDataOutputNode, getDataOutputNodes, getDeclaredNodeProperties, getDefaultNodeRequirement, getErrorMessage, getExecutionCount, getExecutionRequestCount, getExecutionState, getInputNode, getInputNodes, getInstanceID, getNodeIndex, getNodeRequirement, getOutputNode, getOutputNodes, getParameterInputNode, getParameterInputNodes, getParameterOutputNode, getParameterOutputNodes, getParent, getQualifiedTaskName, getUltimateParent, init, isDataInputNode, isDataOutputNode, isParameterInputNode, isParameterOutputNode, isRunContinuously, removeDataInputNode, removeDataOutputNode, removeNode, removeParameterInputNode, removeParameterOutputNode, removeTaskListener, setContextProperty, setDeclaredNodeProperties, setDefaultNodeRequirement, setNodeRequirement, setParent, setRunContinuously, updateProxy

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

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

executionFinished, executionRequested, executionReset, executionStarting, executionStateChanged

Field Detail

CONTROL_TASK_CONNECTED

static final int CONTROL_TASK_CONNECTED

See Also:

Constant Field Values

CONTROL_TASK_DISCONNECTED

static final int CONTROL_TASK_DISCONNECTED

See Also:

Constant Field Values

CONTROL_TASK_UNSTABLE

static final int CONTROL_TASK_UNSTABLE

See Also:

Constant Field Values

Method Detail

addExecutionListener

void addExecutionListener(ExecutionListener listener)

Adds a execution listener to this runnable instance

removeExecutionListener

void removeExecutionListener(ExecutionListener listener)

Removes a execution listener from this runnable instance

createControlTask

Task createControlTask(Tool tool,
                     boolean preserveinst)
                       throws TaskException

Constructs a new task for looping over the group, optionally preserving the original instance id in the new task. This method does not connect the control task, which should be done using TaskGraphUtils.connectControlTask()

Throws:

TaskException

removeControlTask

void removeControlTask()

Removes the loop task from the group

getControlTask

Task getControlTask()

Returns:

the task responsible for looping over the group

isControlTask

boolean isControlTask()

Returns:

true if a loop task exists for this group

isControlTaskConnected

boolean isControlTaskConnected()

Returns:

true if the control task is connected

isControlTaskUnstable

boolean isControlTaskUnstable()

Returns:

true if the control task is unstable

getControlTaskState

int getControlTaskState()

Returns:

the state of the control task (CONTROL_TASK_CONNECTED, CONTROL_TASK_DISCONNECTED or CONTROL_TASK_UNSTABLE)

setControlTaskState

void setControlTaskState(int state)

Sets the state of the control task (CONTROL_TASK_CONNECTED, CONTROL_TASK_DISCONNECTED or CONTROL_TASK_UNSTABLE)

addTaskGraphListener

void addTaskGraphListener(TaskGraphListener listener)

Adds a taskgraph listener to this taskgraph.

removeTaskGraphListener

void removeTaskGraphListener(TaskGraphListener listener)

Removes a taskgraph listener from this taskgraph.

createTask

Task createTask(Tool tool)
                throws TaskException

Create a new task in this taskgraph.

Returns:

an interface to the new task

Throws:

TaskException

createTask

Task createTask(Tool tool,
              boolean preserveinst)
                throws TaskException

Create a new task in this taskgraph, optionally preserving the instance id from the original task in the new task.

Returns:

an interface to the new task

Throws:

TaskException

removeTask

void removeTask(Task task)

Remove the specified task from the taskgraph.

getTasks

Task[] getTasks(boolean includecontrol)

Returns:

an array of all the tasks contained with this taskgraph, optionally including the control task

getTask

Task getTask(java.lang.String name)

Returns:

the task with the specified name

getTaskInstance

Task getTaskInstance(java.lang.String instanceid)

Returns:

the task with the specified instance id

getTask

Task getTask(Node node)

Returns:

the task within this taskgraph linked to the specified node

containsTask

boolean containsTask(java.lang.String identifier)

Returns:

true if the taskgraph contains the specified task

containsTaskInstance

boolean containsTaskInstance(java.lang.String instanceid)

Returns:

true if the taskgraph contains the specified task instance

containsTask

boolean containsTask(Task task)

Returns:

true if the taskgraph contains the specified task

containsNode

boolean containsNode(Node node)

Returns:

true if a task represented within this taskgraph is linked to the specified node

groupTasks

TaskGraph groupTasks(java.lang.String[] tasknames,
                   java.lang.String groupname)
                     throws TaskGraphException

Groups the specified tasks, returning the taskgraph created. A default mapping between group nodes and task nodes is created. This can be changed later through setDataInputNode etc. in TaskGraph.

Throws:

TaskGraphException

unGroupTask

void unGroupTask(java.lang.String groupname)
                 throws TaskGraphException

Ungroups the specified group task

Throws:

TaskGraphException

connect

Cable connect(Node sendnode,
            Node recnode)
              throws CableException

Create a cable connecting sendnode to recnode

Throws:

CableException

disconnect

void disconnect(Cable cable)
                throws CableException

Disconnects the specified cable from its nodes.

Throws:

CableException

addDataInputNode

Node addDataInputNode(Node parent)
                      throws NodeException

Adds a data input node, with the specified node as a parent

Throws:

NodeException

addDataOutputNode

Node addDataOutputNode(Node parent)
                       throws NodeException

Adds a data output node, with the specified node as a parent

Throws:

NodeException

setGroupNodeParent

void setGroupNodeParent(Node groupnode,
                      Node parent)

Sets the parent of a group input/output node

getGroupNodeParent

Node getGroupNodeParent(Node groupnode)

Returns:

the parent of a group input/output node

swapGroupNodeParents

void swapGroupNodeParents(Node groupnode1,
                        Node groupnode2)

Swaps the parents of two group nodes (without disconnecting either). Useful for reordering input/output nodes.

ungroup

void ungroup()

removes tasks and notifies listeners when the taskgraph is ungrouped, but does not dispose of the tasks

dispose

void dispose()

cleans up any operations associated with this taskgraph and the tasks within it

Specified by:

dispose in interface Task