com.canto.cumulus.db.statistics

Class FieldData

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.db.statistics.FieldData

Direct Known Subclasses:

BooleanFieldData, CategoriesFieldData, DataSizeFieldData, DateFieldData, DateOnlyFieldData, DoubleFieldData, FieldDefinitionData, IntFieldData, LabelFieldData, LengthInInchFieldData, LongFieldData, RatingFieldData, ResolutionFieldData, StringEnumFieldData, StringFieldData, TimeOnlyFieldData, VocabularyFieldData

public abstract class FieldData
extends RecordPackWrapper

This wrapper class is the base class for wrapper classes for field statistics methods.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
static FieldData	createFromPack(JPack pack) Creates a FieldData instance from the pack representation.
java.lang.String	getDescription() Return the description string for the given statistics entry.
java.lang.String	getDisplayString() Return the display string for the given statistics entry.
int	getFieldType() Return the type of the field for this field value range.
GUID	getFieldUID() Return the field UID for this field entry.
int	getFieldValueInterpretation() Return the value interpretation of the field for this field value range.
java.lang.String	getFullDisplayString()
boolean	getIsExpandable() Return whether this entry can be expanded (can return sub-entries).
int	getItemCount() Return the number of items in the range of this statistics entry.
int	getLevel() Returns the level of this entry in the statistics tree starting with 0.
java.util.Locale	getLocale() Returns the locale being used when creating display strings for this field data instance.
JPack	getPack()
abstract java.lang.String	getRawMaxValue() Return an internal string representation of the maximum value.
abstract java.lang.String	getRawMinValue() Return an internal string representation of the minimum value.
void	readExternal(java.io.ObjectInput in) Used for implementing Externalizable.
void	setCurrentCollection(boolean currentCollection) Specifies whether this field data will return children that are valid for the current collection only.
void	setLocale(java.util.Locale locale) Sets the locale to use when rendering display strings.
void	setTimeZoneOffset(int timeZoneOffset) Set the time zone offset.
void	writeExternal(java.io.ObjectOutput out) Used for implementing Externalizable.

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

Method Detail

getFieldUID

public GUID getFieldUID()

Return the field UID for this field entry. See FieldDefinition.getFieldUID() for details.

Returns:

The UID of the field.

getFieldType

public int getFieldType()

Return the type of the field for this field value range.

Returns:

The field type for this field value range entry

getFieldValueInterpretation

public int getFieldValueInterpretation()

Return the value interpretation of the field for this field value range.

Returns:

The field value interpretation for this field value range entry

getDisplayString

public java.lang.String getDisplayString()

Return the display string for the given statistics entry.

Returns:

The display string

getItemCount

public int getItemCount()

Return the number of items in the range of this statistics entry.

Returns:

The number of items for this field value range

getIsExpandable

public boolean getIsExpandable()

Return whether this entry can be expanded (can return sub-entries).

Returns:

true if this entry can be expanded, false otherwise.

getLevel

public int getLevel()

Returns the level of this entry in the statistics tree starting with 0.

Returns:

level of this entry in the statistics tree starting with 0

Since:

8.1

getLocale

public java.util.Locale getLocale()

Returns the locale being used when creating display strings for this field data instance.

Returns:

the found Locale instance

Since:

8.1

getDescription

public java.lang.String getDescription()

Return the description string for the given statistics entry.

Returns:

The description string

Since:

11.1.5

getRawMinValue

public abstract java.lang.String getRawMinValue()

Return an internal string representation of the minimum value.

Returns:

The raw minimum value as a special string.

getRawMaxValue

public abstract java.lang.String getRawMaxValue()

Return an internal string representation of the maximum value.

Returns:

The raw maximum value as a special string.

setTimeZoneOffset

public void setTimeZoneOffset(int timeZoneOffset)

Set the time zone offset. This is useful to be able to let the next call of MultiItemCollection.getItemFieldStatistics(FieldData) return the correct statistics for date fields. If you never set this time zone offset the current client's offset is used.

Parameters:

timeZoneOffset - The number of seconds to add to UTC time to get to local time

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale to use when rendering display strings.

Parameters:

locale - new locale to use for children of this instance.

Since:

8.5

getPack

public JPack getPack()

createFromPack

public static FieldData createFromPack(JPack pack)

Creates a FieldData instance from the pack representation.

Parameters:

pack - pack to create the instance from

Returns:

the created instance for the given pack

Since:

8.1

getFullDisplayString

public java.lang.String getFullDisplayString()

setCurrentCollection

public void setCurrentCollection(boolean currentCollection)

Specifies whether this field data will return children that are valid for the current collection only.

Parameters:

currentCollection - true for content of the current collection only

Since:

8.6

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Used for implementing Externalizable. Do not call directly!

Parameters:

out - stream to write data to

Throws:

java.io.IOException - in case of an error

Since:

8.1.2

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Used for implementing Externalizable. Do not call directly!

Parameters:

in - stream to read data from

Throws:

java.io.IOException - in case of an error

java.lang.ClassNotFoundException - in case of an error

Since:

8.1.2