org.trianacode.taskgraph.tool

Interface Tool

All Known Subinterfaces:

Task, TaskGraph

All Known Implementing Classes:

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

public interface Tool

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANY_DATA_TYPE
static java.lang.String	CLONE_ALL_OUTPUT
static java.lang.String	CLONE_MULTIPLE_OUTPUT
static java.lang.String	COPY_OUTPUT output policies
static int	DEFAULT_IN_NODES
static java.lang.String	DEFAULT_INPUT_NODES
static int	DEFAULT_MAX_NODES
static int	DEFAULT_MIN_NODES node defaults
static int	DEFAULT_OUT_NODES
static java.lang.String	DEFAULT_OUTPUT_NODES
static java.lang.String	DEFAULT_POP_UP_DESCRIPTION pop_up description default
static java.lang.String	DEFINITION_JAVA_CLASS
static java.lang.String	DEFINITION_METADATA
static java.lang.String	DEFINITION_TRIANA_XML Tool types in terms of their definition files.
static java.lang.String	DEFINITION_UNKNOWN
static java.lang.String	GUI
static java.lang.String	GUI_BUILDER
static java.lang.String	HELP_FILE_PARAM
static java.lang.String	IMMEDIATE_UPDATE parameter update policies
static java.lang.String	INTERNAL
static java.lang.String	LATE_INITIALIZE
static java.lang.String	MAX_INPUT_NODES
static java.lang.String	MAX_OUTPUT_NODES
static java.lang.String	MIN_INPUT_NODES
static java.lang.String	MIN_OUTPUT_NODES
static java.lang.String	NO_UPDATE
static java.lang.String	OLD_GUI_BUILDER
static java.lang.String	ON_TASK_INSTANTIATION
static java.lang.String	ON_USER_ACCESS parameter panel instantiation policies
static java.lang.String	OUTPUT_POLICY
static java.lang.String	PANEL_INSTANCE
static java.lang.String	PARAM_PANEL_CLASS
static java.lang.String	PARAM_PANEL_HIDE
static java.lang.String	PARAM_PANEL_INSTANTIATE
static java.lang.String	PARAM_PANEL_SHOW parameter panel display parameters
static java.lang.String	PARAM_UPDATE_POLICY
static java.lang.String	POP_UP_DESCRIPTION
static java.lang.String	PROCESS_UPDATE
static java.lang.String	TOOL_VERSION tool parameter names
static java.lang.String	TRANSIENT
static java.lang.String	TRANSIENT_ACCESSIBLE
static java.lang.String	UNKNOWN_DATA_TYPE special input/output data types
static java.lang.String	UNKNOWN_TYPE parameter types
static java.lang.String	USER_ACCESSIBLE

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 hints) 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	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	setDataInputTypes(java.lang.String[] types) Used to set the input types
void	setDataOutputTypes(java.lang.String[] types) Used to set the output types.
void	setDefinitionPath(java.net.URL url) 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	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	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	setSubTitle(java.lang.String title)
void	setToolBox(Toolbox toolbox) 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======================

Field Detail

DEFAULT_MIN_NODES

static final int DEFAULT_MIN_NODES

node defaults

See Also:

Constant Field Values

DEFAULT_IN_NODES

static final int DEFAULT_IN_NODES

See Also:

Constant Field Values

DEFAULT_OUT_NODES

static final int DEFAULT_OUT_NODES

See Also:

Constant Field Values

DEFAULT_MAX_NODES

static final int DEFAULT_MAX_NODES

See Also:

Constant Field Values

DEFAULT_POP_UP_DESCRIPTION

static final java.lang.String DEFAULT_POP_UP_DESCRIPTION

pop_up description default

See Also:

Constant Field Values

TOOL_VERSION

static final java.lang.String TOOL_VERSION

tool parameter names

See Also:

Constant Field Values

HELP_FILE_PARAM

static final java.lang.String HELP_FILE_PARAM

See Also:

Constant Field Values

POP_UP_DESCRIPTION

static final java.lang.String POP_UP_DESCRIPTION

See Also:

Constant Field Values

DEFAULT_INPUT_NODES

static final java.lang.String DEFAULT_INPUT_NODES

See Also:

Constant Field Values

MIN_INPUT_NODES

static final java.lang.String MIN_INPUT_NODES

See Also:

Constant Field Values

MAX_INPUT_NODES

static final java.lang.String MAX_INPUT_NODES

See Also:

Constant Field Values

DEFAULT_OUTPUT_NODES

static final java.lang.String DEFAULT_OUTPUT_NODES

See Also:

Constant Field Values

MIN_OUTPUT_NODES

static final java.lang.String MIN_OUTPUT_NODES

See Also:

Constant Field Values

MAX_OUTPUT_NODES

static final java.lang.String MAX_OUTPUT_NODES

See Also:

Constant Field Values

OUTPUT_POLICY

static final java.lang.String OUTPUT_POLICY

See Also:

Constant Field Values

PARAM_UPDATE_POLICY

static final java.lang.String PARAM_UPDATE_POLICY

See Also:

Constant Field Values

PANEL_INSTANCE

static final java.lang.String PANEL_INSTANCE

See Also:

Constant Field Values

PARAM_PANEL_CLASS

static final java.lang.String PARAM_PANEL_CLASS

See Also:

Constant Field Values

PARAM_PANEL_INSTANTIATE

static final java.lang.String PARAM_PANEL_INSTANTIATE

See Also:

Constant Field Values

GUI_BUILDER

static final java.lang.String GUI_BUILDER

See Also:

Constant Field Values

OLD_GUI_BUILDER

static final java.lang.String OLD_GUI_BUILDER

See Also:

Constant Field Values

UNKNOWN_TYPE

static final java.lang.String UNKNOWN_TYPE

parameter types

See Also:

Constant Field Values

INTERNAL

static final java.lang.String INTERNAL

See Also:

Constant Field Values

TRANSIENT

static final java.lang.String TRANSIENT

See Also:

Constant Field Values

LATE_INITIALIZE

static final java.lang.String LATE_INITIALIZE

See Also:

Constant Field Values

USER_ACCESSIBLE

static final java.lang.String USER_ACCESSIBLE

See Also:

Constant Field Values

TRANSIENT_ACCESSIBLE

static final java.lang.String TRANSIENT_ACCESSIBLE

See Also:

Constant Field Values

GUI

static final java.lang.String GUI

See Also:

Constant Field Values

IMMEDIATE_UPDATE

static final java.lang.String IMMEDIATE_UPDATE

parameter update policies

See Also:

Constant Field Values

PROCESS_UPDATE

static final java.lang.String PROCESS_UPDATE

See Also:

Constant Field Values

NO_UPDATE

static final java.lang.String NO_UPDATE

See Also:

Constant Field Values

ON_USER_ACCESS

static final java.lang.String ON_USER_ACCESS

parameter panel instantiation policies

See Also:

Constant Field Values

ON_TASK_INSTANTIATION

static final java.lang.String ON_TASK_INSTANTIATION

See Also:

Constant Field Values

PARAM_PANEL_SHOW

static final java.lang.String PARAM_PANEL_SHOW

parameter panel display parameters

See Also:

Constant Field Values

PARAM_PANEL_HIDE

static final java.lang.String PARAM_PANEL_HIDE

See Also:

Constant Field Values

COPY_OUTPUT

static final java.lang.String COPY_OUTPUT

output policies

See Also:

Constant Field Values

CLONE_MULTIPLE_OUTPUT

static final java.lang.String CLONE_MULTIPLE_OUTPUT

See Also:

Constant Field Values

CLONE_ALL_OUTPUT

static final java.lang.String CLONE_ALL_OUTPUT

See Also:

Constant Field Values

UNKNOWN_DATA_TYPE

static final java.lang.String UNKNOWN_DATA_TYPE

special input/output data types

See Also:

Constant Field Values

ANY_DATA_TYPE

static final java.lang.String ANY_DATA_TYPE

See Also:

Constant Field Values

DEFINITION_TRIANA_XML

static final java.lang.String DEFINITION_TRIANA_XML

Tool types in terms of their definition files.

See Also:

Constant Field Values

DEFINITION_JAVA_CLASS

static final java.lang.String DEFINITION_JAVA_CLASS

See Also:

Constant Field Values

DEFINITION_METADATA

static final java.lang.String DEFINITION_METADATA

See Also:

Constant Field Values

DEFINITION_UNKNOWN

static final java.lang.String DEFINITION_UNKNOWN

See Also:

Constant Field Values

Method Detail

getVersion

java.lang.String getVersion()

getToolName

java.lang.String getToolName()

Returns:

the name of this tool.

getDisplayName

java.lang.String getDisplayName()

getDisplayPackage

java.lang.String getDisplayPackage()

getDefinitionType

java.lang.String getDefinitionType()

getSubTitle

java.lang.String getSubTitle()

setSubTitle

void setSubTitle(java.lang.String title)

getToolPackage

java.lang.String getToolPackage()

Returns:

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

getQualifiedToolName

java.lang.String getQualifiedToolName()

Returns:

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

getDefinitionPath

java.net.URL getDefinitionPath()

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

Toolbox getToolBox()

Returns:

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

getProperties

TrianaProperties getProperties()

Returns the current Triana properties

Returns:

setProperties

void setProperties(TrianaProperties properties)

getProxy

Proxy getProxy()

Returns:

the proxies represented by this tool

getRenderingHints

RenderingHint[] getRenderingHints()

Returns:

the rendering hints for this tool

getRenderingHint

RenderingHint getRenderingHint(java.lang.String hint)

Returns:

the rendering hints for the specified hint

isRenderingHint

boolean isRenderingHint(java.lang.String hint)

Returns:

true if rendering hints exist for the specified hint

getParameter

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

Returns:

the value associated with the specified name

getParameterType

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

Returns:

the type of the specified parameter

getParameterNames

java.lang.String[] getParameterNames()

Returns:

the names of the parameters for this tool

isParameterName

boolean isParameterName(java.lang.String name)

Returns:

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

getPopUpDescription

java.lang.String getPopUpDescription()

Returns:

a brief description of what this tool does

getHelpFile

java.lang.String getHelpFile()

Returns:

the location of the help file.

getDataInputTypes

java.lang.String[] getDataInputTypes()

Returns:

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

getDataInputTypes

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

Returns:

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

getDataOutputTypes

java.lang.String[] getDataOutputTypes()

Returns:

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

getDataOutputTypes

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

Returns:

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

getDataInputNodeCount

int getDataInputNodeCount()

Returns:

the number of input nodes (default value in ToolImp)

getDataOutputNodeCount

int getDataOutputNodeCount()

Returns:

the number of output nodes (default value in ToolImp)

getParameterInputNodeCount

int getParameterInputNodeCount()

Returns:

the number of parameter input nodes

getParameterInputName

java.lang.String getParameterInputName(int index)

Returns:

the parameter name input on the specified node index

isParameterTriggerNode

boolean isParameterTriggerNode(int index)

Returns:

true if specified parameter input node is a trigger node

getParameterOutputNodeCount

int getParameterOutputNodeCount()

Returns:

the number of parameter output nodes

getParameterOutputName

java.lang.String getParameterOutputName(int index)

Returns:

the parameter name input on the specified node index

getInputNodeCount

int getInputNodeCount()

Returns:

the number of input nodes (data + parameter)

getOutputNodeCount

int getOutputNodeCount()

Returns:

the number of output nodes (data + parameter)

getMinDataInputNodes

int getMinDataInputNodes()

Returns:

the minimum number of input nodes for the tool.

getMaxDataInputNodes

int getMaxDataInputNodes()

Returns:

the maximum number of input nodes.

getDefaultDataInputNodes

int getDefaultDataInputNodes()

Returns:

the default number of input nodes

getMinDataOutputNodes

int getMinDataOutputNodes()

Returns:

the minimum number of output nodes

getMaxDataOutputNodes

int getMaxDataOutputNodes()

Returns:

the maximum number of output nodes

getDefaultDataOutputNodes

int getDefaultDataOutputNodes()

Returns:

the default number of output nodes

getExtension

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

Returns:

the value associated with the specified extension

getExtensionNames

java.lang.String[] getExtensionNames()

Returns:

the names of the extensions for this tool

isExtensionName

boolean isExtensionName(java.lang.String name)

Returns:

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

setVersion

void setVersion(java.lang.String version)

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

setToolName

void setToolName(java.lang.String toolName)

Used to set the tool name of this ToolImp.

setToolPackage

void setToolPackage(java.lang.String pakageName)

Set the package name for this tool.

setDefinitionPath

void setDefinitionPath(java.net.URL url)

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

setToolBox

void setToolBox(Toolbox toolbox)

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

setDefinitionType

void setDefinitionType(java.lang.String type)

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

Parameters:

type -

setProxy

void setProxy(Proxy proxy)
              throws TaskException

Sets the proxy for this tool

Throws:

TaskException

removeProxy

void removeProxy()
                 throws TaskException

Removes the proxy for this tool

Throws:

TaskException

addRenderingHint

void addRenderingHint(RenderingHint hints)

Adds a rendering hint

removeRenderingHint

void removeRenderingHint(java.lang.String hint)

Removes a rendering hint

setParameter

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

Used to set the parameters.

setParameterType

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

Used to set the parameter types.

removeParameter

void removeParameter(java.lang.String name)

Removes the value associated with the specified name.

setPopUpDescription

void setPopUpDescription(java.lang.String name)

Used to set the pop up description.

setHelpFile

void setHelpFile(java.lang.String url)

Used to set the help file url.

setDataInputTypes

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

Used to set the input types

setDataOutputTypes

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

Used to set the output types.

setParameterInputs

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

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

Throws:

NodeException

setParameterOutputs

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

Used to set the names/number of output parameter nodes

Throws:

NodeException

addExtension

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

Adds an extension

removeExtension

void removeExtension(java.lang.String name)

Removes an extension