com.canto.cumulus.fieldvalue

Class RatingFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.RatingFieldValue

All Implemented Interfaces:

FieldValue

public class RatingFieldValue
extends java.lang.Object
implements FieldValue

A field value wrapper for a "Rating" field. This field type is actually a field value interpretation for a basic field type of "String List". Use Item.getRatingValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setRatingValue(com.canto.cumulus.GUID, RatingFieldValue) to set the field value back into the item.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
RatingFieldValue(FieldDefinition fieldDefinition) Creates a new instance for the given rating field.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearValue() Clear the field's value.
int	getCoreValue() Get the enum ID for the configured number of stars.
java.lang.String	getDisplayString() Return the field's value as a string that can be displayed to the user.
java.lang.String	getDisplayString(java.util.Locale locale) Return the field's value as a string that can be displayed to the user.
int	getRating() Get the number of stars as the rating value.
boolean	hasValue() Return whether this field has a value.
void	setFromDisplayString(java.util.Locale locale, java.lang.String value) Set the field value from a display string.
void	setFromDisplayString(java.lang.String value) Set the field value from a display string.
void	setRating(int stars) Set the field value using a number of stars representing a rating.
java.lang.String	toString() Same as getDisplayString().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RatingFieldValue

public RatingFieldValue(FieldDefinition fieldDefinition)

Creates a new instance for the given rating field.

Parameters:

fieldDefinition - rating field

Since:

8.5.1

Method Detail

hasValue

public boolean hasValue()

Return whether this field has a value.

Specified by:

hasValue in interface FieldValue

Returns:

true if the field has a value, false otherwise.

clearValue

public void clearValue()

Clear the field's value. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.

Specified by:

clearValue in interface FieldValue

getDisplayString

public java.lang.String getDisplayString()

Return the field's value as a string that can be displayed to the user. The string consists of a number of * characters corresponding to the rating value.

Specified by:

getDisplayString in interface FieldValue

Returns:

A string representation of the field value to be displayed.

getDisplayString

public java.lang.String getDisplayString(java.util.Locale locale)

Return the field's value as a string that can be displayed to the user. The string consists of a number of * characters corresponding to the rating value.

Specified by:

getDisplayString in interface FieldValue

Parameters:

locale - This parameter is not used.

Returns:

A string representation of the field value to be displayed.

setFromDisplayString

public void setFromDisplayString(java.lang.String value)
                          throws InvalidArgumentException

Set the field value from a display string. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

value - The display string to set the value from. The string consists of a number of * characters corresponding to the rating value.

Throws:

InvalidArgumentException - if the display string is not of the right format.

setFromDisplayString

public void setFromDisplayString(java.util.Locale locale,
                        java.lang.String value)
                          throws InvalidArgumentException

Set the field value from a display string. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

locale - This parameter is not used.

value - The display string to set the value from. The string consists of a number of * characters corresponding to the rating value.

Throws:

InvalidArgumentException - if the display string is not of the right format.

getRating

public int getRating()

Get the number of stars as the rating value.

Returns:

The number of stars (typically 1..5) for this rating value.

getCoreValue

public int getCoreValue()

Get the enum ID for the configured number of stars.

Returns:

enum ID

Since:

8.5.1

setRating

public void setRating(int stars)
               throws InvalidArgumentException

Set the field value using a number of stars representing a rating.

Parameters:

stars - The number of stars (1..5) as the new rating value.

Throws:

InvalidArgumentException - if the number is not allowed by the definition of the field.

toString

public java.lang.String toString()

Same as getDisplayString().

Overrides:

toString in class java.lang.Object

Returns:

A user-readable string of this field value (an empty string if it has no value).