org.elasticsearch.search.aggregations.bucket.terms

Class InternalTerms

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.terms.InternalTerms

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, MultiBucketsAggregation, Terms

Direct Known Subclasses:

DoubleTerms, LongTerms, StringTerms, UnmappedTerms

public abstract class InternalTerms
extends InternalAggregation
implements Terms, ToXContent, Streamable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalTerms.Bucket

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.terms.Terms

Terms.Order, Terms.ValueType

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 Map<String,InternalTerms.Bucket>	bucketMap
protected List<InternalTerms.Bucket>	buckets
protected static String	DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME
protected long	docCountError
protected long	minDocCount
protected Terms.Order	order
protected long	otherDocCount
protected int	requiredSize
protected int	shardSize
protected boolean	showTermDocCountError
protected static String	SUM_OF_OTHER_DOC_COUNTS

Fields inherited from class org.elasticsearch.search.aggregations.InternalAggregation

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalTerms()
protected	InternalTerms(String name, Terms.Order order, int requiredSize, int shardSize, long minDocCount, List<InternalTerms.Bucket> buckets, boolean showTermDocCountError, long docCountError, long otherDocCount)

Method Summary

Modifier and Type	Method and Description
Terms.Bucket	getBucketByKey(String term) Get the bucket for the given term, or null if there is no such bucket.
List<Terms.Bucket>	getBuckets() Return the sorted list of the buckets in this terms aggregation.
long	getDocCountError() Get an upper bound of the error on document counts in this aggregation.
long	getSumOfOtherDocCounts() Return the sum of the document counts of all buckets that did not make it to the top buckets.
protected abstract InternalTerms	newAggregation(String name, List<InternalTerms.Bucket> buckets, boolean showTermDocCountError, long docCountError, long otherDocCount)
InternalAggregation	reduce(InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.

Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation

doXContentBody, getName, readSize, toXContent, type, writeSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getName

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

toXContent

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

readFrom, writeTo

Field Detail

DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME

protected static final String DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME

See Also:

Constant Field Values

SUM_OF_OTHER_DOC_COUNTS

protected static final String SUM_OF_OTHER_DOC_COUNTS

See Also:

Constant Field Values

order

protected Terms.Order order

requiredSize

protected int requiredSize

shardSize

protected int shardSize

minDocCount

protected long minDocCount

buckets

protected List<InternalTerms.Bucket> buckets

bucketMap

protected Map<String,InternalTerms.Bucket> bucketMap

docCountError

protected long docCountError

showTermDocCountError

protected boolean showTermDocCountError

otherDocCount

protected long otherDocCount

Constructor Detail

InternalTerms

protected InternalTerms()

InternalTerms

protected InternalTerms(String name,
                        Terms.Order order,
                        int requiredSize,
                        int shardSize,
                        long minDocCount,
                        List<InternalTerms.Bucket> buckets,
                        boolean showTermDocCountError,
                        long docCountError,
                        long otherDocCount)

Method Detail

getBuckets

public List<Terms.Bucket> getBuckets()

Description copied from interface: Terms

Return the sorted list of the buckets in this terms aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface Terms

Returns:

The buckets of this aggregation.

getBucketByKey

public Terms.Bucket getBucketByKey(String term)

Description copied from interface: Terms

Get the bucket for the given term, or null if there is no such bucket.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Specified by:

getBucketByKey in interface Terms

Parameters:

term - The key of the requested bucket.

Returns:

The bucket

getDocCountError

public long getDocCountError()

Description copied from interface: Terms

Get an upper bound of the error on document counts in this aggregation.

Specified by:

getDocCountError in interface Terms

getSumOfOtherDocCounts

public long getSumOfOtherDocCounts()

Description copied from interface: Terms

Return the sum of the document counts of all buckets that did not make it to the top buckets.

Specified by:

getSumOfOtherDocCounts in interface Terms

reduce

public InternalAggregation reduce(InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given addAggregation to a single one and returns it. In most cases, the assumption will be the all given addAggregation are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing get instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

newAggregation

protected abstract InternalTerms newAggregation(String name,
                                                List<InternalTerms.Bucket> buckets,
                                                boolean showTermDocCountError,
                                                long docCountError,
                                                long otherDocCount)