Package fr.igred.omero.annotations

Class RatingAnnotationWrapper

java.lang.Object

fr.igred.omero.GenericObjectWrapper<T>

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

fr.igred.omero.annotations.RatingAnnotationWrapper

public class RatingAnnotationWrapper
extends GenericAnnotationWrapper<RatingAnnotationData>

Class containing a RatingAnnotationData object.

Wraps function calls to the RatingAnnotationData contained.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LEVEL_FIVE	Indicates the object is rated with five stars.
static final int	LEVEL_FOUR	Indicates the object is rated with four stars.
static final int	LEVEL_ONE	Indicates the object is rated with one star.
static final int	LEVEL_THREE	Indicates the object is rated with three stars.
static final int	LEVEL_TWO	Indicates the object is rated with two stars.
static final int	LEVEL_ZERO	Indicates the object is not rated.

Fields inherited from class fr.igred.omero.GenericObjectWrapper

data

Constructor Summary

Constructors

Constructor	Description
RatingAnnotationWrapper(int value)	Creates a new Textual Annotation with the provided text.
RatingAnnotationWrapper(RatingAnnotationData object)	Constructor of the RatingAnnotationWrapper class.

Method Summary

Modifier and Type	Method	Description
int	getRating()	Returns the rating value.
void	setRating(int value)	Sets the rating value.

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, delete, 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 Details

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 Details

RatingAnnotationWrapper

public RatingAnnotationWrapper(RatingAnnotationData object)

Constructor of the RatingAnnotationWrapper class.

Parameters:

object - RatingAnnotationData to wrap.

RatingAnnotationWrapper

public RatingAnnotationWrapper(int value)

Creates a new Textual Annotation with the provided text.

Parameters:

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

Method Details

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.