Package fr.igred.omero.annotations

Class GenericAnnotationWrapper<T extends AnnotationData>

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

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

Type Parameters:

T - Subclass of AnnotationData

Direct Known Subclasses:

FileAnnotationWrapper, MapAnnotationWrapper, RatingAnnotationWrapper, TagAnnotationWrapper, TextualAnnotationWrapper

public abstract class GenericAnnotationWrapper<T extends AnnotationData>
extends GenericObjectWrapper<T>

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

Field Summary

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	countAnnotationLinks(Client client)	Returns the number of annotations links for this object.
List<DatasetWrapper>	getDatasets(Client client)	Gets all datasets with this annotation from OMERO.
String	getDescription()	Retrieves the description of the underlying AnnotationData instance.
List<FolderWrapper>	getFolders(Client client)	Gets all folders with this annotation from OMERO.
List<ImageWrapper>	getImages(Client client)	Gets all images with this annotation from OMERO.
Timestamp	getLastModified()	Returns the time when the annotation was last modified.
String	getNameSpace()	Retrieves the AnnotationData namespace of the underlying AnnotationData instance.
List<PlateAcquisitionWrapper>	getPlateAcquisitions(Client client)	Gets all plate acquisitions with this annotation from OMERO.
List<PlateWrapper>	getPlates(Client client)	Gets all plates with this annotation from OMERO.
List<ProjectWrapper>	getProjects(Client client)	Gets all projects with this annotation from OMERO.
List<ScreenWrapper>	getScreens(Client client)	Gets all screens with this annotation from OMERO.
List<WellWrapper>	getWells(Client client)	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 name space of the underlying AnnotationData instance.

Methods inherited from class fr.igred.omero.GenericObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, delete, distinct, flatten, getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString, wrap, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericAnnotationWrapper

protected GenericAnnotationWrapper(T a)

Constructor of the GenericAnnotationWrapper class.

Parameters:

a - The AnnotationData to wrap.

Method Detail

getNameSpace

public String getNameSpace()

Retrieves the AnnotationData namespace of the underlying AnnotationData instance.

Returns:

See above.

setNameSpace

public void setNameSpace(String name)

Sets the name space of the underlying AnnotationData instance.

Parameters:

name - The value to set.

getLastModified

public Timestamp getLastModified()

Returns the time when the annotation was last modified.

Returns:

See above.

getDescription

public String getDescription()

Retrieves the description of the underlying AnnotationData instance.

Returns:

See above

setDescription

public void setDescription(String description)

Sets the description of the underlying AnnotationData instance.

Parameters:

description - The description

countAnnotationLinks

public int countAnnotationLinks(Client client)
                         throws ServiceException,
                                OMEROServerError

Returns the number of annotations links for this object.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

OMEROServerError - Server error.

getProjects

public List<ProjectWrapper> getProjects(Client client)
                                 throws ServiceException,
                                        AccessException,
                                        OMEROServerError,
                                        ExecutionException

Gets all projects with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

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

getDatasets

public List<DatasetWrapper> getDatasets(Client client)
                                 throws ServiceException,
                                        AccessException,
                                        OMEROServerError,
                                        ExecutionException

Gets all datasets with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

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

getImages

public List<ImageWrapper> getImages(Client client)
                             throws ServiceException,
                                    AccessException,
                                    OMEROServerError,
                                    ExecutionException

Gets all images with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

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

getScreens

public List<ScreenWrapper> getScreens(Client client)
                               throws ServiceException,
                                      AccessException,
                                      OMEROServerError,
                                      ExecutionException

Gets all screens with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

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

getPlates

public List<PlateWrapper> getPlates(Client client)
                             throws ServiceException,
                                    AccessException,
                                    OMEROServerError,
                                    ExecutionException

Gets all plates with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

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

getPlateAcquisitions

public List<PlateAcquisitionWrapper> getPlateAcquisitions(Client client)
                                                   throws ServiceException,
                                                          OMEROServerError

Gets all plate acquisitions with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

OMEROServerError - Server error.

getWells

public List<WellWrapper> getWells(Client client)
                           throws ServiceException,
                                  AccessException,
                                  OMEROServerError,
                                  ExecutionException

Gets all wells with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

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

getFolders

public List<FolderWrapper> getFolders(Client client)
                               throws ServiceException,
                                      AccessException,
                                      OMEROServerError,
                                      ExecutionException

Gets all folders with this annotation from OMERO.

Parameters:

client - The client handling the connection.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

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