fr.igred.omero.screen

Interface Plate

All Superinterfaces:

Annotatable, RemoteObject, RepositoryObject

All Known Implementing Classes:

PlateWrapper

public interface Plate
extends RepositoryObject, Annotatable

Interface to handle Plates on OMERO.

Method Summary

Modifier and Type	Method and Description
PlateData	asDataObject() Returns an PlateData corresponding to the handled object.
default List<RepositoryObject>	getChildren(Browser browser) Gets the object children.
int	getColumnSequenceIndex() Returns the index indicating how to label a column.
int	getDefaultSample() Returns the currently selected field or 0.
String	getExternalIdentifier() Returns the external identifier of the plate.
default List<Image>	getImages(Browser browser) Returns the images contained in the wells of this plate.
default List<RepositoryObject>	getParents(Browser browser) Gets the object parents.
List<PlateAcquisition>	getPlateAcquisitions() Returns the plate acquisitions related to this plate.
default List<PlateAcquisition>	getPlateAcquisitions(Browser browser) Reloads the plate and returns the plate acquisitions related to it.
String	getPlateType() Returns the type of plate e.g.
int	getRowSequenceIndex() Returns the index indicating how to label a row.
default List<Screen>	getScreens(Browser browser) Retrieves the screens containing this plate.
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.
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(String description) Sets the description of the plate.
void	setExternalIdentifier(String value) Sets the external identifier.
void	setName(String name) Sets the name of the plate.
void	setStatus(String value) Sets the status.

Methods inherited from interface fr.igred.omero.RepositoryObject

getDescription, getName

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, link, linkIfNotLinked, rate, unlink

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, distinct, flatten, getCreated, getElementsOf, getGroupId, getId, getOwner, getUpdated, saveAndUpdate

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(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.

setDescription

void setDescription(String description)

Sets the description of the plate.

Parameters:

description - The description of the plate.

getParents

default List<RepositoryObject> getParents(Browser browser)
                                   throws AccessException,
                                          ServiceException,
                                          ExecutionException

Gets the object parents.

Specified by:

getParents in interface RepositoryObject

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getChildren

default List<RepositoryObject> getChildren(Browser browser)
                                    throws AccessException,
                                           ServiceException,
                                           ExecutionException

Gets the object children.

Specified by:

getChildren in interface RepositoryObject

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getScreens

default List<Screen> getScreens(Browser browser)
                         throws ServiceException,
                                AccessException,
                                ExecutionException

Retrieves the screens containing this plate.

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getPlateAcquisitions

List<PlateAcquisition> getPlateAcquisitions()

Returns the plate acquisitions related to this plate.

Returns:

See above.

getPlateAcquisitions

default List<PlateAcquisition> getPlateAcquisitions(Browser browser)
                                             throws AccessException,
                                                    ServiceException,
                                                    ExecutionException

Reloads the plate and returns the plate acquisitions related to it.

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getWells

List<Well> getWells(Browser browser)
             throws ServiceException,
                    AccessException,
                    ExecutionException

Gets all wells in the plate available from OMERO.

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

getImages

default List<Image> getImages(Browser browser)
                       throws ServiceException,
                              AccessException,
                              ExecutionException

Returns the images contained in the wells of this plate.

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

String getStatus()

Returns the status of the plate.

Returns:

See above.

setStatus

void setStatus(String value)

Sets the status.

Parameters:

value - The value to set.

getExternalIdentifier

String getExternalIdentifier()

Returns the external identifier of the plate.

Returns:

See above.

setExternalIdentifier

void setExternalIdentifier(String value)

Sets the external identifier.

Parameters:

value - The value to set.

getPlateType

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,
            ExecutionException

Reloads the plate from OMERO.

Specified by:

reload in interface RepositoryObject

Parameters:

browser - The data browser.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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