Package ome.xml.model

Class ImagingEnvironment

java.lang.Object

ome.xml.model.AbstractOMEModelObject

ome.xml.model.ImagingEnvironment

All Implemented Interfaces:

OMEModelObject

public class ImagingEnvironment
extends AbstractOMEModelObject

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAMESPACE

Constructor Summary

Constructors

Constructor	Description
ImagingEnvironment()	Default constructor.
ImagingEnvironment(ImagingEnvironment orig)	Copy constructor.
ImagingEnvironment(org.w3c.dom.Element element, OMEModel model)	Constructs ImagingEnvironment recursively from an XML DOM tree.

Method Summary

Modifier and Type	Method	Description
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document)	Takes the entire object hierarchy and produces an XML DOM tree.
org.w3c.dom.Element	asXMLElement(org.w3c.dom.Document document, org.w3c.dom.Element ImagingEnvironment_element)	Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.
Pressure	getAirPressure()
static java.lang.String	getAirPressureUnitXsdDefault()
PercentFraction	getCO2Percent()
PercentFraction	getHumidity()
java.util.List<MapPair>	getMap()
Temperature	getTemperature()
static java.lang.String	getTemperatureUnitXsdDefault()
boolean	link(Reference reference, OMEModelObject o)	Link a given OME model object to this model object.
void	setAirPressure(Pressure airPressure)
void	setCO2Percent(PercentFraction co2Percent)
void	setHumidity(PercentFraction humidity)
void	setMap(java.util.List<MapPair> map)
void	setTemperature(Temperature temperature)
void	update(org.w3c.dom.Element element, OMEModel model)	Updates ImagingEnvironment recursively from an XML DOM tree.

Methods inherited from class ome.xml.model.AbstractOMEModelObject

getChildrenByTagName, stripNamespacePrefix

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

ImagingEnvironment

public ImagingEnvironment()

Default constructor.

ImagingEnvironment

public ImagingEnvironment(org.w3c.dom.Element element,
                          OMEModel model)
                   throws EnumerationException

Constructs ImagingEnvironment recursively from an XML DOM tree.

Parameters:

element - Root of the XML DOM tree to construct a model object graph from.

model - Handler for the OME model which keeps track of instances and references seen during object population.

Throws:

EnumerationException - If there is an error instantiating an enumeration during model object creation.

ImagingEnvironment

public ImagingEnvironment(ImagingEnvironment orig)

Copy constructor.

Method Detail

update

public void update(org.w3c.dom.Element element,
                   OMEModel model)
            throws EnumerationException

Updates ImagingEnvironment recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.

Specified by:

update in interface OMEModelObject

Overrides:

update in class AbstractOMEModelObject

Parameters:

element - Root of the XML DOM tree to construct a model object graph from.

model - Handler for the OME model which keeps track of instances and references seen during object population.

Throws:

EnumerationException - If there is an error instantiating an enumeration during model object creation.

link

public boolean link(Reference reference,
                    OMEModelObject o)

Description copied from interface: OMEModelObject

Link a given OME model object to this model object.

Specified by:

link in interface OMEModelObject

Overrides:

link in class AbstractOMEModelObject

Parameters:

reference - The type qualifier for the reference. This should be the corresponding reference type for o. If, for example, o is of type Image, reference MUST be of type ImageRef.

o - Model object to link to.

Returns:

true if this model object was able to handle the reference, false otherwise.

getTemperature

public Temperature getTemperature()

setTemperature

public void setTemperature(Temperature temperature)

getTemperatureUnitXsdDefault

public static java.lang.String getTemperatureUnitXsdDefault()

getAirPressure

public Pressure getAirPressure()

setAirPressure

public void setAirPressure(Pressure airPressure)

getAirPressureUnitXsdDefault

public static java.lang.String getAirPressureUnitXsdDefault()

getHumidity

public PercentFraction getHumidity()

setHumidity

public void setHumidity(PercentFraction humidity)

getCO2Percent

public PercentFraction getCO2Percent()

setCO2Percent

public void setCO2Percent(PercentFraction co2Percent)

getMap

public java.util.List<MapPair> getMap()

setMap

public void setMap(java.util.List<MapPair> map)

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document)

Description copied from interface: OMEModelObject

Takes the entire object hierarchy and produces an XML DOM tree.

Specified by:

asXMLElement in interface OMEModelObject

Specified by:

asXMLElement in class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

Returns:

XML DOM tree root element for this model object.

asXMLElement

public org.w3c.dom.Element asXMLElement(org.w3c.dom.Document document,
                                        org.w3c.dom.Element ImagingEnvironment_element)

Description copied from class: AbstractOMEModelObject

Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.

Overrides:

asXMLElement in class AbstractOMEModelObject

Parameters:

document - Destination document for element creation, etc.

ImagingEnvironment_element - Element from the subclass. If null a new element will be created of this class.

Returns:

element populated with properties from this class.