Package fr.igred.omero.repository

Class PlateWrapper

java.lang.Object
fr.igred.omero.GenericObjectWrapper<T>
fr.igred.omero.AnnotatableWrapper<T>
fr.igred.omero.repository.GenericRepositoryObjectWrapper<PlateData>
fr.igred.omero.repository.PlateWrapper
public class PlateWrapper extends GenericRepositoryObjectWrapper<PlateData>
Class containing a PlateData object.

Wraps function calls to the PlateData contained.

  • Field Details

  • Constructor Details

    • PlateWrapper

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

  • Method Details

    • annotationLinkType

      protected String annotationLinkType()
      Returns the type of annotation link for this object.
      Specified by:
      annotationLinkType in class AnnotatableWrapper<PlateData>
      Returns:
      See above.

    • getName

      public String getName()
      Gets the plate name.
      Specified by:
      getName in class GenericRepositoryObjectWrapper<PlateData>
      Returns:
      See above.

    • setName

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

    • asPlateData

      @Deprecated public PlateData asPlateData()
      Deprecated.
      Returns the PlateData contained. Use GenericObjectWrapper.asDataObject() instead.
      Returns:
      See above.

    • getDescription

      public String getDescription()
      Gets the plate description
      Specified by:
      getDescription in class GenericRepositoryObjectWrapper<PlateData>
      Returns:
      See above.

    • setDescription

      public void setDescription(String description)
      Sets the description of the plate.
      Parameters:
      description - The description of the plate.

    • getScreens

      public List<ScreenWrapper> getScreens(Client client) throws OMEROServerError, ServiceException, AccessException, ExecutionException
      Retrieves the screens containing this plate.
      Parameters:
      client - The client handling the connection.
      Returns:
      See above.
      Throws:
      OMEROServerError - Server error.
      ServiceException - Cannot connect to OMERO.
      AccessException - Cannot access data.
      ExecutionException - A Facility can't be retrieved or instantiated.

    • getPlateAcquisitions

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

    • getWells

      public List<WellWrapper> getWells(Client client) throws ServiceException, AccessException, 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.
      ExecutionException - A Facility can't be retrieved or instantiated.

    • getImages

      public List<ImageWrapper> getImages(Client client) throws ServiceException, AccessException, 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.
      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 String getStatus()
      Returns the status of the plate.
      Returns:
      See above.

    • setStatus

      public void setStatus(String value)
      Sets the status.
      Parameters:
      value - The value to set.

    • getExternalIdentifier

      public String getExternalIdentifier()
      Returns the external identifier of the plate.
      Returns:
      See above.

    • setExternalIdentifier

      public void setExternalIdentifier(String value)
      Sets the external identifier.
      Parameters:
      value - The value to set.

    • getPlateType

      public 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

    • reload

      public void reload(Browser browser) throws ServiceException, AccessException, ExecutionException
      Reloads the plate from OMERO.
      Overrides:
      reload in class GenericRepositoryObjectWrapper<PlateData>
      Parameters:
      browser - The client handling the connection.
      Throws:
      ServiceException - Cannot connect to OMERO.
      AccessException - Cannot access data.
      ExecutionException - A Facility can't be retrieved or instantiated.