compbio.metadata
Class Parameter<T>

java.lang.Object
  compbio.metadata.Option<T>
      compbio.metadata.Parameter<T>

All Implemented Interfaces:

Argument<T>

public class Parameter<T>
extends Option<T>

A single value containing an option supported by the web service e.g. seqType=protein. Where seqType is a optionName and protein is one of possibleValues

Version:

1.0 November 2009

Author:

pvtroshin

See Also:

Option, Argument

Constructor Summary

Parameter(java.lang.String name, java.lang.String description)

Method Summary

java.util.Set<java.lang.String>	addOptionNames(java.lang.String... value) Adds an option to the optionName list
java.util.Set<java.lang.String>	addPossibleValues(java.lang.String... value)
boolean	equals(java.lang.Object obj)
java.lang.String	getOptionName()
java.util.List<java.lang.String>	getPossibleValues() List is more convenient to work with
ValueConstrain	getValidValue()
int	hashCode()
void	setDefaultValue(java.lang.String defaultVal) Sets one of the values defined in optionList as default.
void	setOptionName(java.lang.String optionName)
void	setOptionNames(java.util.Set<java.lang.String> optionName)
void	setPossibleValues(java.util.Set<java.lang.String> possibleValues)
void	setValidValue(ValueConstrain validValue)
java.lang.String	toCommand(java.lang.String nameValueSeparator) Convert the option to the command string.
java.lang.String	toString()

Methods inherited from class compbio.metadata.Option

getDefaultValue, getDescription, getFurtherDetails, getName, getOptionNames, isRequired, setDescription, setFurtherDetails, setName, setRequired, setValue

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String description)

Method Detail

getValidValue

public ValueConstrain getValidValue()

setValidValue

public void setValidValue(ValueConstrain validValue)

toString

public java.lang.String toString()

Overrides:

toString in class Option<T>

toCommand

public java.lang.String toCommand(java.lang.String nameValueSeparator)

Description copied from class: Option

Convert the option to the command string.

Overrides:

toCommand in class Option<T>

Returns:

If only one optionName is defined, than it is returned, if many option names are defined, then the defaultValue is returned. Option must have a default value if there are many optionNames to be valid.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class Option<T>

getPossibleValues

public java.util.List<java.lang.String> getPossibleValues()

List is more convenient to work with

Specified by:

getPossibleValues in interface Argument<T>

Overrides:

getPossibleValues in class Option<T>

Returns:

List of String

setPossibleValues

public void setPossibleValues(java.util.Set<java.lang.String> possibleValues)

addPossibleValues

public java.util.Set<java.lang.String> addPossibleValues(java.lang.String... value)

hashCode

public int hashCode()

Overrides:

hashCode in class Option<T>

setOptionNames

public void setOptionNames(java.util.Set<java.lang.String> optionName)

Overrides:

setOptionNames in class Option<T>

addOptionNames

public java.util.Set<java.lang.String> addOptionNames(java.lang.String... value)

Description copied from class: Option

Adds an option to the optionName list

Overrides:

addOptionNames in class Option<T>

Returns:

modified optionName list

getOptionName

public java.lang.String getOptionName()

setOptionName

public void setOptionName(java.lang.String optionName)

setDefaultValue

public void setDefaultValue(java.lang.String defaultVal)
                     throws WrongParameterException

Description copied from class: Option

Sets one of the values defined in optionList as default. Attempting set the value not listed there will result in WrongParameter exception

Overrides:

setDefaultValue in class Option<T>

Throws:

WrongParameterException - is thrown if the defaultValue is not found in optionList