Class PlateWrapper

    • Field Detail

      • ANNOTATION_LINK

        public static final java.lang.String ANNOTATION_LINK
        Annotation link name for this type of object
        See Also:
        Constant Field Values
    • Constructor Detail

      • PlateWrapper

        public PlateWrapper​(PlateData plate)
        Constructor of the class PlateWrapper.
        Parameters:
        plate - The plate contained in the PlateWrapper.
    • Method Detail

      • setName

        public void setName​(java.lang.String name)
        Sets the name of the plate.
        Parameters:
        name - The name of the plate. Mustn't be null.
        Throws:
        java.lang.IllegalArgumentException - If the name is null.
      • setDescription

        public void setDescription​(java.lang.String description)
        Sets the description of the plate.
        Parameters:
        description - The description of the plate.
      • getPlateAcquisitions

        public java.util.List<PlateAcquisitionWrapper> getPlateAcquisitions()
        Returns the plate acquisitions related to this plate.
        Returns:
        See above.
      • getWells

        public java.util.List<WellWrapper> getWells​(Client client)
                                             throws ServiceException,
                                                    AccessException,
                                                    java.util.concurrent.ExecutionException
        Gets all wells in the plate available from OMERO.
        Parameters:
        client - The client handling the connection.
        Returns:
        See above.
        Throws:
        ServiceException - Cannot connect to OMERO.
        AccessException - Cannot access data.
        java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.
      • getImages

        public java.util.List<ImageWrapper> getImages​(Client client)
                                               throws ServiceException,
                                                      AccessException,
                                                      java.util.concurrent.ExecutionException
        Returns the images contained in the wells of this plate.
        Parameters:
        client - The client handling the connection.
        Returns:
        See above.
        Throws:
        ServiceException - Cannot connect to OMERO.
        AccessException - Cannot access data.
        java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.
      • getColumnSequenceIndex

        public int getColumnSequenceIndex()
        Returns the index indicating how to label a column.
        Returns:
        See above.
      • getRowSequenceIndex

        public int getRowSequenceIndex()
        Returns the index indicating how to label a row.
        Returns:
        See above.
      • getDefaultSample

        public int getDefaultSample()
        Returns the currently selected field or 0.
        Returns:
        See above.
      • setDefaultSample

        public void setDefaultSample​(int value)
        Sets the default sample.
        Parameters:
        value - The value to set.
      • getStatus

        public java.lang.String getStatus()
        Returns the status of the plate.
        Returns:
        See above.
      • setStatus

        public void setStatus​(java.lang.String value)
        Sets the status.
        Parameters:
        value - The value to set.
      • getExternalIdentifier

        public java.lang.String getExternalIdentifier()
        Returns the external identifier of the plate.
        Returns:
        See above.
      • setExternalIdentifier

        public void setExternalIdentifier​(java.lang.String value)
        Sets the external identifier.
        Parameters:
        value - The value to set.
      • getPlateType

        public java.lang.String getPlateType()
        Returns the type of plate e.g. A 384-Well Plate, 96-Well Plate.
        Returns:
        See above.
      • getWellOriginX

        public Length getWellOriginX​(omero.model.enums.UnitsLength unit)
                              throws BigResult
        Returns the x-coordinate in 2D-space of the well.
        Parameters:
        unit - The unit (can be null, in which case no conversion will be performed)
        Returns:
        See above
        Throws:
        BigResult - If an arithmetic under-/overflow occurred
      • getWellOriginY

        public Length getWellOriginY​(omero.model.enums.UnitsLength unit)
                              throws BigResult
        Returns the y-coordinate in 2D-space of the well.
        Parameters:
        unit - The unit (can be null, in which case no conversion will be performed)
        Returns:
        See above
        Throws:
        BigResult - If an arithmetic under-/overflow occurred
      • refresh

        public void refresh​(Client client)
                     throws ServiceException,
                            AccessException,
                            java.util.concurrent.ExecutionException
        Refreshes the plate.
        Parameters:
        client - The client handling the connection.
        Throws:
        ServiceException - Cannot connect to OMERO.
        AccessException - Cannot access data.
        java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.