omero.gateway.model

Class RatingAnnotationData

java.lang.Object

omero.gateway.model.DataObject

omero.gateway.model.AnnotationData

omero.gateway.model.RatingAnnotationData

public class RatingAnnotationData
extends AnnotationData

Annotation used to rate an object. The five starts approach is selected.

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_RATING_NS The name space used to identify the archived annotation linked to a set of pixels.
static int	LEVEL_FIVE Indicates the object is rated with five stars.
static int	LEVEL_FOUR Indicates the object is rated with four stars.
static int	LEVEL_ONE Indicates the object is rated with one star.
static int	LEVEL_THREE Indicates the object is rated with three stars.
static int	LEVEL_TWO Indicates the object is rated with two stars.
static int	LEVEL_ZERO Indicates the object is not rated.

Fields inherited from class omero.gateway.model.AnnotationData

FILE_TRANSFER_NS

Constructor Summary

Constructors

Constructor and Description
RatingAnnotationData() Creates a new instance of value LEVEL_ZERO.
RatingAnnotationData(int value) Creates a new instance.
RatingAnnotationData(omero.model.LongAnnotation annotation) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Object	getContent() Returns the rating value.
String	getContentAsString() Returns the rating value as a string.
int	getRating() Returns the rating value.
void	setContent(Object content) Sets the text annotation.
void	setRating(int value) Sets the rating value.

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_RATING_NS

public static final String INSIGHT_RATING_NS

The name space used to identify the archived annotation linked to a set of pixels.

See Also:

Constant Field Values

LEVEL_ZERO

public static final int LEVEL_ZERO

Indicates the object is not rated.

See Also:

Constant Field Values

LEVEL_ONE

public static final int LEVEL_ONE

Indicates the object is rated with one star.

See Also:

Constant Field Values

LEVEL_TWO

public static final int LEVEL_TWO

Indicates the object is rated with two stars.

See Also:

Constant Field Values

LEVEL_THREE

public static final int LEVEL_THREE

Indicates the object is rated with three stars.

See Also:

Constant Field Values

LEVEL_FOUR

public static final int LEVEL_FOUR

Indicates the object is rated with four stars.

See Also:

Constant Field Values

LEVEL_FIVE

public static final int LEVEL_FIVE

Indicates the object is rated with five stars.

See Also:

Constant Field Values

Constructor Detail

RatingAnnotationData

public RatingAnnotationData()

Creates a new instance of value LEVEL_ZERO.

RatingAnnotationData

public RatingAnnotationData(int value)

Creates a new instance.

Parameters:

value - The rating value. One of the constants defined by this class.

RatingAnnotationData

public RatingAnnotationData(omero.model.LongAnnotation annotation)

Creates a new instance.

Parameters:

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

Method Detail

getRating

public int getRating()

Returns the rating value.

Returns:

See above.

setRating

public void setRating(int value)

Sets the rating value.

Parameters:

value - The value to set. Must be One of the constants defined by this class.

getContent

public Object getContent()

Returns the rating value.

Specified by:

getContent in class AnnotationData

Returns:

See above.

See Also:

AnnotationData.getContent()

getContentAsString

public String getContentAsString()

Returns the rating value as a string.

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)