fr.igred.omero.screen

Interface WellSample

All Superinterfaces:

RemoteObject, RepositoryObject

All Known Implementing Classes:

WellSampleWrapper

public interface WellSample
extends RepositoryObject

Interface to handle Well Samples on OMERO.

Method Summary

Modifier and Type	Method and Description
WellSampleData	asDataObject() Returns an WellSampleData corresponding to the handled object.
default List<RepositoryObject>	getChildren(Browser browser) Gets the object children.
Image	getImage() Returns the image related to that sample if any.
default List<RepositoryObject>	getParents(Browser browser) Gets the object parents.
PlateAcquisition	getPlateAcquisition() Returns the plate acquisition containing this well sample.
default List<Plate>	getPlates(Browser browser) Returns the plates containing the parent Well.
Length	getPositionX(omero.model.enums.UnitsLength unit) Returns the position X.
Length	getPositionY(omero.model.enums.UnitsLength unit) Returns the position Y.
default List<Screen>	getScreens(Browser browser) Returns the screens containing the parent Well.
long	getStartTime() Returns the time at which the field was acquired.
default Well	getWell(Browser browser) Retrieves the well containing this well sample.
void	reload(Browser browser) Reloads the well sample from OMERO.
void	setImage(Image image) Sets the image linked to this well sample.

Methods inherited from interface fr.igred.omero.RepositoryObject

getDescription, getName

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

WellSampleData asDataObject()

Returns an WellSampleData 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.

getScreens

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

Returns the screens containing the parent Well.

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.

getPlates

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

Returns the plates containing the parent Well.

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.

getPlateAcquisition

PlateAcquisition getPlateAcquisition()

Returns the plate acquisition containing this well sample.

Returns:

See above.

getWell

default Well getWell(Browser browser)
              throws AccessException,
                     ServiceException,
                     ExecutionException

Retrieves the well containing this well sample.

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.

getImage

Image getImage()

Returns the image related to that sample if any.

Returns:

See above.

setImage

void setImage(Image image)

Sets the image linked to this well sample.

Parameters:

image - The image to set.

getPositionX

Length getPositionX(omero.model.enums.UnitsLength unit)
             throws BigResult

Returns the position X.

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

getPositionY

Length getPositionY(omero.model.enums.UnitsLength unit)
             throws BigResult

Returns the position Y.

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

getStartTime

long getStartTime()

Returns the time at which the field was acquired.

Returns:

See above.

reload

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

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