fr.igred.omero.screen

Interface Well

All Superinterfaces:

Annotatable, RemoteObject, RepositoryObject

All Known Implementing Classes:

WellWrapper

public interface Well
extends RepositoryObject, Annotatable

Interface to handle Wells on OMERO.

Method Summary

Modifier and Type	Method and Description
WellData	asDataObject() Returns a WellData corresponding to the handled object.
int	getAlpha() Returns the alpha component of the color associated to the well, or -1.
int	getBlue() Returns the blue component of the color associated to the well, or -1.
default List<RepositoryObject>	getChildren(Browser browser) Gets the object children.
Integer	getColumn() Returns the column used to indicate the location of the well on the grid.
int	getGreen() Returns the green component of the color associated to the well, or -1.
default List<Image>	getImages() Retrieves the images contained in this well.
default List<RepositoryObject>	getParents(Browser browser) Gets the object parents.
Plate	getPlate() Returns the plate containing this Well.
default List<PlateAcquisition>	getPlateAcquisitions(Browser browser) Refreshes this well and returns the plate acquisitions linked to it.
default List<Plate>	getPlates(Browser browser) Reloads this well and returns the plate containing it.
int	getRed() Returns the red component of the color associated to the well, or -1.
Integer	getRow() Returns the row used to indicate the location of the well on the grid.
default List<Screen>	getScreens(Browser browser) Refreshes this well and retrieves the screens containing it.
String	getStatus() Returns the status of the well.
List<WellSample>	getWellSamples() Returns the well samples linked to the well.
default List<WellSample>	getWellSamples(Browser browser) Reloads this well and returns the well samples contained within.
String	getWellType() Returns a human-readable identifier for the screening status e.g. empty, positive control, etc.
void	reload(Browser browser) Reloads the well from OMERO.
void	setAlpha(Integer alpha) Sets the alpha component of the color associated to the well.
void	setBlue(Integer blue) Sets the blue component of the color associated to the well.
void	setGreen(Integer green) Sets the green component of the color associated to the well.
void	setRed(Integer red) Sets the red component of the color associated to the well.
void	setStatus(String status) Sets the status of the well.
void	setWellType(String type) Sets a human-readable identifier for the screening status e.g. empty, positive control, etc.

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

WellData asDataObject()

Returns a WellData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

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.

getWellSamples

List<WellSample> getWellSamples()

Returns the well samples linked to the well.

Returns:

See above.

getWellSamples

default List<WellSample> getWellSamples(Browser browser)
                                 throws ServiceException,
                                        AccessException,
                                        ExecutionException

Reloads this well and returns the well samples contained within.

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

Refreshes this well and retrieves the screens containing 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.

getPlate

Plate getPlate()

Returns the plate containing this Well.

Returns:

See above.

getPlates

default List<Plate> getPlates(Browser browser)
                       throws ServiceException,
                              AccessException,
                              ExecutionException

Reloads this well and returns the plate containing 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.

getPlateAcquisitions

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

Refreshes this well and returns the plate acquisitions linked 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.

getImages

default List<Image> getImages()

Retrieves the images contained in this well.

Returns:

See above.

getColumn

Integer getColumn()

Returns the column used to indicate the location of the well on the grid.

Returns:

See above.

getRow

Integer getRow()

Returns the row used to indicate the location of the well on the grid.

Returns:

See above.

getStatus

String getStatus()

Returns the status of the well.

Returns:

See above.

setStatus

void setStatus(String status)

Sets the status of the well.

Parameters:

status - The status of the well.

getWellType

String getWellType()

Returns a human-readable identifier for the screening status e.g. empty, positive control, etc.

Returns:

See above.

setWellType

void setWellType(String type)

Sets a human-readable identifier for the screening status e.g. empty, positive control, etc.

Parameters:

type - The value to set.

getRed

int getRed()

Returns the red component of the color associated to the well, or -1.

Returns:

See above.

setRed

void setRed(Integer red)

Sets the red component of the color associated to the well.

Parameters:

red - The value to set.

getGreen

int getGreen()

Returns the green component of the color associated to the well, or -1.

Returns:

See above.

setGreen

void setGreen(Integer green)

Sets the green component of the color associated to the well.

Parameters:

green - The value to set.

getBlue

int getBlue()

Returns the blue component of the color associated to the well, or -1.

Returns:

See above.

setBlue

void setBlue(Integer blue)

Sets the blue component of the color associated to the well.

Parameters:

blue - The value to set.

getAlpha

int getAlpha()

Returns the alpha component of the color associated to the well, or -1.

Returns:

See above.

setAlpha

void setAlpha(Integer alpha)

Sets the alpha component of the color associated to the well.

Parameters:

alpha - The value to set.

reload

void reload(Browser browser)
     throws ServiceException,
            AccessException,
            ExecutionException

Reloads the well 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.