Package psidev.psi.mi.jami.xml.model.extension.xml300

Class XmlVariableParameter

java.lang.Object

psidev.psi.mi.jami.xml.model.extension.xml300.XmlVariableParameter

All Implemented Interfaces:

com.sun.xml.bind.Locatable, FileSourceContext, VariableParameter

public class XmlVariableParameter
extends Object
implements VariableParameter, FileSourceContext, com.sun.xml.bind.Locatable

XML 3.0 implementation of variable parameter

Since:

30/05/14

Version:

$Id$

Author:

Marine Dumousseau (marine@ebi.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlVariableParameter.JAXBVariableValueWrapper

Constructor Summary

Constructors

Constructor	Description
XmlVariableParameter()	Constructor for XmlVariableParameter.
XmlVariableParameter(String description)	Constructor for XmlVariableParameter.
XmlVariableParameter(String description, CvTerm unit)	Constructor for XmlVariableParameter.
XmlVariableParameter(String description, Experiment experiment)	Constructor for XmlVariableParameter.
XmlVariableParameter(String description, Experiment experiment, CvTerm unit)	Constructor for XmlVariableParameter.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDescription()	Getter for the field description.
Experiment	getExperiment()	Getter for the field experiment.
FileSourceLocator	getSourceLocator()	Getter for the field sourceLocator.
CvTerm	getUnit()	Getter for the field unit.
Collection<VariableParameterValue>	getVariableValues()	getVariableValues.
int	hashCode()
protected void	initialiseVatiableParameterValues()	initialiseVatiableParameterValues.
void	setDescription(String description)	Sets the short description of this parameter.
void	setExperiment(Experiment experiment)	Sets the experiment for this variableParameter
void	setExperimentAndAddVariableParameter(Experiment experiment)	Sets the experiment for this variableParameter and add this variableParameter to the list of variableParameters of this experiment.
void	setJAXBDescription(String desc)	setJAXBDescription.
void	setJAXBUnit(XmlCvTerm unit)	setJAXBUnit.
void	setJAXBVariableParameterValuesWrapper(XmlVariableParameter.JAXBVariableValueWrapper jaxbVariableValueList)	setJAXBVariableParameterValuesWrapper.
void	setSourceLocation(PsiXmlLocator sourceLocator)	setSourceLocation.
void	setSourceLocator(FileSourceLocator sourceLocator)	Sets the source locator
void	setUnit(CvTerm unit)	Sets the unit of this variableParameter.
Locator	sourceLocation()
String	toString()	toString

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlVariableParameter

public XmlVariableParameter()

Constructor for XmlVariableParameter.

XmlVariableParameter

public XmlVariableParameter(String description)

Constructor for XmlVariableParameter.

Parameters:

description - a String object.

XmlVariableParameter

public XmlVariableParameter(String description,
                            Experiment experiment)

Constructor for XmlVariableParameter.

Parameters:

description - a String object.

experiment - a Experiment object.

XmlVariableParameter

public XmlVariableParameter(String description,
                            CvTerm unit)

Constructor for XmlVariableParameter.

Parameters:

description - a String object.

unit - a CvTerm object.

XmlVariableParameter

public XmlVariableParameter(String description,
                            Experiment experiment,
                            CvTerm unit)

Constructor for XmlVariableParameter.

Parameters:

description - a String object.

experiment - a Experiment object.

unit - a CvTerm object.

Method Detail

initialiseVatiableParameterValues

protected void initialiseVatiableParameterValues()

initialiseVatiableParameterValues.

getDescription

public String getDescription()

Getter for the field description.

Specified by:

getDescription in interface VariableParameter

Returns:

a String object.

setDescription

public void setDescription(String description)

Sets the short description of this parameter.

Specified by:

setDescription in interface VariableParameter

Parameters:

description - : description

getUnit

public CvTerm getUnit()

Getter for the field unit.

Specified by:

getUnit in interface VariableParameter

Returns:

a CvTerm object.

setUnit

public void setUnit(CvTerm unit)

Sets the unit of this variableParameter.

Specified by:

setUnit in interface VariableParameter

Parameters:

unit - : unit

getVariableValues

public Collection<VariableParameterValue> getVariableValues()

getVariableValues.

Specified by:

getVariableValues in interface VariableParameter

Returns:

a Collection object.

getExperiment

public Experiment getExperiment()

Getter for the field experiment.

Specified by:

getExperiment in interface VariableParameter

Returns:

a Experiment object.

setExperiment

public void setExperiment(Experiment experiment)

Sets the experiment for this variableParameter

Specified by:

setExperiment in interface VariableParameter

Parameters:

experiment - : experiment to set

setExperimentAndAddVariableParameter

public void setExperimentAndAddVariableParameter(Experiment experiment)

Sets the experiment for this variableParameter and add this variableParameter to the list of variableParameters of this experiment. If experiment is null, remove the variableParameter from the previous experiment attached to this variableParameter

Specified by:

setExperimentAndAddVariableParameter in interface VariableParameter

Parameters:

experiment - : experiment to set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

sourceLocation

public Locator sourceLocation()

Specified by:

sourceLocation in interface com.sun.xml.bind.Locatable

getSourceLocator

public FileSourceLocator getSourceLocator()

Getter for the field sourceLocator.

Specified by:

getSourceLocator in interface FileSourceContext

Returns:

a FileSourceLocator object.

setSourceLocator

public void setSourceLocator(FileSourceLocator sourceLocator)

Sets the source locator

Specified by:

setSourceLocator in interface FileSourceContext

Parameters:

sourceLocator - : the file locator

setSourceLocation

public void setSourceLocation(PsiXmlLocator sourceLocator)

setSourceLocation.

Parameters:

sourceLocator - a PsiXmlLocator object.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

toString

Specified by:

toString in interface FileSourceContext

Overrides:

toString in class Object

Returns:

the file source context as a String. If the source locator is not null, it should give the source locator properties

setJAXBDescription

public void setJAXBDescription(String desc)

setJAXBDescription.

Parameters:

desc - a String object.

setJAXBUnit

public void setJAXBUnit(XmlCvTerm unit)

setJAXBUnit.

Parameters:

unit - a XmlCvTerm object.

setJAXBVariableParameterValuesWrapper

public void setJAXBVariableParameterValuesWrapper(XmlVariableParameter.JAXBVariableValueWrapper jaxbVariableValueList)

setJAXBVariableParameterValuesWrapper.

Parameters:

jaxbVariableValueList - a XmlVariableParameter.JAXBVariableValueWrapper object.