fr.igred.omero.annotations

Class AnnotationWrapper<T extends AnnotationData>

java.lang.Object

fr.igred.omero.ObjectWrapper<T>

fr.igred.omero.annotations.AnnotationWrapper<T>

Type Parameters:

T - Subclass of AnnotationData

All Implemented Interfaces:

Annotation, RemoteObject

Direct Known Subclasses:

FileAnnotationWrapper, MapAnnotationWrapper, RatingAnnotationWrapper, TagAnnotationWrapper, TextualAnnotationWrapper

public abstract class AnnotationWrapper<T extends AnnotationData>
extends ObjectWrapper<T>
implements Annotation

Generic class containing an AnnotationData (or a subclass) object.

Field Summary

Fields inherited from class fr.igred.omero.ObjectWrapper

data

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotationWrapper(T a) Constructor of the AnnotationWrapper class.

Method Summary

Modifier and Type	Method and Description
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 class fr.igred.omero.ObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, getUpdated, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.igred.omero.annotations.Annotation

asDataObject, countAnnotationLinks

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, distinct, flatten, getCreated, getElementsOf, getGroupId, getId, getOwner, getUpdated, saveAndUpdate

Constructor Detail

AnnotationWrapper

protected AnnotationWrapper(T a)

Constructor of the AnnotationWrapper class.

Parameters:

a - The AnnotationData to wrap.

Method Detail

getNameSpace

public String getNameSpace()

Retrieves the annotation namespace.

Specified by:

getNameSpace in interface Annotation

Returns:

See above.

setNameSpace

public void setNameSpace(String name)

Sets the annotation namespace.

Specified by:

setNameSpace in interface Annotation

Parameters:

name - The value to set.

getLastModified

public Timestamp getLastModified()

Returns the time when the annotation was last modified.

Specified by:

getLastModified in interface Annotation

Returns:

See above.

getDescription

public String getDescription()

Gets the annotation description.

Specified by:

getDescription in interface Annotation

Returns:

See above

setDescription

public void setDescription(String description)

Sets the description of the underlying AnnotationData instance.

Specified by:

setDescription in interface Annotation

Parameters:

description - The description

getProjects

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

Gets all projects with this annotation from OMERO.

Specified by:

getProjects in interface Annotation

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

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

Gets all datasets with this annotation from OMERO.

Specified by:

getDatasets in interface Annotation

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

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

Gets all images with this annotation from OMERO.

Specified by:

getImages in interface Annotation

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

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

Gets all screens with this annotation from OMERO.

Specified by:

getScreens in interface Annotation

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

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

Gets all plates with this annotation from OMERO.

Specified by:

getPlates in interface Annotation

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

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

Gets all plate acquisitions with this annotation from OMERO.

Specified by:

getPlateAcquisitions in interface Annotation

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

getWells

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

Gets all wells with this annotation from OMERO.

Specified by:

getWells in interface Annotation

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

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

Gets all folders with this annotation from OMERO.

Specified by:

getFolders in interface Annotation

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.