com.canto.cumulus.fieldvalue

Class LengthInInchFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.LengthInInchFieldValue

All Implemented Interfaces:

FieldValue

public class LengthInInchFieldValue
extends java.lang.Object
implements FieldValue

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

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
LengthInInchFieldValue() Create a new empty length field value.
LengthInInchFieldValue(CumulusSession cumulusSession) Create a new empty length field value which uses the measurement unit from the user of the given session.
LengthInInchFieldValue(CumulusSession cumulusSession, double coreValue) Create a new length field value from the given core field value which uses the measurement unit from the user of the given session.
LengthInInchFieldValue(double coreValue) Create a new length field value from the given core field value.
LengthInInchFieldValue(double coreValue, int maximumFractionDigits) Create a new length field value from the given core field value.
LengthInInchFieldValue(int maximumFractionDigits) Create a new empty length 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 double value for this length 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, int maximumFractionDigits) Get a string of this field value to be displayed to the user.
java.lang.String	getDisplayString(java.util.Locale locale, int maximumFractionDigits, MeasurementUnit measurementUnit) Get a string of this field value to be displayed to the user.
java.lang.String	getDisplayString(java.util.Locale locale, MeasurementUnit measurementUnit) Get a string of this field value to 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 value from a core double value in inches.
void	setFromDisplayString(java.util.Locale locale, MeasurementUnit measurementUnit, java.lang.String value) Set the field value from a display string using a specific locale for formatting and language selection.
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

LengthInInchFieldValue

public LengthInInchFieldValue()

Create a new empty length field value.

LengthInInchFieldValue

public LengthInInchFieldValue(int maximumFractionDigits)

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

Since:

9.1

LengthInInchFieldValue

public LengthInInchFieldValue(CumulusSession cumulusSession)

Create a new empty length field value which uses the measurement unit from the user of the given session.

Parameters:

cumulusSession - session of the user whose measurement unit should be used

Since:

8.5

LengthInInchFieldValue

public LengthInInchFieldValue(double coreValue)

Create a new length field value from the given core field value. By initializing a field value using this method you will not get the display string in a measurement unit chosen by the user. Using Item.getLengthInInchValue(com.canto.cumulus.GUID) to get a field value transfers this information to the field value wrapper.

Parameters:

coreValue - The double field value as it comes from the item.

LengthInInchFieldValue

public LengthInInchFieldValue(double coreValue,
                      int maximumFractionDigits)

Create a new length field value from the given core field value. By initializing a field value using this method you will not get the display string in a measurement unit chosen by the user. Using Item.getLengthInInchValue(com.canto.cumulus.GUID) to get a field value transfers this information to the field value wrapper. Configures the default maximum number of fraction digits in case no number of fraction digits is specified.

Parameters:

coreValue - The double field value as it comes from the item.

Since:

9.1

LengthInInchFieldValue

public LengthInInchFieldValue(CumulusSession cumulusSession,
                      double coreValue)

Create a new length field value from the given core field value which uses the measurement unit from the user of the given session.

Parameters:

cumulusSession - session of the user whose measurement unit should be used

coreValue - The double field value as it comes from the item.

Since:

8.5

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. This string uses the measurement unit from the user settings of 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. This string uses the measurement unit from the user settings of 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,
                                int maximumFractionDigits)

Get a string of this field value to be displayed to the user. This string uses the measurement unit from the user settings of the user.

Parameters:

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

maximumFractionDigits - maximum number of fractions digits to use

Returns:

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

Since:

9.1

getDisplayString

public java.lang.String getDisplayString(java.util.Locale locale,
                                MeasurementUnit measurementUnit)

Get a string of this field value to be displayed to the user. This string uses the specified measurement unit.

Parameters:

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

measurementUnit - the measurement unit to use

Returns:

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

Since:

8.5

getDisplayString

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

Get a string of this field value to be displayed to the user. This string uses the specified measurement unit.

Parameters:

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

maximumFractionDigits - maximum number of fractions digits to use

measurementUnit - the measurement unit to use

Returns:

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

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.

setFromDisplayString

public void setFromDisplayString(java.util.Locale locale,
                        MeasurementUnit measurementUnit,
                        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.

Parameters:

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

measurementUnit - unit to use for the given value

value - The display string to set the value from.

Throws:

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

Since:

8.6

getCoreValue

public double getCoreValue()

Get the core double value for this length field value. The length value is measured in inches.

Returns:

The core value for this length value.

setCoreValue

public void setCoreValue(double value)

Set the value from a core double value in inches. 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 inches to be used.

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