fr.igred.omero.screen

Interface PlateAcquisition

All Superinterfaces:

Annotatable, RemoteObject, RepositoryObject

All Known Implementing Classes:

PlateAcquisitionWrapper

public interface PlateAcquisition
extends RepositoryObject, Annotatable

Interface to handle Plate Acquisitions on OMERO.

Method Summary

Modifier and Type	Method and Description
PlateAcquisitionData	asDataObject() Returns an PlateAcquisitionData corresponding to the handled object.
default List<RepositoryObject>	getChildren(Browser browser) Gets the object children.
Timestamp	getEndTime() Returns the time when the last image was collected.
default List<Image>	getImages() Retrieves the images contained in the well samples.
default List<Image>	getImages(Browser browser) Retrieves the images contained in the well samples from OMERO.
String	getLabel() Returns the label associated to the plate acquisition.
int	getMaximumFieldCount() Returns the maximum number of fields in any well.
default List<RepositoryObject>	getParents(Browser browser) Gets the object parents.
default List<Plate>	getPlates(Browser browser) Returns the (updated) parent plate as a singleton list.
long	getRefPlateId() Returns the id of the plate of reference.
default List<Screen>	getScreens(Browser browser) Retrieves the screens containing the parent plates.
Timestamp	getStartTime() Returns the time when the first image was collected.
default List<Well>	getWells(Browser browser) Retrieves the wells containing the well samples for this plate acquisition.
List<WellSample>	getWellSamples() Retrieves the well samples for this plate acquisition.
List<WellSample>	getWellSamples(Browser browser) Retrieves the well samples for this plate acquisition and reloads them from OMERO.
default <A extends AnnotationData> void	link(DataManager dm, A annotation) Attach an AnnotationData to this object.
void	reload(Browser browser) Reloads the plate acquisition from OMERO.
void	setDescription(String description) Sets the description of the plate acquisition.
void	setName(String name) Sets the name of the plate acquisition.
void	setRefPlateId(long refPlateId) Sets the id of the plate this plate acquisition is for.

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

PlateAcquisitionData asDataObject()

Returns an PlateAcquisitionData 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 acquisition.

Parameters:

name - The name of the plate acquisition. Mustn't be null.

Throws:

IllegalArgumentException - If the name is null.

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.

setDescription

void setDescription(String description)

Sets the description of the plate acquisition.

Parameters:

description - The description of the plate acquisition.

link

default <A extends AnnotationData> void link(DataManager dm,
                                             A annotation)
                                      throws ServiceException,
                                             AccessException,
                                             ExecutionException

Attach an AnnotationData to this object.

Specified by:

link in interface Annotatable

Type Parameters:

A - The type of the annotation.

Parameters:

dm - The data manager.

annotation - The AnnotationData.

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 the parent plates.

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 (updated) parent plate as a singleton list.

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

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

Retrieves the wells containing the well samples for this plate acquisition.

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

Retrieves the well samples for this plate acquisition.

Returns:

See above.

getWellSamples

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

Retrieves the well samples for this plate acquisition and reloads them 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()

Retrieves the images contained in the well samples.

Returns:

See above

getImages

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

Retrieves the images contained in the well samples 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.

getLabel

String getLabel()

Returns the label associated to the plate acquisition.

Returns:

See above.

getRefPlateId

long getRefPlateId()

Returns the id of the plate of reference.

Returns:

See above.

setRefPlateId

void setRefPlateId(long refPlateId)

Sets the id of the plate this plate acquisition is for.

Parameters:

refPlateId - The value to set.

getStartTime

Timestamp getStartTime()

Returns the time when the first image was collected.

Returns:

See above.

getEndTime

Timestamp getEndTime()

Returns the time when the last image was collected.

Returns:

See above.

getMaximumFieldCount

int getMaximumFieldCount()

Returns the maximum number of fields in any well.

Returns:

See above.

reload

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

Reloads the plate acquisition 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.