Package ome.xml.model

Class FilterSet

    • Constructor Detail

      • FilterSet

        public FilterSet()
        Default constructor.
      • FilterSet

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

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

      • update

        public void update​(Element element,
                           OMEModel model)
                    throws EnumerationException
        Updates FilterSet 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 String getID()
      • setID

        public void setID​(String id)
      • 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)
      • sizeOfLinkedChannelList

        public int sizeOfLinkedChannelList()
      • copyLinkedChannelList

        public List<Channel> copyLinkedChannelList()
      • getLinkedChannel

        public Channel getLinkedChannel​(int index)
      • setLinkedChannel

        public Channel setLinkedChannel​(int index,
                                        Channel o)
      • linkChannel

        public boolean linkChannel​(Channel o)
      • unlinkChannel

        public boolean unlinkChannel​(Channel o)
      • getInstrument

        public Instrument getInstrument()
      • setInstrument

        public void setInstrument​(Instrument instrument_BackReference)
      • asXMLElement

        public Element asXMLElement​(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 Element asXMLElement​(Document document,
                                    Element FilterSet_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.
        FilterSet_element - Element from the subclass. If null a new element will be created of this class.
        Returns:
        element populated with properties from this class.