fr.igred.omero.annotations

Interface Annotation

All Superinterfaces:

RemoteObject

All Known Subinterfaces:

FileAnnotation, MapAnnotation, RatingAnnotation, TagAnnotation, TextualAnnotation

All Known Implementing Classes:

AnnotationWrapper, FileAnnotationWrapper, MapAnnotationWrapper, RatingAnnotationWrapper, TagAnnotationWrapper, TextualAnnotationWrapper

public interface Annotation
extends RemoteObject

Interface to handle Annotations on OMERO.

Method Summary

Modifier and Type	Method and Description
AnnotationData	asDataObject() Returns an AnnotationData corresponding to the handled object.
default int	countAnnotationLinks(Browser browser) Returns the number of annotations links for this object.
List<Dataset>	getDatasets(Browser browser) Gets all datasets with this annotation from OMERO.
String	getDescription() Gets the annotation description.
List<Folder>	getFolders(Browser browser) Gets all folders with this annotation from OMERO.
List<Image>	getImages(Browser browser) Gets all images with this annotation from OMERO.
Timestamp	getLastModified() Returns the time when the annotation was last modified.
String	getNameSpace() Retrieves the annotation namespace.
List<PlateAcquisition>	getPlateAcquisitions(Browser browser) Gets all plate acquisitions with this annotation from OMERO.
List<Plate>	getPlates(Browser browser) Gets all plates with this annotation from OMERO.
List<Project>	getProjects(Browser browser) Gets all projects with this annotation from OMERO.
List<Screen>	getScreens(Browser browser) Gets all screens with this annotation from OMERO.
List<Well>	getWells(Browser browser) Gets all wells with this annotation from OMERO.
void	setDescription(String description) Sets the description of the underlying AnnotationData instance.
void	setNameSpace(String name) Sets the annotation namespace.

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

AnnotationData asDataObject()

Returns an AnnotationData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

getNameSpace

String getNameSpace()

Retrieves the annotation namespace.

Returns:

See above.

setNameSpace

void setNameSpace(String name)

Sets the annotation namespace.

Parameters:

name - The value to set.

getLastModified

Timestamp getLastModified()

Returns the time when the annotation was last modified.

Returns:

See above.

getDescription

String getDescription()

Gets the annotation description.

Returns:

See above

setDescription

void setDescription(String description)

Sets the description of the underlying AnnotationData instance.

Parameters:

description - The description

countAnnotationLinks

default int countAnnotationLinks(Browser browser)
                          throws ServiceException,
                                 AccessException

Returns the number of annotations links for this object.

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

getProjects

List<Project> getProjects(Browser browser)
                   throws ServiceException,
                          AccessException,
                          ExecutionException

Gets all projects with this annotation 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.

getDatasets

List<Dataset> getDatasets(Browser browser)
                   throws ServiceException,
                          AccessException,
                          ExecutionException

Gets all datasets with this annotation 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

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

Gets all images with this annotation 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.

getScreens

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

Gets all screens with this annotation 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.

getPlates

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

Gets all plates with this annotation 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.

getPlateAcquisitions

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

Gets all plate acquisitions with this annotation from OMERO.

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

getWells

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

Gets all wells with this annotation 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.

getFolders

List<Folder> getFolders(Browser browser)
                 throws ServiceException,
                        AccessException,
                        ExecutionException

Gets all folders with this annotation 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.