databionics.modules
Class Tool

java.lang.Object
  databionics.modules.Tool

Direct Known Subclasses:

Job

public class Tool
extends java.lang.Object

A program that processes data.

Field Summary

protected java.lang.String	command command to run this tool
protected java.lang.String	description description
protected java.util.List	inputTypes list of file types needed when running this tool
protected int	interactiveParams number interactive (non-file and non-constant parameters)
protected static org.apache.log4j.Logger	log log4j logging
protected java.lang.String	name name
protected java.lang.String	os run only on this operating system if set
protected java.util.List	outputTypes list of file type created by this tool
protected java.util.List	parameters for calling the tool, these parameters are needed
protected boolean	showProgress boolean: true, if there is a parameter, which shows the progress while running tool

Constructor Summary

Tool()
Default constructor

Method Summary

java.lang.String	getCommand() Get command to run this tool
java.lang.String	getDescription() Get the description
InputFileParameter	getInputFileParameter(FileType t) Get an InputFileParameter by the FileType
java.util.List	getInputFileParameters() Get the fileparameters, which are used as inputfiles for the tool
java.util.List	getInputTypes() Get the list of file types needed when running this tool
int	getInteractiveParams() Get the number of interactive parameters, i.e.
java.lang.String	getName() Get the name
java.lang.String	getOperatingSystem() Get the os
java.util.List	getOutputFileParameters() Get the fileparameters representing the created files
java.util.List	getOutputTypes() Get the list of file type created by this tool
Parameter	getParameterByName(java.lang.String name) Get a parameter by name
java.util.List	getParameters() Get the list of parameters
boolean	hasInteractiveParams() Check if there are parameters to be set by the user
void	setCommand(java.lang.String s) Set command to run this tool
void	setDescription(java.lang.String s) Set the description
void	setName(java.lang.String s) Set the name
void	setOperatingSystem(java.lang.String s) Set the os
void	setShowProgress(boolean show) Set flag whether show progress when running this tool
boolean	showProgress() Get flag whether show progress when running this tool
static Tool	valueOf(org.w3c.dom.Element el) Create a Tool from an XML tag

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

log4j logging

name

protected java.lang.String name

name

command

protected java.lang.String command

command to run this tool

description

protected java.lang.String description

description

os

protected java.lang.String os

run only on this operating system if set

inputTypes

protected java.util.List inputTypes

list of file types needed when running this tool

outputTypes

protected java.util.List outputTypes

list of file type created by this tool

parameters

protected java.util.List parameters

for calling the tool, these parameters are needed

showProgress

protected boolean showProgress

boolean: true, if there is a parameter, which shows the progress while running tool

interactiveParams

protected int interactiveParams

number interactive (non-file and non-constant parameters)

Constructor Detail

Tool

public Tool()

Default constructor

Method Detail

getName

public java.lang.String getName()

Get the name

setName

public void setName(java.lang.String s)

Set the name

getCommand

public java.lang.String getCommand()

Get command to run this tool

setCommand

public void setCommand(java.lang.String s)

Set command to run this tool

getDescription

public java.lang.String getDescription()

Get the description

setDescription

public void setDescription(java.lang.String s)

Set the description

getOperatingSystem

public java.lang.String getOperatingSystem()

Get the os

setOperatingSystem

public void setOperatingSystem(java.lang.String s)

Set the os

getInputTypes

public java.util.List getInputTypes()

Get the list of file types needed when running this tool

getOutputTypes

public java.util.List getOutputTypes()

Get the list of file type created by this tool

getParameters

public java.util.List getParameters()

Get the list of parameters

getParameterByName

public Parameter getParameterByName(java.lang.String name)

Get a parameter by name

Parameters:

name -

Returns:

Parameter

getInputFileParameters

public java.util.List getInputFileParameters()

Get the fileparameters, which are used as inputfiles for the tool

Returns:

list with inputfile parameters

getInputFileParameter

public InputFileParameter getInputFileParameter(FileType t)

Get an InputFileParameter by the FileType

Parameters:

FileType -

Returns:

FileParameter

getOutputFileParameters

public java.util.List getOutputFileParameters()

Get the fileparameters representing the created files

Returns:

list with outputfile parameters

showProgress

public boolean showProgress()

Get flag whether show progress when running this tool

setShowProgress

public void setShowProgress(boolean show)

Set flag whether show progress when running this tool

getInteractiveParams

public int getInteractiveParams()

Get the number of interactive parameters, i.e. all non-file and non-constant parameters

hasInteractiveParams

public boolean hasInteractiveParams()

Check if there are parameters to be set by the user

valueOf

public static Tool valueOf(org.w3c.dom.Element el)

Create a Tool from an XML tag