com.canto.cumulus.fieldvalue

Class AssetXRefFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.AssetXRefFieldValue

All Implemented Interfaces:

FieldValue

public class AssetXRefFieldValue
extends java.lang.Object
implements FieldValue

A field value wrapper for an asset cross-reference field, e.g. a field with the GUID GUID.UID_REC_RELATED_SUB_ASSETS or GUID.UID_REC_RELATED_MASTER_ASSETS. An asset cross reference field contains a list of references to other items of the same catalog. Each reference consists of a relation ID, a name and the item ID. The relation ID is one of the following:

• GUID.UID_ASSET_RELATION_CONTAINS
• GUID.UID_ASSET_RELATION_REFERENCES
• GUID.UID_ASSET_RELATION_IS_ALTERNATE
• GUID.UID_ASSET_RELATION_IS_VARIATION

Use Item.getAssetXRefValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setAssetXRefValue(com.canto.cumulus.GUID, AssetXRefFieldValue) to set the field value back into the item.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
AssetXRefFieldValue(byte[] coreValue) Create a new asset cross reference field value wrapper from the binary data contents of the corresponding field.

Method Summary

Methods

Modifier and Type	Method and Description
void	addReference(GUID relationID, int itemID, java.lang.String itemName) Add a new reference to this asset cross reference field value.
void	clearValue() 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.
boolean	containsReference(GUID relationID, int itemID) Return whether this asset cross reference field value contains a reference of a specific relation to a given item.
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.
java.util.Map<java.lang.Integer,java.lang.String>	getReferencedItemNames(java.util.Set<java.lang.Integer> itemIDs) Get a map of item IDs to item names contained in this asset cross reference field value.
java.util.Set<java.lang.Integer>	getReferences(GUID relationID) Get all references to other items for a given relation.
java.util.Set<GUID>	getRelations() Get all relations used in this asset cross reference field value.
boolean	hasValue() Return whether this field has a value.
void	removeAllReferences(GUID relationID) Remove all reference for a given relation.
void	removeReference(GUID relationID, int itemID) Remove the reference to another item.
void	setFromDisplayString(java.util.Locale locale, java.lang.String value) This method is not supported for asset cross reference values.
void	setFromDisplayString(java.lang.String value) This method is not supported for asset cross reference values.
java.lang.String	toString() Return a string representation of this asset cross reference field value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetXRefFieldValue

public AssetXRefFieldValue(byte[] coreValue)

Create a new asset cross reference field value wrapper from the binary data contents of the corresponding field. Instead of creating the field wrapper this way you should use Item.getAssetXRefValue(com.canto.cumulus.GUID) to the asset cross reference field wrapper.

Parameters:

coreValue - The binary field value from the item field to initialize this field value wrapper.

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

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. This method creates a string that contains all references to other items along with the relation.

Specified by:

getDisplayString in interface FieldValue

Returns:

A string representation of the field value to be displayed (an empty string if it has no value).

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. This method creates a string that contains all references to other items along with the relation.

Specified by:

getDisplayString in interface FieldValue

Parameters:

locale - Unused parameter.

Returns:

A string representation of the field value to be displayed (an empty string if it has no value).

setFromDisplayString

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

This method is not supported for asset cross reference values.

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

This method is not supported for asset cross reference values.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

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

value - The display string to set the value from.

Throws:

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

getRelations

public java.util.Set<GUID> getRelations()

Get all relations used in this asset cross reference field value. A relation is one of the following values:

• GUID.UID_ASSET_RELATION_CONTAINS
• GUID.UID_ASSET_RELATION_REFERENCES
• GUID.UID_ASSET_RELATION_IS_ALTERNATE
• GUID.UID_ASSET_RELATION_IS_VARIATION

Returns:

A set of all relations contained in this field value.

getReferences

public java.util.Set<java.lang.Integer> getReferences(GUID relationID)

Get all references to other items for a given relation.

Parameters:

relationID - The relation, one of the following:

• GUID.UID_ASSET_RELATION_CONTAINS
• GUID.UID_ASSET_RELATION_REFERENCES
• GUID.UID_ASSET_RELATION_IS_ALTERNATE
• GUID.UID_ASSET_RELATION_IS_VARIATION

Returns:

All references to items for the given relation.

containsReference

public boolean containsReference(GUID relationID,
                        int itemID)

Return whether this asset cross reference field value contains a reference of a specific relation to a given item.

Parameters:

relationID - The relation, one of the following:

• GUID.UID_ASSET_RELATION_CONTAINS
• GUID.UID_ASSET_RELATION_REFERENCES
• GUID.UID_ASSET_RELATION_IS_ALTERNATE
• GUID.UID_ASSET_RELATION_IS_VARIATION

itemID - The ID of the item of the same catalog to check.

Returns:

true if this field value contains a reference to the given item, false otherwise.

getReferencedItemNames

public java.util.Map<java.lang.Integer,java.lang.String> getReferencedItemNames(java.util.Set<java.lang.Integer> itemIDs)

Get a map of item IDs to item names contained in this asset cross reference field value. You can use this method to get names for all references to other items that you retrieved using getReferences(com.canto.cumulus.GUID).

Parameters:

itemIDs - The IDs of all items that you want to be mapped.

Returns:

A map that maps item ID to a name for the item.

addReference

public void addReference(GUID relationID,
                int itemID,
                java.lang.String itemName)

Add a new reference to this asset cross reference field 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. When saving a changed field value to the catalog Cumulus automatically updates the back-reference from the other item to this value's item.

Parameters:

relationID - The relation to the other item, one of the following:

• GUID.UID_ASSET_RELATION_CONTAINS
• GUID.UID_ASSET_RELATION_REFERENCES
• GUID.UID_ASSET_RELATION_IS_ALTERNATE
• GUID.UID_ASSET_RELATION_IS_VARIATION

itemID - The ID of the item to be referenced.

itemName - A name to be used for displaying the item reference.

removeReference

public void removeReference(GUID relationID,
                   int itemID)

Remove the reference to another item. 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. When saving a changed field value to the catalog Cumulus automatically updates the back-reference from the other item to this value's item.

Parameters:

relationID - The relation to the other item, one of the following:

• GUID.UID_ASSET_RELATION_CONTAINS
• GUID.UID_ASSET_RELATION_REFERENCES
• GUID.UID_ASSET_RELATION_IS_ALTERNATE
• GUID.UID_ASSET_RELATION_IS_VARIATION

itemID - The ID of the item referenced.

removeAllReferences

public void removeAllReferences(GUID relationID)

Remove all reference for a given relation. 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. When saving a changed field value to the catalog Cumulus automatically updates the back-reference from other items to this value's item.

Parameters:

relationID - The relation to the other item, one of the following:

• GUID.UID_ASSET_RELATION_CONTAINS
• GUID.UID_ASSET_RELATION_REFERENCES
• GUID.UID_ASSET_RELATION_IS_ALTERNATE
• GUID.UID_ASSET_RELATION_IS_VARIATION

toString

public java.lang.String toString()

Return a string representation of this asset cross reference field value.

Overrides:

toString in class java.lang.Object

Returns:

a string representation.

See Also:

getDisplayString()