org.trianacode.taskgraph.imp

Class ToolImp

java.lang.Object

org.trianacode.taskgraph.imp.ToolImp

All Implemented Interfaces:

Tool

Direct Known Subclasses:

TaskImp

public class ToolImp
extends java.lang.Object
implements Tool

A generic definition of a tool in a xmlFilepath which is extended to make a task.

Field Summary

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
ToolImp(Tool tool) Creates a clone of the specified tool
ToolImp(TrianaProperties properties) Default constructor Which blows everything up.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtension(java.lang.String name, java.lang.String extension) Adds an extension
void	addRenderingHint(RenderingHint hint) Adds a rendering hint
int	getDataInputNodeCount()
java.lang.String[]	getDataInputTypes()
java.lang.String[]	getDataInputTypes(int node)
int	getDataOutputNodeCount()
java.lang.String[]	getDataOutputTypes()
java.lang.String[]	getDataOutputTypes(int node)
int	getDefaultDataInputNodes()
int	getDefaultDataOutputNodes()
java.net.URL	getDefinitionPath()
java.lang.String	getDefinitionType()
java.lang.String	getDisplayName()
java.lang.String	getDisplayPackage()
java.lang.String	getExtension(java.lang.String name)
java.lang.String[]	getExtensionNames()
java.lang.String	getHelpFile()
int	getInputNodeCount()
int	getMaxDataInputNodes()
int	getMaxDataOutputNodes()
int	getMinDataInputNodes()
int	getMinDataOutputNodes()
int	getOutputNodeCount()
java.lang.Object	getParameter(java.lang.String name)
java.lang.String	getParameterInputName(int index)
int	getParameterInputNodeCount()
java.lang.String[]	getParameterNames()
java.lang.String	getParameterOutputName(int index)
int	getParameterOutputNodeCount()
java.lang.String	getParameterType(java.lang.String name)
java.lang.String	getPopUpDescription()
TrianaProperties	getProperties() Returns the current Triana properties
Proxy	getProxy()
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()
java.lang.String	getUnitName()
java.lang.String	getUnitPackage()
java.lang.String	getVersion()
boolean	isExtensionName(java.lang.String name)
boolean	isParameterName(java.lang.String name)
boolean	isParameterTriggerNode(int index)
boolean	isRenderingHint(java.lang.String hint)
void	removeExtension(java.lang.String name) Removes an extension
void	removeParameter(java.lang.String name) Removes the value associated with the specified name.
void	removeProxy() Removes the proxy for this tool
void	removeRenderingHint(java.lang.String hint) Removes a rendering hint
void	setDataInputNodeCount(int nodeCount) Used to set the number of input nodes.
void	setDataInputTypes(int node, java.lang.String[] types) Used by ToolFactory to set the input types for each node
void	setDataInputTypes(java.lang.String[] types) Used by ToolFactory to set the input types.
void	setDataOutputNodeCount(int nodeCount) Used to set the number of output nodes.
void	setDataOutputTypes(int node, java.lang.String[] types) Used by ToolFactory to set the output types for each node
void	setDataOutputTypes(java.lang.String[] types) Used to set the output types.
void	setDefaultDataInputNodes(int nodes) Sets the minimum number of input nodes for the tool.
void	setDefaultDataOutputNodes(int nodes) Sets the minimum number of input nodes for the tool.
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	setDisplayName(java.lang.String displayName)
void	setDisplayPackage(java.lang.String displayPackage)
void	setHelpFile(java.lang.String help) Used to set the help file.
void	setMaxDataInputNodes(int nodes) Sets the minimum number of input nodes for the tool.
void	setMaxDataOutputNodes(int nodes) Sets the minimum number of input nodes for the tool.
void	setMinDataInputNodes(int nodes) Sets the minimum number of input nodes for the tool.
void	setMinDataOutputNodes(int nodes) Sets the minimum number of input nodes for the tool.
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
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	setPopUpDescription(java.lang.String desc) Used to set the pop up description.
void	setProperties(TrianaProperties properties)
void	setProxy(Proxy proxy) Adds a proxy this tool
void	setSubTitle(java.lang.String subtext)
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 Tool.
void	setToolPackage(java.lang.String packageName) Set the package name for this tool.
void	setVersion(java.lang.String version) ================from Tool======================
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolImp

public ToolImp(TrianaProperties properties)

Default constructor Which blows everything up. Where do the proerpties come from ???????????????????????

ToolImp

public ToolImp(Tool tool)
        throws TaskException

Creates a clone of the specified tool

Throws:

TaskException

Method Detail

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 the unit defined by 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

getProperties

public TrianaProperties getProperties()

Description copied from interface: Tool

Returns the current Triana properties

Specified by:

getProperties in interface Tool

Returns:

setProperties

public void setProperties(TrianaProperties properties)

Specified by:

setProperties in interface Tool

setDisplayName

public void setDisplayName(java.lang.String displayName)

setDisplayPackage

public void setDisplayPackage(java.lang.String displayPackage)

getDefinitionType

public java.lang.String getDefinitionType()

Specified by:

getDefinitionType 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

setToolName

public void setToolName(java.lang.String toolName)

Used to set the tool name of this Tool.

Specified by:

setToolName 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

setToolPackage

public void setToolPackage(java.lang.String packageName)

Set the package name for this tool.

Specified by:

setToolPackage in interface Tool

setToolBox

public void setToolBox(Toolbox toolboxpath)

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

Specified by:

setToolBox in interface Tool

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

setProxy

public void setProxy(Proxy proxy)
              throws TaskException

Adds a proxy this tool

Specified by:

setProxy in interface Tool

Throws:

TaskException

removeProxy

public void removeProxy()
                 throws TaskException

Removes the proxy for this tool

Specified by:

removeProxy in interface Tool

Throws:

TaskException

addRenderingHint

public void addRenderingHint(RenderingHint hint)

Adds a rendering hint

Specified by:

addRenderingHint in interface Tool

removeRenderingHint

public void removeRenderingHint(java.lang.String hint)

Removes a rendering hint

Specified by:

removeRenderingHint in interface 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, or null if the parameter does not exist.

getParameterType

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

Specified by:

getParameterType in interface Tool

Returns:

the type of the specified parameter, the default being Tool.UNKNOWN. Returns null if the parameter does not exist.

setParameter

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

Used to set the parameters.

Specified by:

setParameter in interface Tool

setParameterType

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

Used to set the parameter types.

Specified by:

setParameterType in interface Tool

removeParameter

public void removeParameter(java.lang.String name)

Removes the value associated with the specified name.

Specified by:

removeParameter in interface Tool

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 a value is set for the specified name

getPopUpDescription

public java.lang.String getPopUpDescription()

Specified by:

getPopUpDescription in interface Tool

Returns:

a brief description of what this tool does

setPopUpDescription

public void setPopUpDescription(java.lang.String desc)

Used to set the pop up description.

Specified by:

setPopUpDescription in interface Tool

getHelpFile

public java.lang.String getHelpFile()

Specified by:

getHelpFile in interface Tool

Returns:

the location of the help file.

setHelpFile

public void setHelpFile(java.lang.String help)

Used to set the help file.

Specified by:

setHelpFile in interface Tool

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 types returned by getDataInputTypes() should be assumed)

getDataInputTypes

public java.lang.String[] getDataInputTypes()

Specified by:

getDataInputTypes in interface Tool

Returns:

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

setDataInputTypes

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

Used by ToolFactory to set the input types for each node

setDataInputTypes

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

Used by ToolFactory to set the input types.

Specified by:

setDataInputTypes in interface Tool

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 types returned by getDataInputTypes() should be assumed)

getDataOutputTypes

public java.lang.String[] getDataOutputTypes()

Specified by:

getDataOutputTypes in interface Tool

Returns:

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

setDataOutputTypes

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

Used by ToolFactory to set the output types for each node

setDataOutputTypes

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

Used to set the output types.

Specified by:

setDataOutputTypes in interface Tool

getDataInputNodeCount

public int getDataInputNodeCount()

Specified by:

getDataInputNodeCount in interface Tool

Returns:

the number of input nodes (default value in ToolImp)

setDataInputNodeCount

public void setDataInputNodeCount(int nodeCount)
                           throws NodeException

Used to set the number of input nodes.

Throws:

NodeException

getDataOutputNodeCount

public int getDataOutputNodeCount()

Specified by:

getDataOutputNodeCount in interface Tool

Returns:

the number of output nodes (default value in ToolImp)

setDataOutputNodeCount

public void setDataOutputNodeCount(int nodeCount)
                            throws NodeException

Used to set the number of output nodes.

Throws:

NodeException

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 the specified parameter input node is a trigger node

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

Throws:

NodeException

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

setParameterOutputs

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

Used to set the names/number of output parameter nodes

Specified by:

setParameterOutputs in interface Tool

Throws:

NodeException

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.

setMinDataInputNodes

public void setMinDataInputNodes(int nodes)

Sets 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.

setMaxDataInputNodes

public void setMaxDataInputNodes(int nodes)

Sets the minimum number of input nodes for the tool.

getDefaultDataInputNodes

public int getDefaultDataInputNodes()

Specified by:

getDefaultDataInputNodes in interface Tool

Returns:

the default number of input nodes

setDefaultDataInputNodes

public void setDefaultDataInputNodes(int nodes)

Sets the minimum number of input nodes for the tool.

getMinDataOutputNodes

public int getMinDataOutputNodes()

Specified by:

getMinDataOutputNodes in interface Tool

Returns:

the minimum number of output nodes

setMinDataOutputNodes

public void setMinDataOutputNodes(int nodes)

Sets the minimum number of input nodes for the tool.

getMaxDataOutputNodes

public int getMaxDataOutputNodes()

Specified by:

getMaxDataOutputNodes in interface Tool

Returns:

the maximum number of output nodes

setMaxDataOutputNodes

public void setMaxDataOutputNodes(int nodes)

Sets the minimum number of input nodes for the tool.

getDefaultDataOutputNodes

public int getDefaultDataOutputNodes()

Specified by:

getDefaultDataOutputNodes in interface Tool

Returns:

the default number of output nodes

setDefaultDataOutputNodes

public void setDefaultDataOutputNodes(int nodes)

Sets the minimum number of input nodes for the tool.

getDefinitionPath

public java.net.URL getDefinitionPath()

Specified by:

getDefinitionPath in interface Tool

Returns:

the location directory that held the file this tool was generated from.

setDefinitionPath

public void setDefinitionPath(java.net.URL filepath)

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

Specified by:

setDefinitionPath in interface Tool

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

getUnitName

public java.lang.String getUnitName()

Returns:

the classname of the unit that this tool executes.

getUnitPackage

public java.lang.String getUnitPackage()

Returns:

the package of the unit that this tool executes.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addExtension

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

Adds an extension

Specified by:

addExtension in interface Tool

removeExtension

public void removeExtension(java.lang.String name)

Removes an extension

Specified by:

removeExtension in interface Tool

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

setSubTitle

public void setSubTitle(java.lang.String subtext)

Specified by:

setSubTitle in interface Tool

getSubTitle

public java.lang.String getSubTitle()

Specified by:

getSubTitle in interface Tool