org.elasticsearch.action.fieldstats

Class FieldStats.Text

java.lang.Object

org.elasticsearch.action.fieldstats.FieldStats<org.apache.lucene.util.BytesRef>

org.elasticsearch.action.fieldstats.FieldStats.Text

All Implemented Interfaces:

Writeable, ToXContent

Enclosing class:

FieldStats<T>

public static class FieldStats.Text
extends FieldStats<org.apache.lucene.util.BytesRef>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.fieldstats.FieldStats

FieldStats.Date, FieldStats.Double, FieldStats.GeoPoint, FieldStats.Ip, FieldStats.Long, FieldStats.Text

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.action.fieldstats.FieldStats

maxValue, minValue

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Text(long maxDoc, long docCount, long sumDocFreq, long sumTotalTermFreq, boolean isSearchable, boolean isAggregatable)
Text(long maxDoc, long docCount, long sumDocFreq, long sumTotalTermFreq, boolean isSearchable, boolean isAggregatable, org.apache.lucene.util.BytesRef minValue, org.apache.lucene.util.BytesRef maxValue)

Method Summary

Modifier and Type	Method and Description
int	compare(org.apache.lucene.util.BytesRef o1, org.apache.lucene.util.BytesRef o2)
java.lang.String	getMaxValueAsString()
java.lang.String	getMinValueAsString()
protected void	toInnerXContent(XContentBuilder builder)
protected org.apache.lucene.util.BytesRef	valueOf(java.lang.String value, java.lang.String optionalFormat)
void	writeMinMax(StreamOutput out)

Methods inherited from class org.elasticsearch.action.fieldstats.FieldStats

accumulate, equals, getDensity, getDisplayType, getDocCount, getMaxDoc, getMaxValue, getMinValue, getSumDocFreq, getSumTotalTermFreq, hashCode, hasMinMax, isAggregatable, isSearchable, match, readFrom, toXContent, updateMinMax, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

isFragment

Constructor Detail

Text

public Text(long maxDoc,
            long docCount,
            long sumDocFreq,
            long sumTotalTermFreq,
            boolean isSearchable,
            boolean isAggregatable)

Text

public Text(long maxDoc,
            long docCount,
            long sumDocFreq,
            long sumTotalTermFreq,
            boolean isSearchable,
            boolean isAggregatable,
            org.apache.lucene.util.BytesRef minValue,
            org.apache.lucene.util.BytesRef maxValue)

Method Detail

compare

public int compare(org.apache.lucene.util.BytesRef o1,
                   org.apache.lucene.util.BytesRef o2)

Specified by:

compare in class FieldStats<org.apache.lucene.util.BytesRef>

writeMinMax

public void writeMinMax(StreamOutput out)
                 throws java.io.IOException

Specified by:

writeMinMax in class FieldStats<org.apache.lucene.util.BytesRef>

Throws:

java.io.IOException

valueOf

protected org.apache.lucene.util.BytesRef valueOf(java.lang.String value,
                                                  java.lang.String optionalFormat)

Specified by:

valueOf in class FieldStats<org.apache.lucene.util.BytesRef>

Parameters:

value - The string to be parsed

optionalFormat - A string describing how to parse the specified value. Whether this parameter is supported depends on the implementation. If optionalFormat is specified and the implementation doesn't support it an UnsupportedOperationException is thrown

getMinValueAsString

public java.lang.String getMinValueAsString()

Specified by:

getMinValueAsString in class FieldStats<org.apache.lucene.util.BytesRef>

Returns:

the lowest value in the field represented as a string. Note that, documents marked as deleted that haven't yet been merged way aren't taken into account.

getMaxValueAsString

public java.lang.String getMaxValueAsString()

Specified by:

getMaxValueAsString in class FieldStats<org.apache.lucene.util.BytesRef>

Returns:

the highest value in the field represented as a string. Note that, documents marked as deleted that haven't yet been merged way aren't taken into account.

toInnerXContent

protected void toInnerXContent(XContentBuilder builder)
                        throws java.io.IOException

Overrides:

toInnerXContent in class FieldStats<org.apache.lucene.util.BytesRef>

Throws:

java.io.IOException