Package fr.igred.omero.annotations

Interface RatingAnnotation

All Superinterfaces:

Annotation, ContainerLinked, HCSLinked, ImageLinked, RemoteObject

All Known Implementing Classes:

RatingAnnotationWrapper

public interface RatingAnnotation
extends Annotation

Interface to handle Rating Annotations on OMERO.

Field Summary

Fields

Modifier and Type	Field	Description
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.

Method Summary

Modifier and Type	Method	Description
RatingAnnotationData	asDataObject()	Returns a RatingAnnotationData corresponding to the handled object.
int	getRating()	Returns the rating value.
void	setRating(int value)	Sets the rating value.

Methods inherited from interface fr.igred.omero.annotations.Annotation

countAnnotationLinks, getDescription, getFolders, getLastModified, getNameSpace, setDescription, setNameSpace

Methods inherited from interface fr.igred.omero.ContainerLinked

getDatasets, getProjects

Methods inherited from interface fr.igred.omero.HCSLinked

getPlateAcquisitions, getPlates, getScreens, getWells

Methods inherited from interface fr.igred.omero.ImageLinked

getImages

Methods inherited from interface fr.igred.omero.RemoteObject

canAnnotate, canChgrp, canChown, canDelete, canEdit, canLink, getCreated, getGroupId, getId, getOwner, saveAndUpdate

Field Detail

LEVEL_ZERO

static final int LEVEL_ZERO

Indicates the object is not rated.

See Also:

Constant Field Values

LEVEL_ONE

static final int LEVEL_ONE

Indicates the object is rated with one star.

See Also:

Constant Field Values

LEVEL_TWO

static final int LEVEL_TWO

Indicates the object is rated with two stars.

See Also:

Constant Field Values

LEVEL_THREE

static final int LEVEL_THREE

Indicates the object is rated with three stars.

See Also:

Constant Field Values

LEVEL_FOUR

static final int LEVEL_FOUR

Indicates the object is rated with four stars.

See Also:

Constant Field Values

LEVEL_FIVE

static final int LEVEL_FIVE

Indicates the object is rated with five stars.

See Also:

Constant Field Values

Method Detail

asDataObject

RatingAnnotationData asDataObject()

Returns a RatingAnnotationData corresponding to the handled object.

Specified by:

asDataObject in interface Annotation

Specified by:

asDataObject in interface RemoteObject

Returns:

See above.

getRating

int getRating()

Returns the rating value.

Returns:

See above.

setRating

void setRating(int value)

Sets the rating value.

Parameters:

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