com.canto.cumulus.fieldvalue

Class TimeOnlyFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.TimeOnlyFieldValue

All Implemented Interfaces:

FieldValue, java.lang.Comparable<TimeOnlyFieldValue>

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

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

Since:

8.0

Constructor Summary

Constructors

Constructor and Description
TimeOnlyFieldValue() Create a new empty time only field value.
TimeOnlyFieldValue(int coreValue) Create a new time 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(TimeOnlyFieldValue other) Compares this object with the specified object for order.
boolean	equals(java.lang.Object o)
int	getCoreValue() Get the core value of this field.
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	getHour() Returns the hour represented by this time only field value object.
int	getMilliSecond() Returns the millisecond of the second represented by this time only field value object.
int	getMinute() Returns the minute of the hour represented by this time only field value object.
int	getSecond() Returns the second of the minute represented by this time only field value object.
int	hashCode()
boolean	hasValue() Return whether this field has a value.
void	setCoreValue(int value) Set the field value of this field to a number of milliseconds as the core value.
void	setFromDisplayString(java.util.Locale locale, java.lang.String value) Set the field value from a display string.
void	setFromDisplayString(java.lang.String value) Set the field value from a display string.
void	setHour(int hour) Set the hour value of this time only field value.
void	setMillisecond(int millis) Set the millisecond of the second value of this time only field value.
void	setMinute(int minute) Set the minute of the hour value of this time only field value.
void	setSecond(int second) Set the second of the minute value of this time only field value.
java.lang.String	toString() Same as getDisplayString().

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeOnlyFieldValue

public TimeOnlyFieldValue()

Create a new empty time only field value.

TimeOnlyFieldValue

public TimeOnlyFieldValue(int coreValue)

Create a new time 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).

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.

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. 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 - This parameter is not used.

value - The display string to set the value from.

Throws:

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

getHour

public int getHour()

Returns the hour represented by this time only field value object.

Returns:

the hour (0..23).

setHour

public void setHour(int hour)

Set the hour value of this time only 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.

Parameters:

hour - the hour (0..23).

getMinute

public int getMinute()

Returns the minute of the hour represented by this time only field value object.

Returns:

the minute (0..59).

setMinute

public void setMinute(int minute)

Set the minute of the hour value of this time only 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.

Parameters:

minute - the minute of the hour (0..59).

getSecond

public int getSecond()

Returns the second of the minute represented by this time only field value object.

Returns:

the second (0..59).

setSecond

public void setSecond(int second)

Set the second of the minute value of this time only 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.

Parameters:

second - the second of the minute (0..59).

getMilliSecond

public int getMilliSecond()

Returns the millisecond of the second represented by this time only field value object.

Returns:

the millisecond (0..999).

setMillisecond

public void setMillisecond(int millis)

Set the millisecond of the second value of this time only 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.

Parameters:

millis - the millisecond of the second (0..999).

getCoreValue

public int getCoreValue()

Get the core value of this field. The core value is the number of milliseconds of the duration.

Returns:

The number of milliseconds for this field value.

setCoreValue

public void setCoreValue(int value)

Set the field value of this field to a number of milliseconds as the core 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:

value - The number of milliseconds for this field value.

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

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