Package ome.xml.model
Class Objective
java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.ManufacturerSpec
ome.xml.model.Objective
- All Implemented Interfaces:
OMEModelObject
public class Objective extends ManufacturerSpec
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAMESPACE
-
Constructor Summary
-
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 Objective_element)
Takes the entire object hierarchy and produced an XML DOM tree taking into account class hierarchy.java.util.List<Annotation>
copyLinkedAnnotationList()
java.lang.Double
getCalibratedMagnification()
Correction
getCorrection()
java.lang.String
getID()
Immersion
getImmersion()
Instrument
getInstrument()
java.lang.Boolean
getIris()
java.lang.Double
getLensNA()
Annotation
getLinkedAnnotation(int index)
java.lang.Double
getNominalMagnification()
Length
getWorkingDistance()
static java.lang.String
getWorkingDistanceUnitXsdDefault()
boolean
link(Reference reference, OMEModelObject o)
Link a given OME model object to this model object.boolean
linkAnnotation(Annotation o)
void
setCalibratedMagnification(java.lang.Double calibratedMagnification)
void
setCorrection(Correction correction)
void
setID(java.lang.String id)
void
setImmersion(Immersion immersion)
void
setInstrument(Instrument instrument_BackReference)
void
setIris(java.lang.Boolean iris)
void
setLensNA(java.lang.Double lensNA)
Annotation
setLinkedAnnotation(int index, Annotation o)
void
setNominalMagnification(java.lang.Double nominalMagnification)
void
setWorkingDistance(Length workingDistance)
int
sizeOfLinkedAnnotationList()
boolean
unlinkAnnotation(Annotation o)
void
update(org.w3c.dom.Element element, OMEModel model)
Updates Objective recursively from an XML DOM tree.Methods inherited from class ome.xml.model.ManufacturerSpec
getLotNumber, getManufacturer, getModel, getSerialNumber, setLotNumber, setManufacturer, setModel, setSerialNumber
Methods inherited from class ome.xml.model.AbstractOMEModelObject
getChildrenByTagName, stripNamespacePrefix
-
Field Details
-
NAMESPACE
public static final java.lang.String NAMESPACE- See Also:
- Constant Field Values
-
-
Constructor Details
-
Objective
public Objective()Default constructor. -
Objective
Constructs Objective 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.
-
Objective
Copy constructor.
-
-
Method Details
-
update
Updates Objective recursively from an XML DOM tree. NOTE: No properties are removed, only added or updated.- Specified by:
update
in interfaceOMEModelObject
- Overrides:
update
in classManufacturerSpec
- 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
Description copied from interface:OMEModelObject
Link a given OME model object to this model object.- Specified by:
link
in interfaceOMEModelObject
- Overrides:
link
in classManufacturerSpec
- 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.
-
getID
public java.lang.String getID() -
setID
public void setID(java.lang.String id) -
getCorrection
-
setCorrection
-
getImmersion
-
setImmersion
-
getLensNA
public java.lang.Double getLensNA() -
setLensNA
public void setLensNA(java.lang.Double lensNA) -
getNominalMagnification
public java.lang.Double getNominalMagnification() -
setNominalMagnification
public void setNominalMagnification(java.lang.Double nominalMagnification) -
getCalibratedMagnification
public java.lang.Double getCalibratedMagnification() -
setCalibratedMagnification
public void setCalibratedMagnification(java.lang.Double calibratedMagnification) -
getWorkingDistance
-
setWorkingDistance
-
getWorkingDistanceUnitXsdDefault
public static java.lang.String getWorkingDistanceUnitXsdDefault() -
getIris
public java.lang.Boolean getIris() -
setIris
public void setIris(java.lang.Boolean iris) -
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList() -
copyLinkedAnnotationList
-
getLinkedAnnotation
-
setLinkedAnnotation
-
linkAnnotation
-
unlinkAnnotation
-
getInstrument
-
setInstrument
-
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 interfaceOMEModelObject
- Overrides:
asXMLElement
in classManufacturerSpec
- 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 Objective_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 classManufacturerSpec
- Parameters:
document
- Destination document for element creation, etc.Objective_element
- Element from the subclass. Ifnull
a new element will be created of this class.- Returns:
element
populated with properties from this class.
-