Package fr.igred.omero.annotations

Interface Annotation

All Superinterfaces:

ContainerLinked, HCSLinked, ImageLinked, RemoteObject

All Known Subinterfaces:

FileAnnotation, MapAnnotation, RatingAnnotation, TagAnnotation, TextualAnnotation

All Known Implementing Classes:

AnnotationWrapper, FileAnnotationWrapper, MapAnnotationWrapper, RatingAnnotationWrapper, TagAnnotationWrapper, TextualAnnotationWrapper

public interface Annotation
extends ContainerLinked, HCSLinked

Interface to handle Annotations on OMERO.

Method Summary

Modifier and Type	Method	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.
java.lang.String	getDescription()	Gets the annotation description.
java.util.List<Folder>	getFolders(Browser browser)	Gets all folders with this annotation from OMERO.
java.sql.Timestamp	getLastModified()	Returns the time when the annotation was last modified.
java.lang.String	getNameSpace()	Retrieves the annotation namespace.
void	setDescription(java.lang.String description)	Sets the description of the underlying AnnotationData instance.
void	setNameSpace(java.lang.String name)	Sets the annotation namespace.

Methods inherited from interface fr.igred.omero.ContainerLinked

getDatasets, getProjects

Methods inherited from interface fr.igred.omero.HCSLinked

getPlateAcquisitions, getPlates, getScreens, getWells

Methods inherited from interface fr.igred.omero.ImageLinked

getImages

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, saveAndUpdate

Method Detail

asDataObject

AnnotationData asDataObject()

Returns an AnnotationData corresponding to the handled object.

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

getNameSpace

java.lang.String getNameSpace()

Retrieves the annotation namespace.

Returns:

See above.

setNameSpace

void setNameSpace(java.lang.String name)

Sets the annotation namespace.

Parameters:

name - The value to set.

getLastModified

java.sql.Timestamp getLastModified()

Returns the time when the annotation was last modified.

Returns:

See above.

getDescription

java.lang.String getDescription()

Gets the annotation description.

Returns:

See above

setDescription

void setDescription(java.lang.String description)

Sets the description of the underlying AnnotationData instance.

Parameters:

description - The description

countAnnotationLinks

default int countAnnotationLinks(Browser browser)
                          throws ServiceException,
                                 ServerException

Returns the number of annotations links for this object.

Parameters:

browser - The data browser.

Returns:

See above.

Throws:

ServiceException - Cannot connect to OMERO.

ServerException - Server error.

getFolders

java.util.List<Folder> getFolders(Browser browser)
                           throws ServiceException,
                                  AccessException,
                                  ServerException,
                                  java.util.concurrent.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.

ServerException - Server error.

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