omero.gateway.model

Class TagAnnotationData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.AnnotationData

omero.gateway.model.TagAnnotationData

public class TagAnnotationData
extends AnnotationData

A tag annotation can either be related to an image or a tag but not to both at the same time.

Since:

OME3.0

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk

Field Summary

Fields

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

Fields inherited from class omero.gateway.model.AnnotationData

FILE_TRANSFER_NS

Constructor Summary

Constructors

Constructor and Description
TagAnnotationData(String tag) Creates a new instance.
TagAnnotationData(String tag, boolean asTagSet) Creates a new instance.
TagAnnotationData(String tag, String description) Creates a new instance.
TagAnnotationData(String tag, String description, boolean asTagSet) Creates a new instance.
TagAnnotationData(omero.model.TagAnnotation tag) Creates a new instance.
TagAnnotationData(omero.model.TagAnnotation tag, List<omero.model.CommentAnnotation> value) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Object	getContent() Returns the textual content of the annotation.
String	getContentAsString() Returns the textual content of the annotation.
Set<DataObject>	getDataObjects() Returns the collection of data objects related to this tag.
String	getTagDescription() Returns the description of the tag.
List	getTagDescriptions() Returns the descriptions linked to that tag.
Set<TagAnnotationData>	getTags() Returns the collection of tags related to this tag.
String	getTagValue() Returns the text of the tag.
void	setContent(Object content) Sets the text annotation.
void	setDataObjects(Set<DataObject> dataObjects) Sets the collection of data objects related to that tag.
void	setTagDescription(String value) Sets the description of the tag.
void	setTagDescriptions(List<TextualAnnotationData> value) Sets the tag's descriptions.
void	setTagValue(String tag) Sets the value of the tag.

Methods inherited from class omero.gateway.model.AnnotationData

getDescription, getLastModified, getNameSpace, setDescription, setNameSpace

Methods inherited from class omero.gateway.model.DataObject

asAnnotation, asChannel, asDataset, asExperimenter, asFolder, asGroup, asIAnnotated, asImage, asIObject, asPixels, asPlate, asPojo, asPojos, asPojos, asProject, asScreen, asWell, asWellSample, canAnnotate, canDelete, canEdit, canLink, getCreated, getDetails, getGroupId, getId, getOwner, getPermissions, getUpdated, getVersion, isDirty, isLoaded, nullDetails, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, nullSafe, setDirty, setId, setValue, setVersion, timeOfEvent, toString

Methods inherited from class java.lang.Object

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

Field Detail

INSIGHT_TAGSET_NS

public static final String INSIGHT_TAGSET_NS

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

See Also:

Constant Field Values

Constructor Detail

TagAnnotationData

public TagAnnotationData(String tag,
                         boolean asTagSet)

Creates a new instance.

Parameters:

tag - The text of the tag.

asTagSet - Pass true to create the tag as a tag set, false otherwise.

TagAnnotationData

public TagAnnotationData(String tag)

Creates a new instance.

Parameters:

tag - The text of the tag.

TagAnnotationData

public TagAnnotationData(String tag,
                         String description)

Creates a new instance.

Parameters:

tag - The text of the tag.

description - The description of the tag.

TagAnnotationData

public TagAnnotationData(String tag,
                         String description,
                         boolean asTagSet)

Creates a new instance.

Parameters:

tag - The text of the tag.

description - The description of the tag.

asTagSet - Pass true to create the tag as a tag set, false otherwise.

TagAnnotationData

public TagAnnotationData(omero.model.TagAnnotation tag)

Creates a new instance.

Parameters:

tag - The tag to wrap.

TagAnnotationData

public TagAnnotationData(omero.model.TagAnnotation tag,
                         List<omero.model.CommentAnnotation> value)

Creates a new instance.

Parameters:

tag - The tag to wrap.

value - The descriptions of the tag.

Method Detail

setDataObjects

public void setDataObjects(Set<DataObject> dataObjects)

Sets the collection of data objects related to that tag.

Parameters:

dataObjects - The value to set.

getTags

public Set<TagAnnotationData> getTags()

Returns the collection of tags related to this tag.

Returns:

See above.

getDataObjects

public Set<DataObject> getDataObjects()

Returns the collection of data objects related to this tag. FIXME

Returns:

See above.

setTagDescriptions

public void setTagDescriptions(List<TextualAnnotationData> value)

Sets the tag's descriptions.

Parameters:

value - The collection to set.

getTagDescriptions

public List getTagDescriptions()

Returns the descriptions linked to that tag.

Returns:

See above.

setTagDescription

public void setTagDescription(String value)

Sets the description of the tag.

Parameters:

value - The value to set.

getTagDescription

public String getTagDescription()

Returns the description of the tag.

Returns:

See above.

setTagValue

public void setTagValue(String tag)

Sets the value of the tag.

Parameters:

tag - The value to set.

getTagValue

public String getTagValue()

Returns the text of the tag.

Returns:

See above.

getContent

public Object getContent()

Returns the textual content of the annotation.

Specified by:

getContent in class AnnotationData

Returns:

See above.

See Also:

AnnotationData.getContent()

getContentAsString

public String getContentAsString()

Returns the textual content of the annotation.

Specified by:

getContentAsString in class AnnotationData

Returns:

See above

See Also:

AnnotationData.getContentAsString()

setContent

public void setContent(Object content)

Sets the text annotation.

Specified by:

setContent in class AnnotationData

Parameters:

content - The value to set.

See Also:

AnnotationData.setContent(Object)