Package ome.xml.model

Class Plate

    • Constructor Detail

      • Plate

        public Plate()
        Default constructor.

      • Plate

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

      • Plate

        public Plate​(Plate orig)
        Copy constructor.

    • Method Detail

      • update

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

      • getName

        public java.lang.String getName()

      • setName

        public void setName​(java.lang.String name)

      • getStatus

        public java.lang.String getStatus()

      • setStatus

        public void setStatus​(java.lang.String status)

      • getExternalIdentifier

        public java.lang.String getExternalIdentifier()

      • setExternalIdentifier

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

      • getColumnNamingConvention

        public NamingConvention getColumnNamingConvention()

      • setColumnNamingConvention

        public void setColumnNamingConvention​(NamingConvention columnNamingConvention)

      • setRowNamingConvention

        public void setRowNamingConvention​(NamingConvention rowNamingConvention)

      • getWellOriginX

        public Length getWellOriginX()

      • setWellOriginX

        public void setWellOriginX​(Length wellOriginX)

      • getWellOriginXUnitXsdDefault

        public static java.lang.String getWellOriginXUnitXsdDefault()

      • getWellOriginY

        public Length getWellOriginY()

      • setWellOriginY

        public void setWellOriginY​(Length wellOriginY)

      • getWellOriginYUnitXsdDefault

        public static java.lang.String getWellOriginYUnitXsdDefault()

      • getDescription

        public java.lang.String getDescription()

      • setDescription

        public void setDescription​(java.lang.String description)

      • sizeOfWellList

        public int sizeOfWellList()

      • copyWellList

        public java.util.List<Well> copyWellList()

      • getWell

        public Well getWell​(int index)

      • setWell

        public Well setWell​(int index,
                    Well well)

      • addWell

        public void addWell​(Well well)

      • removeWell

        public void removeWell​(Well well)

      • 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)

      • sizeOfPlateAcquisitionList

        public int sizeOfPlateAcquisitionList()

      • copyPlateAcquisitionList

        public java.util.List<PlateAcquisition> copyPlateAcquisitionList()

      • getPlateAcquisition

        public PlateAcquisition getPlateAcquisition​(int index)

      • addPlateAcquisition

        public void addPlateAcquisition​(PlateAcquisition plateAcquisition)

      • removePlateAcquisition

        public void removePlateAcquisition​(PlateAcquisition plateAcquisition)

      • sizeOfLinkedScreenList

        public int sizeOfLinkedScreenList()

      • copyLinkedScreenList

        public java.util.List<Screen> copyLinkedScreenList()

      • getLinkedScreen

        public Screen getLinkedScreen​(int index)

      • setLinkedScreen

        public Screen setLinkedScreen​(int index,
                              Screen o)

      • linkScreen

        public boolean linkScreen​(Screen o)

      • unlinkScreen

        public boolean unlinkScreen​(Screen o)

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