org.trianacode.taskgraph.tool

Class ToolTableImpl

java.lang.Object

org.trianacode.taskgraph.tool.ToolTableImpl

All Implemented Interfaces:

ToolListener, ToolTable

public class ToolTableImpl
extends java.lang.Object
implements ToolTable, ToolListener

Class Description Here...

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<ToolListener>	listeners An array list of tool listeners
static java.lang.String	USER_TOOLBOX

Constructor Summary

Constructors

Constructor and Description
ToolTableImpl(ToolResolver resolver)

Method Summary

Methods

Modifier and Type	Method and Description
void	addToolBox(Toolbox... boxes) Add a tool box path to the current tool boxes
void	addToolTableListener(ToolListener listener) Add a listener to be notified when new tools are discovered
void	deleteTool(Tool tool, boolean files) Deletes the specified tool.
java.lang.String	findToolBox(java.net.URL location) Attempts to find a toolbox that contains the specified location
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) A method to lookup the tool with the given the tool name.
Toolbox[]	getToolBoxes()
Toolbox[]	getToolBoxes(java.lang.String type)
java.lang.String[]	getToolBoxPaths()
java.lang.String	getToolBoxType(java.lang.String toolbox)
java.lang.String[]	getToolNames() returns an array of strings of qualified tool names.
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)
protected void	notifyToolAdded(Tool tool) Notifies the tool listeners when a tool is added
protected void	notifyToolboxAdded(Toolbox toolbox) Notifies a listener when tool box is added
protected void	notifyToolboxRemoved(Toolbox toolbox) Notifies a listener when tool box is removed
protected void	notifyToolboxRenamed(Toolbox toolbox, java.lang.String name)
protected void	notifyToolboxRenaming(Toolbox toolbox, java.lang.String name)
protected void	notifyToolRemoved(Tool tool) Notifies the tool listeners when a tool is removed
protected void	notifyToolsAdded(java.util.List<Tool> tool) Notifies the tool listeners when a tool is added
protected void	notifyToolsRemoved(java.util.List<Tool> tool) Notifies the tool listeners when a tool is removed
protected void	purgeTool(Tool tool) Removes the tool
protected void	purgeToolRef(Tool tool) Removes references to the tool
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) Removes a tool box from the current tool boxes and from the tool box types if it has a type set.
void	removeToolTableListener(ToolListener listener) Removes a tool listener
void	toolAdded(Tool tool) Called when a new tool is added
void	toolBoxAdded(Toolbox toolbox) Called when a Tool Box is added
void	toolboxNameChanged(Toolbox toolbox, java.lang.String newName)
void	toolboxNameChanging(Toolbox toolbox, java.lang.String newName)
void	toolBoxRemoved(Toolbox toolbox) Called when a Tool Box is Removed
void	toolRemoved(Tool tool) Called when a tool is removed
void	toolsAdded(java.util.List<Tool> tools)
void	toolsRemoved(java.util.List<Tool> tools)

Methods inherited from class java.lang.Object

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

Field Detail

USER_TOOLBOX

public static final java.lang.String USER_TOOLBOX

See Also:

Constant Field Values

listeners

protected java.util.Vector<ToolListener> listeners

An array list of tool listeners

Constructor Detail

ToolTableImpl

public ToolTableImpl(ToolResolver resolver)

Method Detail

getProperties

public TrianaProperties getProperties()

Specified by:

getProperties in interface ToolTable

addToolTableListener

public void addToolTableListener(ToolListener listener)

Add a listener to be notified when new tools are discovered

Specified by:

addToolTableListener in interface ToolTable

removeToolTableListener

public void removeToolTableListener(ToolListener listener)

Removes a tool listener

Specified by:

removeToolTableListener in interface ToolTable

getToolResolver

public ToolResolver getToolResolver()

Description copied from interface: ToolTable

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

Specified by:

getToolResolver in interface ToolTable

getTool

public Tool getTool(java.lang.String toolName)

A method to lookup the tool with the given the tool name.

Specified by:

getTool in interface ToolTable

Parameters:

toolName - The name of the tool we are looking for

Returns:

The Tool or null if not found

getTools

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

Description copied from interface: ToolTable

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.

Specified by:

getTools in interface ToolTable

Returns:

an array of the tools that share the same file

getTools

public Tool[] getTools()

Description copied from interface: ToolTable

get all tools

Specified by:

getTools in interface ToolTable

Returns:

an array of the tools with the specified name

isTool

public boolean isTool(java.lang.String toolName)

Specified by:

isTool in interface ToolTable

Returns:

true if a tool with the given name exists

getToolNames

public java.lang.String[] getToolNames()

returns an array of strings of qualified tool names.

Specified by:

getToolNames in interface ToolTable

Returns:

an array of the names of the currently loaded tools

refreshLocation

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

Description copied from interface: ToolTable

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.

Specified by:

refreshLocation in interface ToolTable

Parameters:

location - the location of the file

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

insertTool

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

Inserts a copy of the tool into the specified package. Combined with delete tool this can be used to cut/copy tools.

Specified by:

insertTool in interface ToolTable

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

public void deleteTool(Tool tool,
              boolean files)

Deletes the specified tool.

Specified by:

deleteTool in interface ToolTable

Parameters:

tool - tool to be deleted

isModifiable

public boolean isModifiable(Tool tool)

Description copied from interface: ToolTable

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

Specified by:

isModifiable in interface ToolTable

Returns:

getPasteFileLocation

public 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

Specified by:

getPasteFileLocation in interface ToolTable

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

notifyToolsAdded

protected void notifyToolsAdded(java.util.List<Tool> tool)

Notifies the tool listeners when a tool is added

Parameters:

tool - the tool added to the ToolTable

notifyToolsRemoved

protected void notifyToolsRemoved(java.util.List<Tool> tool)

Notifies the tool listeners when a tool is removed

Parameters:

tool - the Tool removed from the ToolTable

notifyToolAdded

protected void notifyToolAdded(Tool tool)

Notifies the tool listeners when a tool is added

Parameters:

tool - the tool added to the ToolTable

notifyToolRemoved

protected void notifyToolRemoved(Tool tool)

Notifies the tool listeners when a tool is removed

Parameters:

tool - the Tool removed from the ToolTable

notifyToolboxAdded

protected void notifyToolboxAdded(Toolbox toolbox)

Notifies a listener when tool box is added

Parameters:

toolbox - the toolbox added to the ToolTable

notifyToolboxRemoved

protected void notifyToolboxRemoved(Toolbox toolbox)

Notifies a listener when tool box is removed

Parameters:

toolbox - the toolbox removed from the ToolTable

notifyToolboxRenamed

protected void notifyToolboxRenamed(Toolbox toolbox,
                        java.lang.String name)

notifyToolboxRenaming

protected void notifyToolboxRenaming(Toolbox toolbox,
                         java.lang.String name)

getToolBoxes

public Toolbox[] getToolBoxes()

Specified by:

getToolBoxes in interface ToolTable

Returns:

a list of the current tool box paths

getToolBoxPaths

public java.lang.String[] getToolBoxPaths()

Specified by:

getToolBoxPaths in interface ToolTable

getToolBoxes

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

Specified by:

getToolBoxes in interface ToolTable

Returns:

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

getToolBoxType

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

Specified by:

getToolBoxType in interface ToolTable

Returns:

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

addToolBox

public void addToolBox(Toolbox... boxes)

Add a tool box path to the current tool boxes

Specified by:

addToolBox in interface ToolTable

removeToolBox

public boolean removeToolBox(java.lang.String path)

Removes a tool box from the current tool boxes and from the tool box types if it has a type set.

Specified by:

removeToolBox in interface ToolTable

Parameters:

path - the path of the tool box to remove

findToolBox

public java.lang.String findToolBox(java.net.URL location)

Attempts to find a toolbox that contains the specified location

Parameters:

location - the location being searched for in existing toolboxes

Returns:

the found toolbox location

purgeTool

protected void purgeTool(Tool tool)

Removes the tool

Parameters:

tool - the Tool.

purgeToolRef

protected void purgeToolRef(Tool tool)

Removes references to the tool

Parameters:

tool - the Tool.

toolsAdded

public void toolsAdded(java.util.List<Tool> tools)

Specified by:

toolsAdded in interface ToolListener

toolsRemoved

public void toolsRemoved(java.util.List<Tool> tools)

Specified by:

toolsRemoved in interface ToolListener

toolAdded

public void toolAdded(Tool tool)

Description copied from interface: ToolListener

Called when a new tool is added

Specified by:

toolAdded in interface ToolListener

toolRemoved

public void toolRemoved(Tool tool)

Description copied from interface: ToolListener

Called when a tool is removed

Specified by:

toolRemoved in interface ToolListener

toolBoxAdded

public void toolBoxAdded(Toolbox toolbox)

Description copied from interface: ToolListener

Called when a Tool Box is added

Specified by:

toolBoxAdded in interface ToolListener

toolBoxRemoved

public void toolBoxRemoved(Toolbox toolbox)

Description copied from interface: ToolListener

Called when a Tool Box is Removed

Specified by:

toolBoxRemoved in interface ToolListener

toolboxNameChanging

public void toolboxNameChanging(Toolbox toolbox,
                       java.lang.String newName)

Specified by:

toolboxNameChanging in interface ToolListener

toolboxNameChanged

public void toolboxNameChanged(Toolbox toolbox,
                      java.lang.String newName)

Specified by:

toolboxNameChanged in interface ToolListener