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.

Author:

pvtroshin Date October 2009

Constructor Summary

RunnerConfig()

Method Summary

void	addOption(Option<T> option)
void	addParameter(Parameter<T> param)
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()
java.util.List<Option<T>>	getOptions()
java.util.List<Parameter<T>>	getParameters()
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
void	setOptions(java.util.List<Option<T>> parameters)
void	setParameters(java.util.List<Parameter<T>> parameters)
void	setPrmSeparator(java.lang.String prmSeparator)
void	setRunnerClassName(java.lang.String runnerClassName)
java.lang.String	toString()
void	validate() Validate the arguments

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RunnerConfig

public RunnerConfig()

Method Detail

copyAndValidateRConfig

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

getOptions

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

Returns:

list of Option supported by type T

addParameter

public void addParameter(Parameter<T> param)

addOption

public void addOption(Option<T> option)

getArguments

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

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)

setOptions

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

getRunnerClassName

public java.lang.String getRunnerClassName()

Returns:

fully qualified class name for type T

setRunnerClassName

public void setRunnerClassName(java.lang.String runnerClassName)

setParameters

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

getParameters

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

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

Parameters:

name -

Returns:

Argument

removeArgument

public boolean removeArgument(java.lang.String name)

Removes the argument Argument if found.

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 name of the option

Returns:

Option

removeArgumentByOptionName

public boolean removeArgumentByOptionName(java.lang.String optionName)

Removes the argument

Parameters:

optionName -

Returns:

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

validate

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

Validate the arguments

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