Package ome.xml.model

Class Microscope

java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.ManufacturerSpec
ome.xml.model.Microscope
All Implemented Interfaces:
OMEModelObject
public class Microscope
extends ManufacturerSpec

  • Field Details

  • Constructor Details

    • Microscope

      public Microscope()
      Default constructor.

    • Microscope

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

    • Microscope

      public Microscope​(Microscope orig)
      Copy constructor.

  • Method Details

    • update

      public void update​(org.w3c.dom.Element element, OMEModel model) throws EnumerationException
      Updates Microscope 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.

    • getType

      public MicroscopeType getType()

    • setType

      public void setType​(MicroscopeType type)

    • 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 Microscope_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.
      Microscope_element - Element from the subclass. If null a new element will be created of this class.
      Returns:
      element populated with properties from this class.