com.canto.cumulus.fieldvalue

Class ResolutionFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.ResolutionFieldValue

All Implemented Interfaces:

FieldValue

public class ResolutionFieldValue
extends java.lang.Object
implements FieldValue

A field value wrapper for a "Resolution" field. This field type is actually a field value interpretation for a basic field type of "Real". Use Item.getResolutionValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setResolutionValue(com.canto.cumulus.GUID, ResolutionFieldValue) to set the field value back into the item.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
ResolutionFieldValue() Create a new empty resolution field value.
ResolutionFieldValue(double coreValue) Create a new resolution field value from the given core field value.
ResolutionFieldValue(double coreValue, int maximumFractionDigits) Create a new resolution field value from the given core field value.
ResolutionFieldValue(int maximumFractionDigits) Create a new empty resolution field value.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearValue() Clear the field's value.
boolean	equals(java.lang.Object o)
double	getCoreValue() Get the core field value in dots per inch.
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.lang.String	getDisplayString(java.util.Locale locale, int maximumFractionDigits) Return the field's value as a string that can be displayed to the user.
int	getMaximumFractionDigits() Returns the maximum number of fraction digits to use when creating a display string.
int	hashCode()
boolean	hasValue() Return whether this field has a value.
void	setCoreValue(double value) Set the field value in dots per inch.
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.
void	setMaximumFractionDigits(int maximumFractionDigits) Configures the maximum number of fraction digits to use when creating 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

ResolutionFieldValue

public ResolutionFieldValue()

Create a new empty resolution field value.

ResolutionFieldValue

public ResolutionFieldValue(int maximumFractionDigits)

Create a new empty resolution field value. Configures the default maximum number of fraction digits in case no number of fraction digits is specified.

Since:

9.1

ResolutionFieldValue

public ResolutionFieldValue(double coreValue)

Create a new resolution field value from the given core field value.

Parameters:

coreValue - The double field value in dots per inch as it comes from the item.

ResolutionFieldValue

public ResolutionFieldValue(double coreValue,
                    int maximumFractionDigits)

Create a new resolution field value from the given core field value. Configures the default maximum number of fraction digits in case no number of fraction digits is specified.

Parameters:

coreValue - The double field value in dots per inch as it comes from the item.

Since:

9.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. This method uses the current locale for formatting and 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.

Specified by:

getDisplayString in interface FieldValue

Parameters:

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

Returns:

A string representation of the field value to be displayed.

getDisplayString

public java.lang.String getDisplayString(java.util.Locale locale,
                                int maximumFractionDigits)

Return the field's value as a string that can be displayed to the user.

Parameters:

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

maximumFractionDigits - maximum number of fractions digits to use

Returns:

A string representation of the field value to be displayed.

Since:

9.1

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

Get the core field value in dots per inch.

Returns:

The core dpi value

setCoreValue

public void setCoreValue(double value)

Set the field value in dots per inch. 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 dpi value

getMaximumFractionDigits

public int getMaximumFractionDigits()

Returns the maximum number of fraction digits to use when creating a display string.

Returns:

maximum number of fraction digits to use

Since:

9.1

setMaximumFractionDigits

public void setMaximumFractionDigits(int maximumFractionDigits)

Configures the maximum number of fraction digits to use when creating a display string.

Parameters:

maximumFractionDigits - maximum number of fraction digits to use

Since:

9.1

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