Package ome.xml.model

Class Objective

    • Constructor Detail

      • Objective

        public Objective()
        Default constructor.

      • Objective

        public Objective​(org.w3c.dom.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​(org.w3c.dom.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 interface OMEModelObject
        Overrides:
        update in class ManufacturerSpec
        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 ManufacturerSpec
        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.

      • getID

        public java.lang.String getID()

      • setID

        public void setID​(java.lang.String id)

      • getCorrection

        public Correction getCorrection()

      • setCorrection

        public void setCorrection​(Correction correction)

      • getImmersion

        public Immersion getImmersion()

      • setImmersion

        public void setImmersion​(Immersion immersion)

      • 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

        public Length getWorkingDistance()

      • setWorkingDistance

        public void setWorkingDistance​(Length workingDistance)

      • 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

        public java.util.List<Annotation> copyLinkedAnnotationList()

      • getLinkedAnnotation

        public Annotation getLinkedAnnotation​(int index)

      • 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 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
        Overrides:
        asXMLElement in class ManufacturerSpec
        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 class ManufacturerSpec
        Parameters:
        document - Destination document for element creation, etc.
        Objective_element - Element from the subclass. If null a new element will be created of this class.
        Returns:
        element populated with properties from this class.