Package ome.xml.model

Class Plate

    • Constructor Detail

      • Plate

        public Plate()
        Default constructor.
      • Plate

        public Plate​(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​(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 String getID()
      • setID

        public void setID​(String id)
      • getName

        public String getName()
      • setName

        public void setName​(String name)
      • getStatus

        public String getStatus()
      • setStatus

        public void setStatus​(String status)
      • getExternalIdentifier

        public String getExternalIdentifier()
      • setExternalIdentifier

        public void setExternalIdentifier​(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 String getWellOriginXUnitXsdDefault()
      • getWellOriginY

        public Length getWellOriginY()
      • setWellOriginY

        public void setWellOriginY​(Length wellOriginY)
      • getWellOriginYUnitXsdDefault

        public static String getWellOriginYUnitXsdDefault()
      • getDescription

        public String getDescription()
      • setDescription

        public void setDescription​(String description)
      • sizeOfWellList

        public int sizeOfWellList()
      • copyWellList

        public List<Well> copyWellList()
      • clearWellList

        public void clearWellList()
      • 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 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()
      • clearPlateAcquisitionList

        public void clearPlateAcquisitionList()
      • getPlateAcquisition

        public PlateAcquisition getPlateAcquisition​(int index)
      • addPlateAcquisition

        public void addPlateAcquisition​(PlateAcquisition plateAcquisition)
      • removePlateAcquisition

        public void removePlateAcquisition​(PlateAcquisition plateAcquisition)
      • sizeOfLinkedScreenList

        public int sizeOfLinkedScreenList()
      • copyLinkedScreenList

        public 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 Element asXMLElement​(Document document,
                                    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.