public interface JavaTool
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.
|
String getName()
int getVersion()
String getDescription()
Collection<Dataset> getInputs()
void setInput(String id, InputStream input)
id
- the id of the input.input
- the inputstream that is linked with the input.Collection<Dataset> getOutputs()
InputStream getOutput(String id)
id
- the id of the output.Collection<Parameter> getParameters()
void setParameter(String id, String value)
id
- the id of the parameter.value
- the value for the parameter.void setTempFolder(File tempfolder)
tempfolder
- the temp folder created for this execution.void execute() throws AbortException, FailedException
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.Copyright © 2020. All rights reserved.