com.canto.cumulus.db.statistics

Class TimeOnlyFieldData

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.db.statistics.FieldData

com.canto.cumulus.db.statistics.TimeOnlyFieldData

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class TimeOnlyFieldData
extends FieldData
implements java.io.Externalizable

This class is the wrapper class for statistics range data of time only fields.

Since:

8.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeOnlyFieldData() Required to make Externalizable happy.
TimeOnlyFieldData(GUID fieldUID)
TimeOnlyFieldData(GUID fieldUID, java.util.Locale locale, TimeOnlyFieldValue minValue, TimeOnlyFieldValue maxValue)
TimeOnlyFieldData(GUID fieldUID, TimeOnlyFieldValue minValue, TimeOnlyFieldValue maxValue)
TimeOnlyFieldData(JPack coreData)

Method Summary

Methods

Modifier and Type	Method and Description
TimeOnlyFieldValue	getMaxValue() Return the maximum date value for this statistics entry.
TimeOnlyFieldValue	getMinValue() Return the minimum date value for this statistics entry.
java.lang.String	getRawMaxValue() Return an internal string representation of the maximum value.
java.lang.String	getRawMinValue() Return an internal string representation of the minimum value.

Methods inherited from class com.canto.cumulus.db.statistics.FieldData

createFromPack, getDescription, getDisplayString, getFieldType, getFieldUID, getFieldValueInterpretation, getFullDisplayString, getIsExpandable, getItemCount, getLevel, getLocale, getPack, readExternal, setCurrentCollection, setLocale, setTimeZoneOffset, writeExternal

Methods inherited from class com.canto.cumulus.utils.RecordPackWrapper

toXMLString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Constructor Detail

TimeOnlyFieldData

public TimeOnlyFieldData()

Required to make Externalizable happy. Do not call directly!

Since:

8.1.2

TimeOnlyFieldData

public TimeOnlyFieldData(JPack coreData)

TimeOnlyFieldData

public TimeOnlyFieldData(GUID fieldUID)

TimeOnlyFieldData

public TimeOnlyFieldData(GUID fieldUID,
                 TimeOnlyFieldValue minValue,
                 TimeOnlyFieldValue maxValue)

TimeOnlyFieldData

public TimeOnlyFieldData(GUID fieldUID,
                 java.util.Locale locale,
                 TimeOnlyFieldValue minValue,
                 TimeOnlyFieldValue maxValue)

Method Detail

getMinValue

public TimeOnlyFieldValue getMinValue()

Return the minimum date value for this statistics entry. This value can be passed as a parameter to MultiItemCollection.getItemFieldStatistics(com.canto.cumulus.db.statistics.FieldData) to get the next level of field value statistics.

Returns:

The minimum time only value.

getMaxValue

public TimeOnlyFieldValue getMaxValue()

Return the maximum date value for this statistics entry. This value can be passed as a parameter to MultiItemCollection.getItemFieldStatistics(com.canto.cumulus.db.statistics.FieldData) to get the next level of field value statistics.

Returns:

The maximum time only value.

getRawMinValue

public java.lang.String getRawMinValue()

Description copied from class: FieldData

Return an internal string representation of the minimum value.

Specified by:

getRawMinValue in class FieldData

Returns:

The raw minimum value as a special string.

getRawMaxValue

public java.lang.String getRawMaxValue()

Description copied from class: FieldData

Return an internal string representation of the maximum value.

Specified by:

getRawMaxValue in class FieldData

Returns:

The raw maximum value as a special string.