com.canto.cumulus.fieldvalue

Class DateOnlyFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.DateOnlyFieldValue

All Implemented Interfaces:

FieldValue, java.lang.Comparable<DateOnlyFieldValue>

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

A field value wrapper for a "Date Only" field. This field type is actually a field value interpretation for a basic field type of "Integer". Use Item.getDateOnlyValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setDateOnlyValue(com.canto.cumulus.GUID, DateOnlyFieldValue) to set the field value back into the item.

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
DateOnlyFieldValue() Create a new empty date only field value.
DateOnlyFieldValue(int coreValue) Create a new date only 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(DateOnlyFieldValue other) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o)
int	getCoreValue() Get the core integer value for this date only field value.
int	getDay() Return the day of month represented by this DateOnlyFieldValue.
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.
int	getMonth() Return the month represented by this DateOnlyFieldValue.
java.lang.String	getUniversalDisplayString() Returns the content as universal date format.
int	getYear() Returns the year represented by this DateOnlyFieldValue.
int	getYear(boolean useAstronomicalScale) Returns the year represented by this DateOnlyFieldValue.
int	hashCode()
boolean	hasValue() Return whether this field has a value.
void	setCoreValue(int coreValue) Set the value from a core integer value.
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	setValue(int day, int month, int year) Set the date only field value from the given day, month, and year.
java.lang.String	toString() Same as getDisplayString().

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DateOnlyFieldValue

public DateOnlyFieldValue()

Create a new empty date only field value.

DateOnlyFieldValue

public DateOnlyFieldValue(int coreValue)

Create a new date only field value from the given core field value.

Parameters:

coreValue - The 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 - Unused parameter.

Returns:

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

getUniversalDisplayString

public java.lang.String getUniversalDisplayString()

Returns the content as universal date format.

Returns:

universal date format (yyyy-mm-dd) or empty string

Since:

8.1.4

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.

getYear

public int getYear()

Returns the year represented by this DateOnlyFieldValue.

Returns:

the year (negative for B.C.) in astronomical scale.

getYear

public int getYear(boolean useAstronomicalScale)

Returns the year represented by this DateOnlyFieldValue.

Returns:

the year (negative for B.C.) in astronomical scale or as calendar year where year 0 is interpreted as 1 BC and is returned as -1.

Since:

9.1

getMonth

public int getMonth()

Return the month represented by this DateOnlyFieldValue.

Returns:

the month ranges from 1 (January) to 12 (December) and is 0 if the value is the whole year.

getDay

public int getDay()

Return the day of month represented by this DateOnlyFieldValue.

Returns:

the day ranges from 1 to 31 and is 0 if the value is the whole month or year.

setValue

public void setValue(int day,
            int month,
            int year)

Set the date only field value from the given day, month, and year. 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:

day - The day of month (1..31) to be used. Pass 0 to specify the whole month or year.

month - The month (1..12) to be used. Pass 0 to specify the whole year.

year - The year (e.g. 2006)

getCoreValue

public int getCoreValue()

Get the core integer value for this date only field value.

Returns:

The core integer value for this date only value.

setCoreValue

public void setCoreValue(int coreValue)

Set the value from a core integer 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:

coreValue - The core integer value to be used.

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

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

compareTo

public int compareTo(DateOnlyFieldValue 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<DateOnlyFieldValue>

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