Package fr.igred.omero.screen

Interface PlateAcquisition

All Superinterfaces:

Annotatable, HCSLinked, ImageLinked, RemoteObject, RepositoryObject

All Known Implementing Classes:

PlateAcquisitionWrapper

public interface PlateAcquisition
extends RepositoryObject, HCSLinked

Interface to handle Plate Acquisitions on OMERO.

Method Summary

Modifier and Type	Method	Description
PlateAcquisitionData	asDataObject()	Returns an PlateAcquisitionData corresponding to the handled object.
java.sql.Timestamp	getEndTime()	Returns the time when the last image was collected.
default java.util.List<Image>	getImages(Browser browser)	Retrieves the images contained in the wells in the parent plate.
java.lang.String	getLabel()	Returns the label associated to the plate acquisition.
int	getMaximumFieldCount()	Returns the maximum number of fields in any well.
default java.util.List<PlateAcquisition>	getPlateAcquisitions(Browser browser)	Returns this plate acquisitions as a singleton list.
default java.util.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 java.util.List<Screen>	getScreens(Browser browser)	Retrieves the screens containing the parent plates.
java.sql.Timestamp	getStartTime()	Returns the time when the first image was collected.
default java.util.List<Well>	getWells(Browser browser)	Retrieves the wells contained in the parent plate.
default <A extends AnnotationData> void	link(DataManager dm, A annotation)	Attach an AnnotationData to this object.
void	setDescription(java.lang.String description)	Sets the description of the plate acquisition.
void	setName(java.lang.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.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, getCreated, getGroupId, getId, getOwner, saveAndUpdate

Methods inherited from interface fr.igred.omero.RepositoryObject

getDescription, getName

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(java.lang.String name)

Sets the name of the plate acquisition.

Parameters:

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

Throws:

java.lang.IllegalArgumentException - If the name is null.

setDescription

void setDescription(java.lang.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,
                                             java.util.concurrent.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.

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

getScreens

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

Retrieves the screens containing the parent plates.

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

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)

Returns this plate acquisitions as a singleton list.

Specified by:

getPlateAcquisitions in interface HCSLinked

Parameters:

browser - The data browser (unused).

Returns:

See above.

getWells

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

Retrieves the wells contained in the parent plate.

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.

getImages

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

Retrieves the images contained in the wells in the parent plate.

Specified by:

getImages in interface ImageLinked

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.

getLabel

java.lang.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

java.sql.Timestamp getStartTime()

Returns the time when the first image was collected.

Returns:

See above.

getEndTime

java.sql.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.