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
-
-
Constructor Summary
Constructors Constructor Description ImagingEnvironment()
Default constructor.ImagingEnvironment(ImagingEnvironment orig)
Copy constructor.ImagingEnvironment(Element element, OMEModel model)
Constructs ImagingEnvironment recursively from an XML DOM tree.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Element
asXMLElement(Document document)
Takes the entire object hierarchy and produces an XML DOM tree.Element
asXMLElement(Document document, Element ImagingEnvironment_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.Pressure
getAirPressure()
static String
getAirPressureUnitXsdDefault()
PercentFraction
getCO2Percent()
PercentFraction
getHumidity()
List<MapPair>
getMap()
Temperature
getTemperature()
static 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(List<MapPair> map)
void
setTemperature(Temperature temperature)
void
update(Element element, OMEModel model)
Updates ImagingEnvironment recursively from an XML DOM tree.-
Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
-
-
-
Field Detail
-
NAMESPACE
public static final String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ImagingEnvironment
public ImagingEnvironment()
Default constructor.
-
ImagingEnvironment
public ImagingEnvironment(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(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 interfaceOMEModelObject
- Overrides:
update
in classAbstractOMEModelObject
- 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 interfaceOMEModelObject
- Overrides:
link
in classAbstractOMEModelObject
- Parameters:
reference
- The type qualifier for the reference. This should be the corresponding reference type foro
. If, for example,o
is of typeImage
,reference
MUST be of typeImageRef
.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 String getTemperatureUnitXsdDefault()
-
getAirPressure
public Pressure getAirPressure()
-
setAirPressure
public void setAirPressure(Pressure airPressure)
-
getAirPressureUnitXsdDefault
public static String getAirPressureUnitXsdDefault()
-
getHumidity
public PercentFraction getHumidity()
-
setHumidity
public void setHumidity(PercentFraction humidity)
-
getCO2Percent
public PercentFraction getCO2Percent()
-
setCO2Percent
public void setCO2Percent(PercentFraction co2Percent)
-
asXMLElement
public Element asXMLElement(Document document)
Description copied from interface:OMEModelObject
Takes the entire object hierarchy and produces an XML DOM tree.- Specified by:
asXMLElement
in interfaceOMEModelObject
- Specified by:
asXMLElement
in classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.- Returns:
- XML DOM tree root element for this model object.
-
asXMLElement
public Element asXMLElement(Document document, 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 classAbstractOMEModelObject
- Parameters:
document
- Destination document for element creation, etc.ImagingEnvironment_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-
-