Package ome.xml.model

Class Well

    • Constructor Detail

      • Well

        public Well()
        Default constructor.

      • Well

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

      • Well

        public Well​(Well orig)
        Copy constructor.

    • Method Detail

      • update

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

      • getID

        public java.lang.String getID()

      • setID

        public void setID​(java.lang.String id)

      • getExternalDescription

        public java.lang.String getExternalDescription()

      • setExternalDescription

        public void setExternalDescription​(java.lang.String externalDescription)

      • getExternalIdentifier

        public java.lang.String getExternalIdentifier()

      • setExternalIdentifier

        public void setExternalIdentifier​(java.lang.String externalIdentifier)

      • getType

        public java.lang.String getType()

      • setType

        public void setType​(java.lang.String type)

      • getColor

        public Color getColor()

      • setColor

        public void setColor​(Color color)

      • sizeOfWellSampleList

        public int sizeOfWellSampleList()

      • copyWellSampleList

        public java.util.List<WellSample> copyWellSampleList()

      • getWellSample

        public WellSample getWellSample​(int index)

      • addWellSample

        public void addWellSample​(WellSample wellSample)

      • removeWellSample

        public void removeWellSample​(WellSample wellSample)

      • getLinkedReagent

        public Reagent getLinkedReagent()

      • linkReagent

        public void linkReagent​(Reagent o)

      • unlinkReagent

        public void unlinkReagent​(Reagent o)

      • sizeOfLinkedAnnotationList

        public int sizeOfLinkedAnnotationList()

      • copyLinkedAnnotationList

        public java.util.List<Annotation> copyLinkedAnnotationList()

      • getLinkedAnnotation

        public Annotation getLinkedAnnotation​(int index)

      • linkAnnotation

        public boolean linkAnnotation​(Annotation o)

      • unlinkAnnotation

        public boolean unlinkAnnotation​(Annotation o)

      • getPlate

        public Plate getPlate()

      • setPlate

        public void setPlate​(Plate plate_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
        Specified by:
        asXMLElement in class AbstractOMEModelObject
        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 Well_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.
        Well_element - Element from the subclass. If null a new element will be created of this class.
        Returns:
        element populated with properties from this class.