Package ome.xml.model

Class LightSource

java.lang.Object
ome.xml.model.AbstractOMEModelObject
ome.xml.model.ManufacturerSpec
ome.xml.model.LightSource
All Implemented Interfaces:
OMEModelObject
Direct Known Subclasses:
Arc, Filament, GenericExcitationSource, Laser, LightEmittingDiode
public abstract class LightSource
extends ManufacturerSpec

  • Field Details

  • Constructor Details

    • LightSource

      public LightSource()
      Default constructor.

    • LightSource

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

    • LightSource

      public LightSource​(LightSource orig)
      Copy constructor.

  • Method Details

    • update

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

    • getPower

      public Power getPower()

    • setPower

      public void setPower​(Power power)

    • getPowerUnitXsdDefault

      public static java.lang.String getPowerUnitXsdDefault()

    • sizeOfLinkedAnnotationList

      public int sizeOfLinkedAnnotationList()

    • copyLinkedAnnotationList

      public java.util.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 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 LightSource_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.
      LightSource_element - Element from the subclass. If null a new element will be created of this class.
      Returns:
      element populated with properties from this class.