compbio.metadata

Class RunnerConfig<T>

java.lang.Object

compbio.metadata.RunnerConfig<T>

Type Parameters:

T - type of an Executable

@NotThreadSafe
public class RunnerConfig<T>
extends java.lang.Object

The list of Parameters and Options supported by executable. The lists is defined in and loaded from Parameters.xml file.

Version:

1.0 October 2009

Author:

pvtroshin

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.List<Option<T>>	arguments
(package private) java.util.List<Option<T>>	options
(package private) java.util.List<Parameter<T>>	parameters
(package private) java.lang.String	prmSeparator
private java.lang.String	runnerClassName The class name of a runnable e.g.

Constructor Summary

Constructors

Constructor and Description
RunnerConfig()

Method Summary

Modifier and Type	Method and Description
void	addOption(Option<T> option) Adds Option to the internal list of options
void	addParameter(Parameter<T> param) Adds parameter to the internal parameter list
RunnerConfig<T>	copyAndValidateRConfig(RunnerConfig<?> runnerConf)
boolean	equals(java.lang.Object obj)
Option<T>	getArgument(java.lang.String name) Returns the argument by its name if found, NULL otherwise.
Option<T>	getArgumentByOptionName(java.lang.String optionName) Returns the argument by option name, NULL if the argument is not found
java.util.List<Option<T>>	getArguments() Returns list of Parameter and Option supported by current runner
java.util.List<Option<T>>	getOptions() Returns the list of the Options supported by the executable of type T
java.util.List<Parameter<T>>	getParameters() Returns the list of parameters supported executable of type T.
java.lang.String	getPrmSeparator()
java.lang.String	getRunnerClassName()
boolean	removeArgument(java.lang.String name) Removes the argument Argument if found.
boolean	removeArgumentByOptionName(java.lang.String optionName) Removes the argument which can be a Parameter or an Option instance by the value in element of the runner configuration descriptor.
void	setOptions(java.util.List<Option<T>> parameters) Adds the list of options or parameters to the internal list of options
void	setParameters(java.util.List<Parameter<T>> parameters) Sets the list of parameters as internal list
void	setPrmSeparator(java.lang.String prmSeparator) Sets name value separator character
void	setRunnerClassName(java.lang.String runnerClassName) Set the name of a runner class
java.lang.String	toString()
void	validate() Validate the value of the argument.

Methods inherited from class java.lang.Object

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

Field Detail

runnerClassName

private java.lang.String runnerClassName

The class name of a runnable e.g. T

options

java.util.List<Option<T>> options

prmSeparator

java.lang.String prmSeparator

parameters

java.util.List<Parameter<T>> parameters

arguments

java.util.List<Option<T>> arguments

Constructor Detail

RunnerConfig

public RunnerConfig()

Method Detail

copyAndValidateRConfig

public RunnerConfig<T> copyAndValidateRConfig(RunnerConfig<?> runnerConf)

getOptions

public java.util.List<Option<T>> getOptions()

Returns the list of the Options supported by the executable of type T

Returns:

list of Option supported by type T

See Also:

Option

addParameter

public void addParameter(Parameter<T> param)

Adds parameter to the internal parameter list

Parameters:

param - the Parameter to add

See Also:

Parameter

addOption

public void addOption(Option<T> option)

Adds Option to the internal list of options

Parameters:

option - the Option to add

getArguments

public java.util.List<Option<T>> getArguments()

Returns list of Parameter and Option supported by current runner

Returns:

list of Option and Parameter supported by type T

getPrmSeparator

public java.lang.String getPrmSeparator()

Returns:

name value separator character

setPrmSeparator

public void setPrmSeparator(java.lang.String prmSeparator)

Sets name value separator character

Parameters:

prmSeparator - the separator char

setOptions

public void setOptions(java.util.List<Option<T>> parameters)

Adds the list of options or parameters to the internal list of options

Parameters:

parameters - the list of parameters to add

getRunnerClassName

public java.lang.String getRunnerClassName()

Returns:

fully qualified class name for type T

setRunnerClassName

public void setRunnerClassName(java.lang.String runnerClassName)

Set the name of a runner class

Parameters:

runnerClassName - the name of the executable wrapping class

setParameters

public void setParameters(java.util.List<Parameter<T>> parameters)

Sets the list of parameters as internal list

Parameters:

parameters - the list of parameters

getParameters

public java.util.List<Parameter<T>> getParameters()

Returns the list of parameters supported executable of type T. Where Parameter is an Option with value.

Returns:

List of Parameter supported by type T.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getArgument

public Option<T> getArgument(java.lang.String name)

Returns the argument by its name if found, NULL otherwise. Where the Argument is a common interface for Option and Parameter therefore this method can return either. If you need to retrieve the Option by its optionNames use @link getArgumentByOptionName(String) method. The difference between option name and optionName is explained by the following example:

 Sequence type
         
         --nuc - Assume the sequences are nucleotide.
         --amino - Assume the sequences are amino acid. 
         --amino
         --nuc
         --auto
 

In the example, the "Sequence type" is a name whereas --amino, --nuc and --auto are all optionNames. This dichotomy only manifests in Option never in Parameters as the latter can only have single element

Parameters:

name - the Parameter of Option name

Returns:

Argument

removeArgument

public boolean removeArgument(java.lang.String name)

Removes the argument Argument if found. Where Argument is either Option or Parameter.

Parameters:

name - of the argument

Returns:

true if argument was removed, false otherwise

getArgumentByOptionName

public Option<T> getArgumentByOptionName(java.lang.String optionName)

Returns the argument by option name, NULL if the argument is not found

Parameters:

optionName - - the optionName. This is not the same as an Option name. For example:

            Output sequences order
                          --inputorder - Output order: same as input. 
                           --reorder - Output order: aligned. Default: same as input
                          --inputorder
                          --reorder
 

The name of the option in the example is "Output sequences order" whereas optionNames are "--inputorder" and "--reorder". If you need to retrieve the Option or Parameter by its names use getArgument(String) method

Returns:

Option

removeArgumentByOptionName

public boolean removeArgumentByOptionName(java.lang.String optionName)

Removes the argument which can be a Parameter or an Option instance by the value in element of the runner configuration descriptor.

Parameters:

optionName - the optionName of the option, do not confuse with the name!

Returns:

true if argument with optionName exists and was removed, false otherwise

See Also:

for destinctions between optionNames and the name of the Option

validate

public void validate()
              throws javax.xml.bind.ValidationException

Validate the value of the argument. Checks whether the argument value is in the valid values range.

Throws:

javax.xml.bind.ValidationException - if any of the arguments found invalid which is when

Parameter value outside ValueConstrain boundary

Parameter name is not listed in possible values