Package ome.xml.model

Class LightPath

    • Constructor Detail

      • LightPath

        public LightPath()
        Default constructor.
      • LightPath

        public LightPath​(Element element,
                         OMEModel model)
                  throws EnumerationException
        Constructs LightPath 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.
      • LightPath

        public LightPath​(LightPath orig)
        Copy constructor.
    • Method Detail

      • update

        public void update​(Element element,
                           OMEModel model)
                    throws EnumerationException
        Updates LightPath 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 AbstractOMEModelObject
        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 AbstractOMEModelObject
        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.
      • sizeOfLinkedExcitationFilterList

        public int sizeOfLinkedExcitationFilterList()
      • copyLinkedExcitationFilterList

        public List<Filter> copyLinkedExcitationFilterList()
      • getLinkedExcitationFilter

        public Filter getLinkedExcitationFilter​(int index)
      • setLinkedExcitationFilter

        public Filter setLinkedExcitationFilter​(int index,
                                                Filter o)
      • linkExcitationFilter

        public boolean linkExcitationFilter​(Filter o)
      • unlinkExcitationFilter

        public boolean unlinkExcitationFilter​(Filter o)
      • getLinkedDichroic

        public Dichroic getLinkedDichroic()
      • linkDichroic

        public void linkDichroic​(Dichroic o)
      • unlinkDichroic

        public void unlinkDichroic​(Dichroic o)
      • sizeOfLinkedEmissionFilterList

        public int sizeOfLinkedEmissionFilterList()
      • copyLinkedEmissionFilterList

        public List<Filter> copyLinkedEmissionFilterList()
      • getLinkedEmissionFilter

        public Filter getLinkedEmissionFilter​(int index)
      • setLinkedEmissionFilter

        public Filter setLinkedEmissionFilter​(int index,
                                              Filter o)
      • linkEmissionFilter

        public boolean linkEmissionFilter​(Filter o)
      • unlinkEmissionFilter

        public boolean unlinkEmissionFilter​(Filter o)
      • sizeOfLinkedAnnotationList

        public int sizeOfLinkedAnnotationList()
      • copyLinkedAnnotationList

        public List<Annotation> copyLinkedAnnotationList()
      • getLinkedAnnotation

        public Annotation getLinkedAnnotation​(int index)
      • linkAnnotation

        public boolean linkAnnotation​(Annotation o)
      • unlinkAnnotation

        public boolean unlinkAnnotation​(Annotation o)
      • asXMLElement

        public Element asXMLElement​(Document document,
                                    Element LightPath_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 AbstractOMEModelObject
        Parameters:
        document - Destination document for element creation, etc.
        LightPath_element - Element from the subclass. If null a new element will be created of this class.
        Returns:
        element populated with properties from this class.