com.canto.cumulus.fieldvalue

Class VocabularyFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.VocabularyFieldValue

All Implemented Interfaces:

FieldValue

public class VocabularyFieldValue
extends java.lang.Object
implements FieldValue

A field value wrapper for the vocabulary assignment of an item. Use Item.getVocabularyValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setVocabularyValue(com.canto.cumulus.GUID, VocabularyFieldValue) to set the field value back into the item. You can use the wrapper object from one Item to save it to another Item but both have to belong to the same catalog.

Since:

10.0.2

Constructor Summary

Constructors

Constructor and Description
VocabularyFieldValue(FieldDefinition fieldDefinition) Creates a new instance for the given string enum field.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearValue() Clear the field's value.
ItemCollection	findItems(java.lang.String searchValue, boolean searchEqual, int languageID) Returns an ItemCollection containing the items of the $Vocabulary catalog matching the defined query (see @link FieldDefinition#getVocabularyQuery) and the searchValue.
static void	findItems(java.lang.String searchValue, boolean searchEqual, int languageID, java.util.Set<java.lang.Integer> itemIDsToIgnore, ItemCollection vocabularyItemCollection) Searches for items of the $Vocabulary catalog matching the defined query (see @link FieldDefinition#getVocabularyQuery) and the searchValue.
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	getID() Get the ID of the string list value.
java.util.Set<java.lang.Integer>	getIDs() Get the IDs of this field 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	setID(int enumID) Set the ID of this string list value.
void	setIDs(java.util.Set<java.lang.Integer> ids) Set the field value to the given set of string list IDs.
boolean	supportsMultipleValues() Return whether this field is defined to support multiple values.
java.lang.String	toString() Same as getDisplayString().

Methods inherited from class java.lang.Object

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

Constructor Detail

VocabularyFieldValue

public VocabularyFieldValue(FieldDefinition fieldDefinition)

Creates a new instance for the given string enum field.

Parameters:

fieldDefinition - string enum field

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 for a multiple-select string list field is a comma separated list of value strings. This method uses the current locale for the language selection.

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 for a multiple-select string list field is a comma separated list of value strings.

Specified by:

getDisplayString in interface FieldValue

Parameters:

locale - The locale to use for the language selection.

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. This method uses the current locale for the language selection.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

value - The display string to set the value from.

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. This method uses the current locale for the language selection.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

value - The display string to set the value from.

locale - The locale to use for formatting and language selection.

Throws:

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

supportsMultipleValues

public boolean supportsMultipleValues()

Return whether this field is defined to support multiple values.

Returns:

true if this field supports multiple values, false otherwise.

getID

public int getID()

Get the ID of the string list value. Call this only if the field does not support multiple values. Otherwise it will only return the first value.

Returns:

The ID of the string list value.

setID

public void setID(int enumID)
           throws InvalidArgumentException

Set the ID of this string list value. Call this only if the field does not support multiple values. Otherwise it will only set the first 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.

Parameters:

enumID - The new value of this string list field value.

Throws:

InvalidArgumentException - if the ID is not valid

See Also:

setIDs(java.util.Set)

getIDs

public java.util.Set<java.lang.Integer> getIDs()

Get the IDs of this field value.

Returns:

The IDs of this string list field value.

setIDs

public void setIDs(java.util.Set<java.lang.Integer> ids)
            throws InvalidArgumentException

Set the field value to the given set of string list IDs. Call this only if the field supports multiple values. 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.

Parameters:

ids - The string list IDs to be the new field value.

Throws:

InvalidArgumentException - if one of the given IDs is not valid.

findItems

public ItemCollection findItems(java.lang.String searchValue,
                       boolean searchEqual,
                       int languageID)

Returns an ItemCollection containing the items of the $Vocabulary catalog matching the defined query (see @link FieldDefinition#getVocabularyQuery) and the searchValue.

Parameters:

searchValue - the value to search for

searchEqual - if this is true the value must be matches equal. IF this is false a "starts with" search will be applied. This can be used to implement a "type ahead" search.

languageID - the language to search if the GUID.UID_CAT_NAME field is defined for multiple language support.

Returns:

ItemCollection containing all items of the $Vocabulary catalog matching the defined query

findItems

public static void findItems(java.lang.String searchValue,
             boolean searchEqual,
             int languageID,
             java.util.Set<java.lang.Integer> itemIDsToIgnore,
             ItemCollection vocabularyItemCollection)

Searches for items of the $Vocabulary catalog matching the defined query (see @link FieldDefinition#getVocabularyQuery) and the searchValue.

Parameters:

searchValue - the value to search for

searchEqual - if this is true the value must be matches equal. IF this is false a "starts with" search will be applied. This can be used to implement a "type ahead" search.

languageID - the language to search if the GUID.UID_CAT_NAME field is defined for multiple language support.

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).