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
-
-
Method Summary
-
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 Detail
-
NAMESPACE
public static final String NAMESPACE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Objective
public Objective()
Default constructor.
-
Objective
public Objective(Element element, OMEModel model) throws EnumerationException
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
public Objective(Objective orig)
Copy constructor.
-
-
Method Detail
-
update
public void update(Element element, OMEModel model) throws EnumerationException
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
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 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 String getID()
-
setID
public void setID(String id)
-
getCorrection
public Correction getCorrection()
-
setCorrection
public void setCorrection(Correction correction)
-
getImmersion
public Immersion getImmersion()
-
setImmersion
public void setImmersion(Immersion immersion)
-
getLensNA
public Double getLensNA()
-
setLensNA
public void setLensNA(Double lensNA)
-
getNominalMagnification
public Double getNominalMagnification()
-
setNominalMagnification
public void setNominalMagnification(Double nominalMagnification)
-
getCalibratedMagnification
public Double getCalibratedMagnification()
-
setCalibratedMagnification
public void setCalibratedMagnification(Double calibratedMagnification)
-
getWorkingDistance
public Length getWorkingDistance()
-
setWorkingDistance
public void setWorkingDistance(Length workingDistance)
-
getWorkingDistanceUnitXsdDefault
public static String getWorkingDistanceUnitXsdDefault()
-
getIris
public Boolean getIris()
-
setIris
public void setIris(Boolean iris)
-
sizeOfLinkedAnnotationList
public int sizeOfLinkedAnnotationList()
-
copyLinkedAnnotationList
public List<Annotation> copyLinkedAnnotationList()
-
getLinkedAnnotation
public Annotation getLinkedAnnotation(int index)
-
setLinkedAnnotation
public Annotation setLinkedAnnotation(int index, Annotation o)
-
linkAnnotation
public boolean linkAnnotation(Annotation o)
-
unlinkAnnotation
public boolean unlinkAnnotation(Annotation o)
-
getInstrument
public Instrument getInstrument()
-
setInstrument
public void setInstrument(Instrument instrument_BackReference)
-
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
- Overrides:
asXMLElement
in classManufacturerSpec
- 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 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.
-
-