org.elasticsearch.action.fieldstats

Class FieldStats<T extends Comparable<T>>

java.lang.Object

org.elasticsearch.action.fieldstats.FieldStats<T>

All Implemented Interfaces:

Streamable, ToXContent

Direct Known Subclasses:

FieldStats.Double, FieldStats.Float, FieldStats.Long, FieldStats.Text

public abstract class FieldStats<T extends Comparable<T>>
extends Object
implements Streamable, ToXContent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldStats.Date
static class	FieldStats.Double
static class	FieldStats.Float
static class	FieldStats.Long
static class	FieldStats.Text

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected T	maxValue
protected T	minValue

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FieldStats()
protected	FieldStats(int type, long maxDoc, long docCount, long sumDocFreq, long sumTotalTermFreq)

Method Summary

Methods

Modifier and Type	Method and Description
void	append(FieldStats stats) Merges the provided stats into this stats instance.
int	getDensity()
long	getDocCount()
long	getMaxDoc()
T	getMaxValue()
abstract String	getMaxValueAsString()
T	getMinValue()
abstract String	getMinValueAsString()
long	getSumDocFreq()
long	getSumTotalTermFreq()
boolean	match(IndexConstraint constraint)
static FieldStats	read(StreamInput in)
void	readFrom(StreamInput in)
protected void	toInnerXContent(XContentBuilder builder)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected abstract T	valueOf(String value, String optionalFormat)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

minValue

protected T extends Comparable<T> minValue

maxValue

protected T extends Comparable<T> maxValue

Constructor Detail

FieldStats

protected FieldStats()

FieldStats

protected FieldStats(int type,
          long maxDoc,
          long docCount,
          long sumDocFreq,
          long sumTotalTermFreq)

Method Detail

getMaxDoc

public long getMaxDoc()

Returns:

the total number of documents. Note that, documents marked as deleted that haven't yet been merged way aren't taken into account.

getDocCount

public long getDocCount()

Returns:

the number of documents that have at least one term for this field, or -1 if this measurement isn't available. Note that, documents marked as deleted that haven't yet been merged way aren't taken into account.

getDensity

public int getDensity()

Returns:

The percentage of documents that have at least one value for this field. This is a derived statistic and is based on: 'doc_count / max_doc'

getSumDocFreq

public long getSumDocFreq()

Returns:

the sum of each term's document frequency in this field, or -1 if this measurement isn't available. Document frequency is the number of documents containing a particular term. Note that, documents marked as deleted that haven't yet been merged way aren't taken into account.

getSumTotalTermFreq

public long getSumTotalTermFreq()

Returns:

the sum of the term frequencies of all terms in this field across all documents, or -1 if this measurement isn't available. Term frequency is the total number of occurrences of a term in a particular document and field. Note that, documents marked as deleted that haven't yet been merged way aren't taken into account.

getMinValue

public T getMinValue()

Returns:

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

getMaxValue

public T getMaxValue()

Returns:

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

getMinValueAsString

public abstract String getMinValueAsString()

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 abstract String getMaxValueAsString()

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.

valueOf

protected abstract T valueOf(String value,
        String optionalFormat)

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

append

public void append(FieldStats stats)

Merges the provided stats into this stats instance.

match

public boolean match(IndexConstraint constraint)

Returns:

true if this instance matches with the provided index constraint, otherwise false is returned

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

toInnerXContent

protected void toInnerXContent(XContentBuilder builder)
                        throws IOException

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

read

public static FieldStats read(StreamInput in)
                       throws IOException

Throws:

IOException