org.trianacode.taskgraph.tool

Interface ToolTable

All Known Implementing Classes:

ToolTableImpl

public interface ToolTable

An interface to the currently loaded tools.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	USER_TOOLBOX

Method Summary

Methods

Modifier and Type	Method and Description
void	addToolBox(Toolbox... path) Add a tool box path to the current tool boxes
void	addToolTableListener(ToolListener listener) Adds a listener to be notified when new tools are added/removed
void	deleteTool(Tool tool, boolean files) Deletes the specified tool.
java.lang.String	getPasteFileLocation(java.lang.String toolname, java.lang.String pack, java.lang.String toolbox) Generate a new file location to store a pasted tool
TrianaProperties	getProperties()
Tool	getTool(java.lang.String toolName)
Toolbox[]	getToolBoxes()
Toolbox[]	getToolBoxes(java.lang.String type)
java.lang.String[]	getToolBoxPaths()
java.lang.String	getToolBoxType(java.lang.String toolbox)
java.lang.String[]	getToolNames()
ToolResolver	getToolResolver() Gets the tool resolver for this tool table -- added by Ian T to fix the static loading of tool resolvers.
Tool[]	getTools() get all tools
Tool[]	getTools(java.net.URL definitionPath) get the list of tools that share the same definition path.
void	insertTool(Tool tool, java.lang.String pack, java.lang.String toolbox) Inserts a copy of the tool into the specified package.
boolean	isModifiable(Tool tool) return true if this tool can be modified.
boolean	isTool(java.lang.String toolName)
void	refreshLocation(java.net.URL location, java.lang.String toolbox) Notifies the tool table to update the tool loaded from the specified location, such as when a tool is created.
boolean	removeToolBox(java.lang.String path) Remove a tool box path from the current tool boxes
void	removeToolTableListener(ToolListener listener) Removes a listener from being notified when new tools are added/removed

Field Detail

USER_TOOLBOX

static final java.lang.String USER_TOOLBOX

See Also:

Constant Field Values

Method Detail

getToolBoxes

Toolbox[] getToolBoxes()

Returns:

a list of the current tool box paths

getToolBoxPaths

java.lang.String[] getToolBoxPaths()

getProperties

TrianaProperties getProperties()

getToolBoxes

Toolbox[] getToolBoxes(java.lang.String type)

Returns:

the tool box path of the specified type (null if no tool box specified for that type)

getToolBoxType

java.lang.String getToolBoxType(java.lang.String toolbox)

Returns:

the type for the specified tool box path (null if no type specified for the tool box path)

getTools

Tool[] getTools(java.net.URL definitionPath)

get the list of tools that share the same definition path. This could be the case if a tool is in a jar file for example, which contains other tools.

Parameters:

definitionPath -

Returns:

addToolBox

void addToolBox(Toolbox... path)

Add a tool box path to the current tool boxes

removeToolBox

boolean removeToolBox(java.lang.String path)

Remove a tool box path from the current tool boxes

getTool

Tool getTool(java.lang.String toolName)

Returns:

the tool with the specified name (if there are multiple tools with the same name then the first found is returned)

getTools

Tool[] getTools()

get all tools

Returns:

isTool

boolean isTool(java.lang.String toolName)

Returns:

true if a tool with the given name exists

getToolNames

java.lang.String[] getToolNames()

Returns:

an array of the names of the currently loaded tools

insertTool

void insertTool(Tool tool,
              java.lang.String pack,
              java.lang.String toolbox)

Inserts a copy of the tool into the specified package. Combined with deleteTool this can be used to cut + paste tools.

Parameters:

tool - the tool being pasted

pack - the package of the pasted tool

toolbox - the toolbox the tool is pasted into (ignore if irrelevant)

deleteTool

void deleteTool(Tool tool,
              boolean files)

Deletes the specified tool.

isModifiable

boolean isModifiable(Tool tool)

return true if this tool can be modified. A remote tool, or a jarred tool may not be.

Parameters:

tool -

Returns:

refreshLocation

void refreshLocation(java.net.URL location,
                   java.lang.String toolbox)

Notifies the tool table to update the tool loaded from the specified location, such as when a tool is created. The location should be in a form understanded by the tool table (e.g. XML file location, tool server network address), and is ignored if not understood.

Parameters:

location - the location of the file

toolbox - the toolbox the location is in (specify null if unknown)

addToolTableListener

void addToolTableListener(ToolListener listener)

Adds a listener to be notified when new tools are added/removed

removeToolTableListener

void removeToolTableListener(ToolListener listener)

Removes a listener from being notified when new tools are added/removed

getPasteFileLocation

java.lang.String getPasteFileLocation(java.lang.String toolname,
                                    java.lang.String pack,
                                    java.lang.String toolbox)

Generate a new file location to store a pasted tool

Parameters:

toolname - tool to be created

pack - tool package name

toolbox - toolbox to create the tool in

Returns:

a unused file to store the xml for the specified tool in

getToolResolver

ToolResolver getToolResolver()

Gets the tool resolver for this tool table -- added by Ian T to fix the static loading of tool resolvers.