edu.illinois.ncsa.datawolf.tool.example

Class ShiftCharsTool

java.lang.Object

edu.illinois.ncsa.datawolf.tool.example.ShiftCharsTool

All Implemented Interfaces:

JavaTool

public class ShiftCharsTool
extends Object
implements JavaTool

Simple test java tool. Takes in a file and shifts every character by a set ammount.

Author:

Luigi Marini

Constructor Summary

Constructors

Constructor and Description
ShiftCharsTool()

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShiftCharsTool

public ShiftCharsTool()

Method Detail

getName

public String getName()

Description copied from interface: JavaTool

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

Specified by:

getName in interface JavaTool

Returns:

name of the tool.

getVersion

public int getVersion()

Description copied from interface: JavaTool

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.

Specified by:

getVersion in interface JavaTool

Returns:

version number of the tool.

getDescription

public String getDescription()

Description copied from interface: JavaTool

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.

Specified by:

getDescription in interface JavaTool

Returns:

description of the tool.

getInputs

public Collection<Dataset> getInputs()

Description copied from interface: JavaTool

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

Specified by:

getInputs in interface JavaTool

Returns:

collection of inputs.

setInput

public void setInput(String id,
                     InputStream input)

Description copied from interface: JavaTool

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

Specified by:

setInput in interface JavaTool

Parameters:

id - the id of the input.

input - the inputstream that is linked with the input.

getOutputs

public Collection<Dataset> getOutputs()

Description copied from interface: JavaTool

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

Specified by:

getOutputs in interface JavaTool

Returns:

collection of outputs.

getOutput

public InputStream getOutput(String id)

Description copied from interface: JavaTool

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

Specified by:

getOutput in interface JavaTool

Parameters:

id - the id of the output.

Returns:

a inputstream on disk with the output.

getParameters

public Collection<Parameter> getParameters()

Description copied from interface: JavaTool

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

Specified by:

getParameters in interface JavaTool

Returns:

collection of parameters.

setParameter

public void setParameter(String id,
                         String value)

Description copied from interface: JavaTool

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.

Specified by:

setParameter in interface JavaTool

Parameters:

id - the id of the parameter.

value - the value for the parameter.

setTempFolder

public void setTempFolder(File tempfolder)

Description copied from interface: JavaTool

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.

Specified by:

setTempFolder in interface JavaTool

Parameters:

tempfolder - the temp folder created for this execution.

execute

public void execute()
             throws AbortException,
                    FailedException

Description copied from interface: JavaTool

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.

Specified by:

execute in interface JavaTool

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.