org.trianacode.taskgraph.service

Class AbstractServiceTask

java.lang.Object

org.trianacode.taskgraph.imp.ToolImp

org.trianacode.taskgraph.imp.TaskImp

org.trianacode.taskgraph.service.AbstractRunnableTask

org.trianacode.taskgraph.service.AbstractServiceTask

All Implemented Interfaces:

RunnableInstance, Task, Tool

public abstract class AbstractServiceTask
extends AbstractRunnableTask

An abstract service task is responsible for handling the wake-ups and output from a task. Sub classes for this class are only responsible for implementing the invoke and flush methods.

Nested Class Summary

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

Task.ConnectionStatus

Field Summary

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

Constructor and Description
AbstractServiceTask(boolean multival, Tool tool, TaskFactory factory, boolean preserveinst) Constructs an abstract service task for the specified tool.
AbstractServiceTask(Tool tool, TaskFactory factory, boolean preserveinst) Constructs an abstract service task for the specified tool.

Method Summary

Methods

Modifier and Type	Method and Description
void	finished() Tell the data monitor that this thread monitor has completed outputting the data i.e.
protected abstract void	flush() This method flushes the currently invoking services.
int	getMaxConcurrentInvocations()
void	init() Initialises the web service runnable task
protected abstract java.lang.Object[]	invoke(java.lang.Object[] input, ClipInBucket bucket) This method invokes the service with the specified input data.
protected abstract boolean	isInputEssential()
boolean	isMultiValuedOutput()
protected void	postSend() Method called after data is sent, should be over-ridden with post send fucntionality.
protected void	preReceive() Method called before data is received, should be over-ridden with pre receive fucntionality
void	reset() Order a runnable instance to stop and reset it to its pre-run state
protected void	setMaxConcurrentInvocations(int maxconcurrent) Sets the maximum concurrent invocations for this service
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.service.AbstractRunnableTask

addExecutionListener, dispose, 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, 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, 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

AbstractServiceTask

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

Constructs an abstract service task for the specified tool. Optionally returns multi-valued results (default is one result copied to all nodes)

Parameters:

multival - true if return multi-valued results

Throws:

TaskException

AbstractServiceTask

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

Constructs an abstract service task for the specified tool.

Throws:

TaskException

Method Detail

init

public void init()

Initialises the web service runnable task

Specified by:

init in interface Task

Overrides:

init in class TaskImp

isInputEssential

protected abstract boolean isInputEssential()

Returns:

true if input is required at every data input node, false if input only required at connected input nodes.

invoke

protected abstract java.lang.Object[] invoke(java.lang.Object[] input,
                        ClipInBucket bucket)
                                      throws java.lang.Exception

This method invokes the service with the specified input data. The return from this method is the output data from the task.

Parameters:

input - an array of the input data (indexed by node)

bucket - clip-ins for this invoke

Returns:

an array of the output data (indexed by node)

Throws:

java.lang.Exception

preReceive

protected void preReceive()

Method called before data is received, should be over-ridden with pre receive fucntionality

postSend

protected void postSend()

Method called after data is sent, should be over-ridden with post send fucntionality.

flush

protected abstract void flush()

This method flushes the currently invoking services.

getMaxConcurrentInvocations

public int getMaxConcurrentInvocations()

Returns:

the maximum concurrent invocations for this service

setMaxConcurrentInvocations

protected void setMaxConcurrentInvocations(int maxconcurrent)

Sets the maximum concurrent invocations for this service

isMultiValuedOutput

public boolean isMultiValuedOutput()

Returns:

true if multi-value output are expected. If multi-value outputs are expected then each output value will be put on a seperate node, if not then the single value will be copied to every output node.

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

Specified by:

wakeUp in class AbstractRunnableTask

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

Specified by:

wakeUp in class AbstractRunnableTask

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

Specified by:

finished in class AbstractRunnableTask

reset

public void reset()

Order a runnable instance to stop and reset it to its pre-run state

Specified by:

reset in interface RunnableInstance

Overrides:

reset in class AbstractRunnableTask