Package fr.igred.omero.screen

Interface Plate

All Superinterfaces:

Annotatable, HCSLinked, ImageLinked, RemoteObject, RepositoryObject

All Known Implementing Classes:

PlateWrapper

public interface Plate
extends RepositoryObject, HCSLinked

Interface to handle Plates on OMERO.

Method Summary

Modifier and Type	Method	Description
PlateData	asDataObject()	Returns an PlateData corresponding to the handled object.
int	getColumnSequenceIndex()	Returns the index indicating how to label a column.
int	getDefaultSample()	Returns the currently selected field or 0.
java.lang.String	getExternalIdentifier()	Returns the external identifier of the plate.
default java.util.List<Image>	getImages(Browser browser)	Returns the images contained in the wells of this plate.
java.util.List<PlateAcquisition>	getPlateAcquisitions()	Returns the plate acquisitions related to this plate.
default java.util.List<PlateAcquisition>	getPlateAcquisitions(Browser browser)	Reloads this plate and returns the related plate acquisitions.
default java.util.List<Plate>	getPlates(Browser browser)	Reloads and returns this plate as a singleton list.
java.lang.String	getPlateType()	Returns the type of plate e.g.
int	getRowSequenceIndex()	Returns the index indicating how to label a row.
default java.util.List<Screen>	getScreens(Browser browser)	Retrieves the screens containing this plate.
java.lang.String	getStatus()	Returns the status of the plate.
Length	getWellOriginX(omero.model.enums.UnitsLength unit)	Returns the x-coordinate in 2D-space of the well.
Length	getWellOriginY(omero.model.enums.UnitsLength unit)	Returns the y-coordinate in 2D-space of the well.
java.util.List<Well>	getWells(Browser browser)	Gets all wells in the plate available from OMERO.
void	reload(Browser browser)	Reloads the plate from OMERO.
void	setDefaultSample(int value)	Sets the default sample.
void	setDescription(java.lang.String description)	Sets the description of the plate.
void	setExternalIdentifier(java.lang.String value)	Sets the external identifier.
void	setName(java.lang.String name)	Sets the name of the plate.
void	setStatus(java.lang.String value)	Sets the status.

Methods inherited from interface fr.igred.omero.Annotatable

addAndReplaceFile, addAndReplaceFile, addAndReplaceTable, addAndReplaceTable, addFile, addKeyValuePair, addTable, addTag, addTag, addTags, copyAnnotationLinks, getAnnotationData, getAnnotations, getFileAnnotations, getKeyValuePairs, getMapAnnotations, getMyRating, getTable, getTables, getTags, getValues, isLinked, link, link, linkIfNotLinked, rate, unlink

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, saveAndUpdate

Methods inherited from interface fr.igred.omero.RepositoryObject

getDescription, getName

Method Detail

asDataObject

PlateData asDataObject()

Returns an PlateData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

setName

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

void setDescription(java.lang.String description)

Sets the description of the plate.

Parameters:

description - The description of the plate.

getScreens

default java.util.List<Screen> getScreens(Browser browser)
                                   throws ServerException,
                                          ServiceException,
                                          AccessException,
                                          java.util.concurrent.ExecutionException

Retrieves the screens containing this plate.

Specified by:

getScreens in interface HCSLinked

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServerException - Server error.

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.

getPlates

default java.util.List<Plate> getPlates(Browser browser)
                                 throws ServiceException,
                                        AccessException,
                                        java.util.concurrent.ExecutionException

Reloads and returns this plate as a singleton list.

Specified by:

getPlates in interface HCSLinked

Parameters:

browser - The data browser.

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.

getPlateAcquisitions

default java.util.List<PlateAcquisition> getPlateAcquisitions(Browser browser)
                                                       throws ServiceException,
                                                              AccessException,
                                                              java.util.concurrent.ExecutionException

Reloads this plate and returns the related plate acquisitions.

Specified by:

getPlateAcquisitions in interface HCSLinked

Parameters:

browser - The data browser.

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.

getPlateAcquisitions

java.util.List<PlateAcquisition> getPlateAcquisitions()

Returns the plate acquisitions related to this plate.

Returns:

See above.

getWells

java.util.List<Well> getWells(Browser browser)
                       throws ServiceException,
                              AccessException,
                              java.util.concurrent.ExecutionException

Gets all wells in the plate available from OMERO.

Specified by:

getWells in interface HCSLinked

Parameters:

browser - The data browser.

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

default java.util.List<Image> getImages(Browser browser)
                                 throws ServiceException,
                                        AccessException,
                                        java.util.concurrent.ExecutionException

Returns the images contained in the wells of this plate.

Specified by:

getImages in interface ImageLinked

Parameters:

browser - The data browser.

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

int getColumnSequenceIndex()

Returns the index indicating how to label a column.

Returns:

See above.

getRowSequenceIndex

int getRowSequenceIndex()

Returns the index indicating how to label a row.

Returns:

See above.

getDefaultSample

int getDefaultSample()

Returns the currently selected field or 0.

Returns:

See above.

setDefaultSample

void setDefaultSample(int value)

Sets the default sample.

Parameters:

value - The value to set.

getStatus

java.lang.String getStatus()

Returns the status of the plate.

Returns:

See above.

setStatus

void setStatus(java.lang.String value)

Sets the status.

Parameters:

value - The value to set.

getExternalIdentifier

java.lang.String getExternalIdentifier()

Returns the external identifier of the plate.

Returns:

See above.

setExternalIdentifier

void setExternalIdentifier(java.lang.String value)

Sets the external identifier.

Parameters:

value - The value to set.

getPlateType

java.lang.String getPlateType()

Returns the type of plate e.g. A 384-Well Plate, 96-Well Plate.

Returns:

See above.

getWellOriginX

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

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

void reload(Browser browser)
     throws ServiceException,
            AccessException,
            java.util.concurrent.ExecutionException

Reloads the plate from OMERO.

Parameters:

browser - The data browser.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

java.util.concurrent.ExecutionException - A Facility can't be retrieved or instantiated.