org.trianacode.taskgraph.interceptor.execution

Class PoisonTask

java.lang.Object

org.trianacode.taskgraph.interceptor.execution.PoisonTask

All Implemented Interfaces:

Task, Tool

public class PoisonTask
extends java.lang.Object
implements Task

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
PoisonTask()
PoisonTask(TrianaProperties properties)

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)
void	addExtension(java.lang.String name, java.lang.String extension) Adds an extension
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	addRenderingHint(RenderingHint hints) Adds a rendering hint
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()
java.lang.String[]	getDataInputTypes()
java.lang.String[]	getDataInputTypes(int node)
Node	getDataOutputNode(int index)
int	getDataOutputNodeCount()
Node[]	getDataOutputNodes()
java.lang.String[]	getDataOutputTypes()
java.lang.String[]	getDataOutputTypes(int node)
java.util.List<java.lang.String>	getDeclaredNodeProperties()
int	getDefaultDataInputNodes()
int	getDefaultDataOutputNodes()
java.lang.String	getDefaultNodeRequirement()
java.net.URL	getDefinitionPath()
java.lang.String	getDefinitionType()
java.lang.String	getDisplayName()
java.lang.String	getDisplayPackage()
java.lang.String	getErrorMessage()
int	getExecutionCount()
int	getExecutionRequestCount()
ExecutionState	getExecutionState()
java.lang.String	getExtension(java.lang.String name)
java.lang.String[]	getExtensionNames()
java.lang.String	getHelpFile()
Node	getInputNode(int absoluteindex)
int	getInputNodeCount()
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	getMaxDataInputNodes()
int	getMaxDataOutputNodes()
int	getMinDataInputNodes()
int	getMinDataOutputNodes()
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)
int	getOutputNodeCount()
Node[]	getOutputNodes()
java.lang.Object	getParameter(java.lang.String name)
java.lang.String	getParameterInputName(int index)
ParameterNode	getParameterInputNode(int index)
int	getParameterInputNodeCount()
ParameterNode[]	getParameterInputNodes()
java.lang.String[]	getParameterNames()
java.lang.String	getParameterOutputName(int index)
ParameterNode	getParameterOutputNode(int index)
int	getParameterOutputNodeCount()
ParameterNode[]	getParameterOutputNodes()
java.lang.String	getParameterType(java.lang.String name)
TaskGraph	getParent()
java.lang.String	getPopUpDescription()
TrianaProperties	getProperties() Not sure what this does - how is this created etc ?
Proxy	getProxy()
java.lang.String	getQualifiedTaskName()
java.lang.String	getQualifiedToolName()
RenderingHint	getRenderingHint(java.lang.String hint)
RenderingHint[]	getRenderingHints()
java.lang.String	getSubTitle()
Toolbox	getToolBox()
java.lang.String	getToolName()
java.lang.String	getToolPackage()
TaskGraph	getUltimateParent()
java.lang.String	getVersion()
void	init() Initialisation method is called immediately after the parent is set
boolean	isDataInputNode(Node node)
boolean	isDataOutputNode(Node node)
boolean	isExtensionName(java.lang.String name)
boolean	isParameterInputNode(Node node)
boolean	isParameterName(java.lang.String name)
boolean	isParameterOutputNode(Node node)
boolean	isParameterTriggerNode(int index)
boolean	isRenderingHint(java.lang.String hint)
boolean	isRunContinuously()
void	removeDataInputNode(Node node) Removes a data input node.
void	removeDataOutputNode(Node node) Removes a data output node.
void	removeExtension(java.lang.String name) Removes an extension
void	removeNode(Node node) Removes the specified node
void	removeParameter(java.lang.String name) Removes the value associated with the specified 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	removeRenderingHint(java.lang.String hint) Removes a rendering hint
void	removeTaskListener(TaskListener listener) Removes a task listener from this task.
void	setContextProperty(java.lang.String name, java.lang.Object value)
void	setDataInputTypes(java.lang.String[] types) Used to set the input types
void	setDataOutputTypes(java.lang.String[] types) Used to set the output types.
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	setDefinitionPath(java.net.URL filepath) Used by ToolTable to set the location of the file this tool was loaded from
void	setDefinitionType(java.lang.String type) used when creating clones that are not based on the same definition file type
void	setHelpFile(java.lang.String url) Used to set the help file url.
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	setParameter(java.lang.String name, java.lang.Object value) Used to set the parameters.
void	setParameterInputs(java.lang.String[] names, boolean[] trigger) Used to set the names/number of input parameter nodes, and whether they are trigger nodes.
void	setParameterOutputs(java.lang.String[] names) Used to set the names/number of output parameter nodes
void	setParameterType(java.lang.String name, java.lang.String type) Used to set the parameter types.
void	setParent(TaskGraph taskgraph) Sets the parent for this task
void	setPopUpDescription(java.lang.String name) Used to set the pop up description.
void	setProperties(TrianaProperties properties)
void	setProxy(Proxy proxy) Sets the proxy for this tool
void	setRunContinuously(boolean state) Sets whether this task runs continuously.
void	setSubTitle(java.lang.String title)
void	setToolBox(Toolbox toolboxpath) Used by ToolTable to set the location of the toolbox this tool was loaded from
void	setToolName(java.lang.String toolName) Used to set the tool name of this ToolImp.
void	setToolPackage(java.lang.String pakageName) Set the package name for this tool.
void	setVersion(java.lang.String version) ================from Tool======================
void	updateProxy() Notifies task listeners that the proxy has been updated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PoisonTask

public PoisonTask(TrianaProperties properties)

PoisonTask

public PoisonTask()

Method Detail

getProperties

public TrianaProperties getProperties()

Not sure what this does - how is this created etc ?

Specified by:

getProperties in interface Tool

Returns:

setProperties

public void setProperties(TrianaProperties properties)

Specified by:

setProperties in interface Tool

getQualifiedTaskName

public java.lang.String getQualifiedTaskName()

Specified by:

getQualifiedTaskName in interface Task

Returns:

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

updateProxy

public void updateProxy()

Description copied from interface: Task

Notifies task listeners that the proxy has been updated

Specified by:

updateProxy in interface Task

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

getInstanceID

public java.lang.String getInstanceID()

Description copied from interface: Task

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

addTaskListener

public void addTaskListener(TaskListener listener)

Description copied from interface: Task

Adds a task listener to this task.

Specified by:

addTaskListener in interface Task

removeTaskListener

public void removeTaskListener(TaskListener listener)

Description copied from interface: Task

Removes a task listener from this task.

Specified by:

removeTaskListener in interface Task

addDataInputNode

public Node addDataInputNode()
                      throws NodeException

Description copied from interface: Task

Adds a data input node.

Specified by:

addDataInputNode in interface Task

Throws:

NodeException

removeDataInputNode

public void removeDataInputNode(Node node)

Description copied from interface: Task

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

addDataOutputNode

public Node addDataOutputNode()
                       throws NodeException

Description copied from interface: Task

Adds a data output node.

Specified by:

addDataOutputNode in interface Task

Throws:

NodeException

removeDataOutputNode

public void removeDataOutputNode(Node node)

Description copied from interface: Task

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

addParameterInputNode

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

Description copied from interface: Task

Adds a parameter input node for the specified parameter name.

Specified by:

addParameterInputNode in interface Task

Throws:

NodeException

removeParameterInputNode

public void removeParameterInputNode(ParameterNode node)

Description copied from interface: Task

Removes a parameter input node.

Specified by:

removeParameterInputNode in interface Task

getParameterInputNode

public ParameterNode getParameterInputNode(int index)

Specified by:

getParameterInputNode in interface Task

Returns:

the parameter input node at the specified index

getParameterInputNodes

public ParameterNode[] getParameterInputNodes()

Specified by:

getParameterInputNodes in interface Task

Returns:

an array of parameter input nodes

addParameterOutputNode

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

Description copied from interface: Task

Adds a parameter output node for the specified paramter name.

Specified by:

addParameterOutputNode in interface Task

Throws:

NodeException

removeParameterOutputNode

public void removeParameterOutputNode(ParameterNode node)

Description copied from interface: Task

Removes a parameter output node.

Specified by:

removeParameterOutputNode in interface Task

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

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)

Description copied from interface: Task

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)

Description copied from interface: Task

Sets whether this task runs continuously.

Specified by:

setRunContinuously in interface Task

setDefaultNodeRequirement

public void setDefaultNodeRequirement(java.lang.String requirement)

Description copied from interface: Task

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)

Description copied from interface: Task

Sets the node requirement for the specified input 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)

init

public void init()
          throws TaskException

Description copied from interface: Task

Initialisation method is called immediately after the parent is set

Specified by:

init in interface Task

Throws:

TaskException

setParent

public void setParent(TaskGraph taskgraph)

Description copied from interface: Task

Sets the parent for this task

Specified by:

setParent in interface Task

getNodeIndex

public int getNodeIndex(Node node)

Description copied from interface: Task

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)

Description copied from interface: Task

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

dispose

public void dispose()

Description copied from interface: Task

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

getSubTitle

public java.lang.String getSubTitle()

Specified by:

getSubTitle in interface Tool

setSubTitle

public void setSubTitle(java.lang.String title)

Specified by:

setSubTitle in interface Tool

getVersion

public java.lang.String getVersion()

Specified by:

getVersion in interface Tool

getToolName

public java.lang.String getToolName()

Specified by:

getToolName in interface Tool

Returns:

the name of this tool.

getDisplayName

public java.lang.String getDisplayName()

Specified by:

getDisplayName in interface Tool

getDisplayPackage

public java.lang.String getDisplayPackage()

Specified by:

getDisplayPackage in interface Tool

getDefinitionType

public java.lang.String getDefinitionType()

Specified by:

getDefinitionType in interface Tool

getToolPackage

public java.lang.String getToolPackage()

Specified by:

getToolPackage in interface Tool

Returns:

a Java style package name for this tool in the form [package].[package]. i.e. Common.Input

getQualifiedToolName

public java.lang.String getQualifiedToolName()

Specified by:

getQualifiedToolName in interface Tool

Returns:

the full-qualified (Java style) name of the tool, i.e. toolpackage.toolname

getDefinitionPath

public java.net.URL getDefinitionPath()

Specified by:

getDefinitionPath in interface Tool

Returns:

the location directory that held the definition file this tool was generated from. This could be XML or a Java .class file. Other things might be supported in the future.

getToolBox

public Toolbox getToolBox()

Specified by:

getToolBox in interface Tool

Returns:

the path to the toolbox that this tool has been loaded from.

getProxy

public Proxy getProxy()

Specified by:

getProxy in interface Tool

Returns:

the proxies represented by this tool

getRenderingHints

public RenderingHint[] getRenderingHints()

Specified by:

getRenderingHints in interface Tool

Returns:

the rendering hints for this tool

getRenderingHint

public RenderingHint getRenderingHint(java.lang.String hint)

Specified by:

getRenderingHint in interface Tool

Returns:

the rendering hints for the specified hint

isRenderingHint

public boolean isRenderingHint(java.lang.String hint)

Specified by:

isRenderingHint in interface Tool

Returns:

true if rendering hints exist for the specified hint

getParameter

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

Specified by:

getParameter in interface Tool

Returns:

the value associated with the specified name

getParameterType

public java.lang.String getParameterType(java.lang.String name)

Specified by:

getParameterType in interface Tool

Returns:

the type of the specified parameter

getParameterNames

public java.lang.String[] getParameterNames()

Specified by:

getParameterNames in interface Tool

Returns:

the names of the parameters for this tool

isParameterName

public boolean isParameterName(java.lang.String name)

Specified by:

isParameterName in interface Tool

Returns:

true if there is a value associated with the specified parameter name

getPopUpDescription

public java.lang.String getPopUpDescription()

Specified by:

getPopUpDescription in interface Tool

Returns:

a brief description of what this tool does

getHelpFile

public java.lang.String getHelpFile()

Specified by:

getHelpFile in interface Tool

Returns:

the location of the help file.

getDataInputTypes

public java.lang.String[] getDataInputTypes()

Specified by:

getDataInputTypes in interface Tool

Returns:

an array of general input types for nodes not covered by getDataInputTypes(int node)

getDataInputTypes

public java.lang.String[] getDataInputTypes(int node)

Specified by:

getDataInputTypes in interface Tool

Returns:

the data types accepted on the specified node index (if null is returned then the general input types should be assumed)

getDataOutputTypes

public java.lang.String[] getDataOutputTypes()

Specified by:

getDataOutputTypes in interface Tool

Returns:

an array of general output types for nodes for nodes not covered by getDataOutputTypes(int node)

getDataOutputTypes

public java.lang.String[] getDataOutputTypes(int node)

Specified by:

getDataOutputTypes in interface Tool

Returns:

an data types output by the specified node index (if null is returned then the general output types should be assumed)

getDataInputNodeCount

public int getDataInputNodeCount()

Specified by:

getDataInputNodeCount in interface Tool

Returns:

the number of input nodes (default value in ToolImp)

getDataOutputNodeCount

public int getDataOutputNodeCount()

Specified by:

getDataOutputNodeCount in interface Tool

Returns:

the number of output nodes (default value in ToolImp)

getParameterInputNodeCount

public int getParameterInputNodeCount()

Specified by:

getParameterInputNodeCount in interface Tool

Returns:

the number of parameter input nodes

getParameterInputName

public java.lang.String getParameterInputName(int index)

Specified by:

getParameterInputName in interface Tool

Returns:

the parameter name input on the specified node index

isParameterTriggerNode

public boolean isParameterTriggerNode(int index)

Specified by:

isParameterTriggerNode in interface Tool

Returns:

true if specified parameter input node is a trigger node

getParameterOutputNodeCount

public int getParameterOutputNodeCount()

Specified by:

getParameterOutputNodeCount in interface Tool

Returns:

the number of parameter output nodes

getParameterOutputName

public java.lang.String getParameterOutputName(int index)

Specified by:

getParameterOutputName in interface Tool

Returns:

the parameter name input on the specified node index

getInputNodeCount

public int getInputNodeCount()

Specified by:

getInputNodeCount in interface Tool

Returns:

the number of input nodes (data + parameter)

getOutputNodeCount

public int getOutputNodeCount()

Specified by:

getOutputNodeCount in interface Tool

Returns:

the number of output nodes (data + parameter)

getMinDataInputNodes

public int getMinDataInputNodes()

Specified by:

getMinDataInputNodes in interface Tool

Returns:

the minimum number of input nodes for the tool.

getMaxDataInputNodes

public int getMaxDataInputNodes()

Specified by:

getMaxDataInputNodes in interface Tool

Returns:

the maximum number of input nodes.

getDefaultDataInputNodes

public int getDefaultDataInputNodes()

Specified by:

getDefaultDataInputNodes in interface Tool

Returns:

the default number of input nodes

getMinDataOutputNodes

public int getMinDataOutputNodes()

Specified by:

getMinDataOutputNodes in interface Tool

Returns:

the minimum number of output nodes

getMaxDataOutputNodes

public int getMaxDataOutputNodes()

Specified by:

getMaxDataOutputNodes in interface Tool

Returns:

the maximum number of output nodes

getDefaultDataOutputNodes

public int getDefaultDataOutputNodes()

Specified by:

getDefaultDataOutputNodes in interface Tool

Returns:

the default number of output nodes

getExtension

public java.lang.String getExtension(java.lang.String name)

Specified by:

getExtension in interface Tool

Returns:

the value associated with the specified extension

getExtensionNames

public java.lang.String[] getExtensionNames()

Specified by:

getExtensionNames in interface Tool

Returns:

the names of the extensions for this tool

isExtensionName

public boolean isExtensionName(java.lang.String name)

Specified by:

isExtensionName in interface Tool

Returns:

true if there is a value associated with the specified extension name

setVersion

public void setVersion(java.lang.String version)

Description copied from interface: Tool

================from Tool======================

Specified by:

setVersion in interface Tool

setToolName

public void setToolName(java.lang.String toolName)

Description copied from interface: Tool

Used to set the tool name of this ToolImp.

Specified by:

setToolName in interface Tool

setToolPackage

public void setToolPackage(java.lang.String pakageName)

Description copied from interface: Tool

Set the package name for this tool.

Specified by:

setToolPackage in interface Tool

setDefinitionPath

public void setDefinitionPath(java.net.URL filepath)

Description copied from interface: Tool

Used by ToolTable to set the location of the file this tool was loaded from

Specified by:

setDefinitionPath in interface Tool

setToolBox

public void setToolBox(Toolbox toolboxpath)

Description copied from interface: Tool

Used by ToolTable to set the location of the toolbox this tool was loaded from

Specified by:

setToolBox in interface Tool

setDefinitionType

public void setDefinitionType(java.lang.String type)

Description copied from interface: Tool

used when creating clones that are not based on the same definition file type

Specified by:

setDefinitionType in interface Tool

setProxy

public void setProxy(Proxy proxy)
              throws TaskException

Description copied from interface: Tool

Sets the proxy for this tool

Specified by:

setProxy in interface Tool

Throws:

TaskException

removeProxy

public void removeProxy()
                 throws TaskException

Description copied from interface: Tool

Removes the proxy for this tool

Specified by:

removeProxy in interface Tool

Throws:

TaskException

addRenderingHint

public void addRenderingHint(RenderingHint hints)

Description copied from interface: Tool

Adds a rendering hint

Specified by:

addRenderingHint in interface Tool

removeRenderingHint

public void removeRenderingHint(java.lang.String hint)

Description copied from interface: Tool

Removes a rendering hint

Specified by:

removeRenderingHint in interface Tool

setParameter

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

Description copied from interface: Tool

Used to set the parameters.

Specified by:

setParameter in interface Tool

setParameterType

public void setParameterType(java.lang.String name,
                    java.lang.String type)

Description copied from interface: Tool

Used to set the parameter types.

Specified by:

setParameterType in interface Tool

removeParameter

public void removeParameter(java.lang.String name)

Description copied from interface: Tool

Removes the value associated with the specified name.

Specified by:

removeParameter in interface Tool

setPopUpDescription

public void setPopUpDescription(java.lang.String name)

Description copied from interface: Tool

Used to set the pop up description.

Specified by:

setPopUpDescription in interface Tool

setHelpFile

public void setHelpFile(java.lang.String url)

Description copied from interface: Tool

Used to set the help file url.

Specified by:

setHelpFile in interface Tool

setDataInputTypes

public void setDataInputTypes(java.lang.String[] types)

Description copied from interface: Tool

Used to set the input types

Specified by:

setDataInputTypes in interface Tool

setDataOutputTypes

public void setDataOutputTypes(java.lang.String[] types)

Description copied from interface: Tool

Used to set the output types.

Specified by:

setDataOutputTypes in interface Tool

setParameterInputs

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

Description copied from interface: Tool

Used to set the names/number of input parameter nodes, and whether they are trigger nodes.

Specified by:

setParameterInputs in interface Tool

Throws:

NodeException

setParameterOutputs

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

Description copied from interface: Tool

Used to set the names/number of output parameter nodes

Specified by:

setParameterOutputs in interface Tool

Throws:

NodeException

addExtension

public void addExtension(java.lang.String name,
                java.lang.String extension)

Description copied from interface: Tool

Adds an extension

Specified by:

addExtension in interface Tool

removeExtension

public void removeExtension(java.lang.String name)

Description copied from interface: Tool

Removes an extension

Specified by:

removeExtension in interface Tool