Package fr.igred.omero.screen

Interface WellSample

All Superinterfaces:

HCSLinked, ImageLinked, RemoteObject

All Known Implementing Classes:

WellSampleWrapper

public interface WellSample
extends HCSLinked

Interface to handle Well Samples on OMERO.

Method Summary

Modifier and Type	Method	Description
WellSampleData	asDataObject()	Returns an WellSampleData corresponding to the handled object.
Image	getImage()	Returns the image related to that sample if any.
default java.util.List<Image>	getImages(Browser browser)	Retrieves the image contained in this Well Sample as a singleton list.
default java.util.List<PlateAcquisition>	getPlateAcquisitions(Browser browser)	Returns the plate acquisitions linked to the parent Well.
default java.util.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 java.util.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.
default java.util.List<Well>	getWells(Browser browser)	Retrieves the well containing this Well Sample as a singleton list.
void	setImage(Image image)	Sets the image linked to this well sample.

Methods inherited from interface fr.igred.omero.RemoteObject

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

Method Detail

asDataObject

WellSampleData asDataObject()

Returns an WellSampleData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

getScreens

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

Returns the screens containing the parent Well.

Specified by:

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

ServerException - Server error.

getPlates

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

Returns the plates containing the parent Well.

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

Returns the plate acquisitions linked to the parent Well.

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.

getWells

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

Retrieves the well containing this Well Sample as a singleton list.

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.

getWell

default Well getWell(Browser browser)
              throws AccessException,
                     ServiceException,
                     java.util.concurrent.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.

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

getImages

default java.util.List<Image> getImages(Browser browser)

Retrieves the image contained in this Well Sample as a singleton list.

Specified by:

getImages in interface ImageLinked

Parameters:

browser - The data browser (unused).

Returns:

See above

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.