Package fr.igred.omero.annotations

Class TagAnnotationWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

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

fr.igred.omero.annotations.TagAnnotationWrapper

public class TagAnnotationWrapper
extends GenericAnnotationWrapper<TagAnnotationData>

Class containing a TagAnnotationData

Implements function using the TagAnnotationData contained.

Nested Class Summary

Nested classes/interfaces inherited from class fr.igred.omero.GenericObjectWrapper

GenericObjectWrapper.SortById<U extends GenericObjectWrapper<?>>

Field Summary

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
TagAnnotationWrapper(Client client, String name, String description)	Constructor of the TagAnnotationWrapper class.
TagAnnotationWrapper(TagAnnotationData tag)	Constructor of the TagAnnotationWrapper class.

Method Summary

Modifier and Type	Method	Description
TagAnnotationData	asTagAnnotationData()	Gets the TagAnnotationData contained.
List<DatasetWrapper>	getDatasets(Client client)	Gets all datasets with this tag from OMERO.
List<ImageWrapper>	getImages(Client client)	Gets all images with this tag from OMERO.
String	getName()	Gets the name of the TagData.
List<ProjectWrapper>	getProjects(Client client)	Gets all projects with this tag from OMERO.
void	setName(String name)	Sets the name of the TagData.

Methods inherited from class fr.igred.omero.annotations.GenericAnnotationWrapper

getDescription, getLastModified, getNameSpace, setDescription, setNameSpace

Methods inherited from class fr.igred.omero.GenericObjectWrapper

getCreated, getGroupId, getId, getOwner, saveAndUpdate, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TagAnnotationWrapper

public TagAnnotationWrapper(TagAnnotationData tag)

Constructor of the TagAnnotationWrapper class.

Parameters:

tag - Tag to be contained.

TagAnnotationWrapper

public TagAnnotationWrapper(Client client,
                            String name,
                            String description)
                     throws ServiceException,
                            AccessException,
                            ExecutionException

Constructor of the TagAnnotationWrapper class. Creates the tag and save it in OMERO.

Parameters:

client - The client handling the connection.

name - Annotation name.

description - Tag description.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

Method Detail

getName

public String getName()

Gets the name of the TagData.

Returns:

TagData name.

setName

public void setName(String name)

Sets the name of the TagData.

Parameters:

name - The name of the TagData. Mustn't be null.

Throws:

IllegalArgumentException - If the name is null.

asTagAnnotationData

public TagAnnotationData asTagAnnotationData()

Gets the TagAnnotationData contained.

Returns:

the TagAnnotationData contained.

getProjects

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

Gets all projects with this tag from OMERO.

Parameters:

client - The client handling the connection.

Returns:

ProjectWrapper list.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

getDatasets

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

Gets all datasets with this tag from OMERO.

Parameters:

client - The client handling the connection.

Returns:

DatasetWrapper list.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.

getImages

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

Gets all images with this tag from OMERO.

Parameters:

client - The client handling the connection.

Returns:

ImageWrapper list.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

OMEROServerError - Server error.