com.canto.cumulus.db.statistics

Class StringFieldData

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.db.statistics.FieldData

com.canto.cumulus.db.statistics.StringFieldData

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class StringFieldData
extends FieldData
implements java.io.Externalizable

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

Since:

8.0

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getMatchingString()
java.lang.String	getMaxValue() Return the maximum string value (possibly partial string) for this statistics entry.
java.lang.String	getMinValue() Return the minimum string value (possibly partial string) for this statistics entry.
boolean	getPreferSortIndex()
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.
boolean	getSortAlphabetically()
void	setMatchingString(java.lang.String matchingString)
void	setPreferSortIndex(boolean preferSortIndex)
void	setSortAlphabetically(boolean sortAlphabetically)
void	setTopItemsRequest(int numberOfTopItemsToFind) Marks this object to return a list of most used values when passed to MultiItemCollection.getItemFieldStatistics(FieldData).

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

StringFieldData

public StringFieldData()

Required to make Externalizable happy. Do not call directly!

Since:

8.1.2

StringFieldData

public StringFieldData(JPack coreData)

StringFieldData

public StringFieldData(GUID fieldUID)

StringFieldData

public StringFieldData(GUID fieldUID,
               java.lang.String minValue,
               java.lang.String maxValue)

StringFieldData

public StringFieldData(GUID fieldUID,
               java.util.Locale locale,
               java.lang.String minValue,
               java.lang.String maxValue)

Method Detail

getMinValue

public java.lang.String getMinValue()

Return the minimum string value (possibly partial string) for this statistics entry. This value can be passed as a parameter to MultiItemCollection.getItemFieldStatistics(FieldData) to get the next level of field value statistics.

Returns:

The minimum string value.

getMaxValue

public java.lang.String getMaxValue()

Return the maximum string value (possibly partial string) for this statistics entry. This value can be passed as a parameter to MultiItemCollection.getItemFieldStatistics(FieldData) to get the next level of field value statistics.

Returns:

The maximum string 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.

setTopItemsRequest

public void setTopItemsRequest(int numberOfTopItemsToFind)

Marks this object to return a list of most used values when passed to MultiItemCollection.getItemFieldStatistics(FieldData). The result of MultiItemCollection.getItemFieldStatistics(FieldData) is a list of values where the FieldData.getItemCount() represents the number of items with that value. This requires the requested field being indexed for word search.

Parameters:

numberOfTopItemsToFind - the maximum number of values to return

Since:

8.1.1

setMatchingString

public void setMatchingString(java.lang.String matchingString)

Parameters:

matchingString - The string to match

Since:

11.1.5

getMatchingString

public java.lang.String getMatchingString()

Returns:

matching string

Since:

11.1.5

setPreferSortIndex

public void setPreferSortIndex(boolean preferSortIndex)

Parameters:

preferSortIndex - Whether to prefer sort index

Since:

11.1.5

getPreferSortIndex

public boolean getPreferSortIndex()

Returns:

true when the sort index is preferred, false when the word index is preferred

Since:

11.1.5

setSortAlphabetically

public void setSortAlphabetically(boolean sortAlphabetically)

Parameters:

sortAlphabetically - Whether to sort the result alphabetically

Since:

11.1.5

getSortAlphabetically

public boolean getSortAlphabetically()

Returns:

true when the result will sorted alphabetically, false when the result is sorted by frequency

Since:

11.1.5