omero.gateway.model

Class XMLAnnotationData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.AnnotationData

omero.gateway.model.XMLAnnotationData

public class XMLAnnotationData
extends AnnotationData

Defines an XML Annotation.

Since:

3.0-Beta4

Version:

3.0

Author:

Jean-Marie Burel j.burel@dundee.ac.uk, Donald MacDonald donald@lifesci.dundee.ac.uk

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULO_NS The name space used to identify modulo concept.

Fields inherited from class omero.gateway.model.AnnotationData

FILE_TRANSFER_NS

Constructor Summary

Constructors

Constructor and Description
XMLAnnotationData() Creates a new instance.
XMLAnnotationData(String text) Creates a new instance.
XMLAnnotationData(omero.model.XmlAnnotation annotation) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Object	getContent() Returns the content of the annotation.
String	getContentAsString() Returns the textual content of the annotation.
String	getDescription() Returns the description of the annotation.
String	getText() Returns the text of this annotation.
void	setContent(Object content) Sets the annotation.
void	setDescription(String value) Sets the description of the annotation.
void	setText(String value) Sets the text value.

Methods inherited from class omero.gateway.model.AnnotationData

getLastModified, getNameSpace, 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

MODULO_NS

public static final String MODULO_NS

The name space used to identify modulo concept.

See Also:

Constant Field Values

Constructor Detail

XMLAnnotationData

public XMLAnnotationData()

Creates a new instance.

XMLAnnotationData

public XMLAnnotationData(String text)

Creates a new instance.

Parameters:

text - The text to set.

XMLAnnotationData

public XMLAnnotationData(omero.model.XmlAnnotation annotation)

Creates a new instance.

Parameters:

annotation - The XmlAnnotation object corresponding to this DataObject. Mustn't be null.

Method Detail

setDescription

public void setDescription(String value)

Sets the description of the annotation.

Overrides:

setDescription in class AnnotationData

Parameters:

value - The value to set.

getDescription

public String getDescription()

Returns the description of the annotation.

Overrides:

getDescription in class AnnotationData

Returns:

See above.

setText

public void setText(String value)

Sets the text value.

Parameters:

value - The value to set.

getText

public String getText()

Returns the text of this annotation.

Returns:

See above.

getContent

public Object getContent()

Returns the 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 annotation.

Specified by:

setContent in class AnnotationData

Parameters:

content - The value to set.

See Also:

AnnotationData.setContent(Object)