org.trianacode.taskgraph.tool

Interface Toolbox

All Known Implementing Classes:

FileToolbox

public interface Toolbox

Method Summary

Methods

Modifier and Type	Method and Description
void	addTool(Tool tool)
Tool	deleteTool(java.lang.String name) not always supported.
java.lang.String	getName() a name for the toolbox.
java.lang.String	getPath() a path for the toolbox.
TrianaProperties	getProperties()
Tool	getTool(java.lang.String name) get a tool using tool.getQualifiedToolName()
java.util.List<Tool>	getTools() get all tools
java.util.List<Tool>	getTools(java.net.URL url) get tools that share the same definition path
java.lang.String	getType() a type for the toolbox.
void	loadTools() load all tools
void	refresh(java.net.URL url) relaod tools at a particular URL (this is the tool.getDefinitionPath())
Tool	removeTool(java.lang.String name) could be called deregisterTool
void	setName(java.lang.String name)
void	setProperties(TrianaProperties properties)

Method Detail

getName

java.lang.String getName()

a name for the toolbox.

Returns:

setName

void setName(java.lang.String name)

getPath

java.lang.String getPath()

a path for the toolbox. This should be unique among all loaded toolboxes

Returns:

getType

java.lang.String getType()

a type for the toolbox. The type determines which ToolboxLoader can load this Toolbox. It should share its type with the ToolboxLoader that loaded it.

Returns:

getProperties

TrianaProperties getProperties()

setProperties

void setProperties(TrianaProperties properties)

loadTools

void loadTools()
               throws java.lang.Exception

load all tools

Throws:

java.lang.Exception

refresh

void refresh(java.net.URL url)
             throws java.lang.Exception

relaod tools at a particular URL (this is the tool.getDefinitionPath())

Parameters:

url -

Throws:

java.lang.Exception

getTools

java.util.List<Tool> getTools(java.net.URL url)

get tools that share the same definition path

Parameters:

url -

Returns:

Throws:

java.lang.Exception

getTools

java.util.List<Tool> getTools()

get all tools

Returns:

addTool

void addTool(Tool tool)

getTool

Tool getTool(java.lang.String name)

get a tool using tool.getQualifiedToolName()

Parameters:

name -

Returns:

removeTool

Tool removeTool(java.lang.String name)

could be called deregisterTool

Parameters:

name -

Returns:

deleteTool

Tool deleteTool(java.lang.String name)

not always supported. Has the concept of 'deletion' that may not be appropriate Keeping for now...

Parameters:

name -

Returns: