org.elasticsearch.action.fieldstats

Class FieldStats<T>

java.lang.Object

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

All Implemented Interfaces:

Writeable, ToXContent

Direct Known Subclasses:

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

public abstract class FieldStats<T>
extends java.lang.Object
implements Writeable, ToXContent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldStats.Date
static class	FieldStats.Double
static class	FieldStats.GeoPoint
static class	FieldStats.Ip
static class	FieldStats.Long
static class	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

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

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
void	accumulate(FieldStats other) Accumulates the provided stats into this stats instance.
protected abstract int	compare(T o1, T o2)
boolean	equals(java.lang.Object o)
int	getDensity()
java.lang.String	getDisplayType()
long	getDocCount()
long	getMaxDoc()
T	getMaxValue()
abstract java.lang.String	getMaxValueAsString()
T	getMinValue()
abstract java.lang.String	getMinValueAsString()
long	getSumDocFreq()
long	getSumTotalTermFreq()
int	hashCode()
boolean	hasMinMax()
boolean	isAggregatable()
boolean	isSearchable()
boolean	match(IndexConstraint constraint)
static FieldStats	readFrom(StreamInput in)
protected void	toInnerXContent(XContentBuilder builder)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected void	updateMinMax(T min, T max)
protected abstract T	valueOf(java.lang.String value, java.lang.String optionalFormat)
protected abstract void	writeMinMax(StreamOutput out)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

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

Field Detail

minValue

protected T minValue

maxValue

protected T maxValue

Method Detail

getDisplayType

public java.lang.String getDisplayType()

hasMinMax

public boolean hasMinMax()

Returns:

true if min/max informations are available for this field

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.

isSearchable

public boolean isSearchable()

Returns:

true if any of the instances of the field name is searchable.

isAggregatable

public boolean isAggregatable()

Returns:

true if any of the instances of the field name is aggregatable.

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 java.lang.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 java.lang.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(java.lang.String value,
                             java.lang.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

accumulate

public final void accumulate(FieldStats other)

Accumulates the provided stats into this stats instance.

updateMinMax

protected void updateMinMax(T min,
                            T max)

compare

protected abstract int compare(T o1,
                               T o2)

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toInnerXContent

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

Throws:

java.io.IOException

writeTo

public final void writeTo(StreamOutput out)
                   throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

writeMinMax

protected abstract void writeMinMax(StreamOutput out)
                             throws java.io.IOException

Throws:

java.io.IOException

match

public boolean match(IndexConstraint constraint)

Returns:

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

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

readFrom

public static FieldStats readFrom(StreamInput in)
                           throws java.io.IOException

Throws:

java.io.IOException