Package fr.igred.omero.annotations

Class TagSetWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

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

fr.igred.omero.annotations.TagAnnotationWrapper

fr.igred.omero.annotations.TagSetWrapper

public class TagSetWrapper
extends TagAnnotationWrapper

Class containing a TagAnnotationData object with a namespace set to TagAnnotationWrapper.NS_TAGSET.

Wraps function calls to the TagAnnotationData contained.

Field Summary

Fields inherited from class fr.igred.omero.annotations.TagAnnotationWrapper

NS_TAGSET

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
TagSetWrapper(Client dm, String name, String description)	Constructor of the TagSetWrapper class.
TagSetWrapper(TagAnnotationData tag)	Constructor of the TagSetWrapper class.

Method Summary

Modifier and Type	Method	Description
List<TagAnnotationWrapper>	getTags()	Returns the list of tags related to this tag set.
List<TagAnnotationWrapper>	getTags(Browser browser)	Reloads the tag set and returns the corresponding list of tags.
void	link(Client dm, TagAnnotationWrapper tag)	Links a tag to this tag set.
void	link(Client dm, TagAnnotationWrapper... tags)	Links multiple tags to this tag set.
void	reload(Browser browser)	Reloads the tag set from OMERO.

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

asTagAnnotationData, getName, isTagSet, setName, toTagSet

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

countAnnotationLinks, getDatasets, getDescription, getFolders, getImages, getLastModified, getNameSpace, getPlateAcquisitions, getPlates, getProjects, getScreens, getWells, setDescription, setNameSpace

Methods inherited from class fr.igred.omero.GenericObjectWrapper

asDataObject, canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, distinct, flatten, 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

Constructor Detail

TagSetWrapper

public TagSetWrapper(TagAnnotationData tag)

Constructor of the TagSetWrapper class.

Parameters:

tag - TagAnnotationData to wrap.

TagSetWrapper

public TagSetWrapper(Client dm,
                     String name,
                     String description)
              throws ServiceException,
                     AccessException,
                     ExecutionException

Constructor of the TagSetWrapper class. Creates the tag set and saves it to OMERO.

Parameters:

dm - The data manager.

name - Tag 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

getTags

public List<TagAnnotationWrapper> getTags()

Returns the list of tags related to this tag set.

Returns:

See above.

getTags

public List<TagAnnotationWrapper> getTags(Browser browser)
                                   throws ExecutionException,
                                          AccessException,
                                          ServiceException,
                                          OMEROServerError

Reloads the tag set and returns the corresponding list of tags.

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.

OMEROServerError - Server error.

link

public void link(Client dm,
                 TagAnnotationWrapper tag)
          throws AccessException,
                 ServiceException,
                 ExecutionException

Links a tag to this tag set.

Parameters:

dm - The data manager.

tag - The tag.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

link

public void link(Client dm,
                 TagAnnotationWrapper... tags)
          throws AccessException,
                 ServiceException,
                 ExecutionException

Links multiple tags to this tag set.

Parameters:

dm - The data manager.

tags - The tags.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

reload

public void reload(Browser browser)
            throws ServiceException,
                   AccessException,
                   ExecutionException,
                   OMEROServerError

Reloads the tag set from OMERO.

Parameters:

browser - The data browser.

Throws:

ServiceException - Cannot connect to OMERO.

AccessException - Cannot access data.

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

OMEROServerError - Server error.