com.canto.cumulus.fieldvalue

Class DataSizeFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.DataSizeFieldValue

All Implemented Interfaces:

FieldValue, java.lang.Comparable<DataSizeFieldValue>

public class DataSizeFieldValue
extends java.lang.Object
implements FieldValue, java.lang.Comparable<DataSizeFieldValue>

A field value wrapper for a "Data Size" field, e.g. a field with the GUID GUID.UID_REC_ASSET_DATA_SIZE_64BIT, GUID.UID_REC_ASSET_DATA_SIZE or GUID.UID_REC_ASSET_RSRC_SIZE. This field type is actually a field value interpretation for a basic field type of "Integer". The core value is exchanged as a long integer and is the number of bytes. Use Item.getDataSizeValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setDataSizeValue(com.canto.cumulus.GUID, DataSizeFieldValue) to set the field value back into the item.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
DataSizeFieldValue() Create a new empty data size field value.
DataSizeFieldValue(long core) Create a new data size field value from the given core field value.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearValue() Clear the field's value.
int	compareTo(DataSizeFieldValue other) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o)
long	getCoreValue() Get the core value (number of bytes) for this field value.
java.lang.String	getDisplayString() Get a string of this field value to be displayed to the user.
java.lang.String	getDisplayString(java.util.Locale locale) Get a string of this field value to be displayed to the user.
java.lang.String	getDisplayString(java.util.Locale locale, boolean useAllUnits) Get a string of this field value to be displayed to the user.
int	hashCode()
boolean	hasValue() Return whether this field has a value.
void	setCoreValue(long value) Set this field value from a core value (number of bytes).
void	setFromDisplayString(java.util.Locale locale, java.lang.String value) Set the field value from a display string using a specific locale for formatting and language selection.
void	setFromDisplayString(java.lang.String value) Set the field value from a display string.
java.lang.String	toString() Same as getDisplayString().

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataSizeFieldValue

public DataSizeFieldValue()

Create a new empty data size field value.

DataSizeFieldValue

public DataSizeFieldValue(long core)

Create a new data size field value from the given core field value.

Parameters:

core - The long (or integer) field value as it comes from the item.

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

Get a string of this field value to be displayed to the user.

Specified by:

getDisplayString in interface FieldValue

Returns:

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

getDisplayString

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

Get a string of this field value to be displayed to the user.

Specified by:

getDisplayString in interface FieldValue

Parameters:

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

Returns:

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

getDisplayString

public java.lang.String getDisplayString(java.util.Locale locale,
                                boolean useAllUnits)

Get a string of this field value to be displayed to the user.

Parameters:

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

useAllUnits - specifies whether the display string uses only KB as units or can use all available units (for example MB and GB).

Returns:

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

Since:

8.5

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 formatting and 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 using a specific locale for formatting and language selection. 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 - 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.

getCoreValue

public long getCoreValue()

Get the core value (number of bytes) for this field value.

Returns:

The number of bytes for this data size.

setCoreValue

public void setCoreValue(long value)

Set this field value from a core value (number of bytes). 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:

value - The core value in bytes.

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(DataSizeFieldValue other)

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Specified by:

compareTo in interface java.lang.Comparable<DataSizeFieldValue>

Parameters:

other - the object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Since:

9.1