Package ome.xml.model

Class ObjectiveSettings

java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.Reference
ome.xml.model.Settings
ome.xml.model.ObjectiveSettings
All Implemented Interfaces:
OMEModelObject
public class ObjectiveSettings
extends Settings

  • Field Details

  • Constructor Details

    • ObjectiveSettings

      public ObjectiveSettings()
      Default constructor.

    • ObjectiveSettings

      public ObjectiveSettings​(org.w3c.dom.Element element, OMEModel model) throws EnumerationException
      Constructs ObjectiveSettings 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.

    • ObjectiveSettings

      public ObjectiveSettings​(ObjectiveSettings orig)
      Copy constructor.

  • Method Details

    • update

      public void update​(org.w3c.dom.Element element, OMEModel model) throws EnumerationException
      Updates ObjectiveSettings 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 Settings
      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 Settings
      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()
      Description copied from class: Reference
      Retrieves the reference's target object ID.
      Specified by:
      getID in class Reference
      Returns:
      See above.

    • setID

      public void setID​(java.lang.String id)
      Description copied from class: Reference
      Sets the reference's target object ID.
      Specified by:
      setID in class Reference
      Parameters:
      id - The object ID to set.

    • getCorrectionCollar

      public java.lang.Double getCorrectionCollar()

    • setCorrectionCollar

      public void setCorrectionCollar​(java.lang.Double correctionCollar)

    • getMedium

      public Medium getMedium()

    • setMedium

      public void setMedium​(Medium medium)

    • getRefractiveIndex

      public java.lang.Double getRefractiveIndex()

    • setRefractiveIndex

      public void setRefractiveIndex​(java.lang.Double refractiveIndex)

    • getObjective

      public Objective getObjective()

    • setObjective

      public void setObjective​(Objective objective)

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