edu.illinois.ncsa.datawolf.executor.java.tool

Interface JavaTool

All Known Implementing Classes:

ShiftCharsTool

public interface JavaTool

Definition of a tool for use with DataWolf.

Author:

Rob Kooper

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Execute the tool.
String	getDescription() Long textual description of the tool.
Collection<Dataset>	getInputs() Retrieve list of inputs for the tool.
String	getName() Return the name of the tool.
InputStream	getOutput(String id) Retrieve a specific output.
Collection<Dataset>	getOutputs() Retrieve list of outputs for the tool.
Collection<Parameter>	getParameters() Retrieve list of parameters for the tool.
int	getVersion() Return the version number of the tool.
void	setInput(String id, InputStream input) Set a specific input.
void	setParameter(String id, String value) Set a specific parameter.
void	setTempFolder(File tempfolder) Sets the temp folder.

Method Detail

getName

String getName()

Return the name of the tool. This is used when displaying the tools in the toolsview.

Returns:

name of the tool.

getVersion

int getVersion()

Return the version number of the tool. This number is displayed after the tool name to distinguish between two versions of the same tool. It is recommended to increase this number every time a new version of the tools is released.

Returns:

version number of the tool.

getDescription

String getDescription()

Long textual description of the tool. This is used to display help about the use of this tool. This description should describe what the tool does, any specifics about the algorithm and parameters, inputs and outputs used.

Returns:

description of the tool.

getInputs

Collection<Dataset> getInputs()

Retrieve list of inputs for the tool. This will return a list of all inputs that are used by the tool.

Returns:

collection of inputs.

setInput

void setInput(String id,
            InputStream input)

Set a specific input. This function will link the id as specified in the Dataset returned by getInputs() with an inputstream.

Parameters:

id - the id of the input.

input - the inputstream that is linked with the input.

getOutputs

Collection<Dataset> getOutputs()

Retrieve list of outputs for the tool. This will return a list of all outputs that are generated by the tool.

Returns:

collection of outputs.

getOutput

InputStream getOutput(String id)

Retrieve a specific output. This will ask for a specific output, the result should be a inputstream.

Parameters:

id - the id of the output.

Returns:

a inputstream on disk with the output.

getParameters

Collection<Parameter> getParameters()

Retrieve list of parameters for the tool. This will return a list of all parameters that are used by the tool.

Returns:

collection of parameters.

setParameter

void setParameter(String id,
                String value)

Set a specific parameter. This function will set the parameter value for a specific id as specified in the Parameter returned by getParameters(). If there is no value set for the parameter the value will be set to null.

Parameters:

id - the id of the parameter.

value - the value for the parameter.

setTempFolder

void setTempFolder(File tempfolder)

Sets the temp folder. Each process has its own folder in the temp folder that will be deleted after the execution is finished and the outputs are fetched. One use of this temp folder is to store results that are retrieved using the getOutput function.

Parameters:

tempfolder - the temp folder created for this execution.

execute

void execute()
             throws AbortException,
                    FailedException

Execute the tool. This function is called when the tool is executed. At this point the inputs and parameters have been set. After the function is completed getOutput() will be called to retrieve the results.

Throws:

AbortException - throws abort exception if the step was aborted.

FailedException - throws failed exception if the step failed to executed, or an error occurred during execution.