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

Direct Known Subclasses:

TagSetWrapper

public class TagAnnotationWrapper
extends GenericAnnotationWrapper<TagAnnotationData>

Class containing a TagAnnotationData object.

Wraps function calls to the TagAnnotationData contained.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NS_TAGSET	The name space used to indicate that the tag is used a tag set.

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()	Deprecated. Gets the TagAnnotationData contained.
String	getName()	Gets the tag name.
boolean	isTagSet()	Returns whether this tag is a TagSet or not.
void	setName(String name)	Sets the tag name.
TagSetWrapper	toTagSet()	Converts this tag annotation to a tag set.

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

Field Detail

NS_TAGSET

public static final String NS_TAGSET

The name space used to indicate that the tag is used a tag set.

See Also:

Constant Field Values

Constructor Detail

TagAnnotationWrapper

public TagAnnotationWrapper(TagAnnotationData tag)

Constructor of the TagAnnotationWrapper class.

Parameters:

tag - TagAnnotationData to wrap.

TagAnnotationWrapper

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

Constructor of the TagAnnotationWrapper class. Creates the tag and saves it to 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 tag name.

Returns:

See above.

setName

public void setName(String name)

Sets the tag name.

Parameters:

name - The tag name. Mustn't be null.

Throws:

IllegalArgumentException - If the name is null.

isTagSet

public boolean isTagSet()

Returns whether this tag is a TagSet or not.

Returns:

true if this tag is a tag set, false otherwise.

toTagSet

public TagSetWrapper toTagSet()

Converts this tag annotation to a tag set.

Returns:

See above.

asTagAnnotationData

@Deprecated
public TagAnnotationData asTagAnnotationData()

Deprecated.

Gets the TagAnnotationData contained. Use GenericObjectWrapper.asDataObject() instead.

Returns:

the TagAnnotationData contained.