org.elasticsearch.search.aggregations.bucket.terms

Interface Terms

All Superinterfaces:

Aggregation, MultiBucketsAggregation, ToXContent

All Known Implementing Classes:

DoubleTerms, InternalMappedTerms, InternalTerms, LongTerms, ParsedDoubleTerms, ParsedLongTerms, ParsedStringTerms, ParsedTerms, StringTerms, UnmappedTerms

public interface Terms
extends MultiBucketsAggregation

A terms aggregation. Defines multiple bucket, each associated with a unique term for a specific field. All documents in a bucket has the bucket's term in that field.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Terms.Bucket A bucket that is associated with a single term
static class	Terms.Order Determines the order by which the term buckets will be sorted

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
Terms.Bucket	getBucketByKey(java.lang.String term) Get the bucket for the given term, or null if there is no such bucket.
java.util.List<? extends 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.

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

getMetaData, getName, getType

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

isFragment, toXContent

Method Detail

getBuckets

java.util.List<? extends Terms.Bucket> getBuckets()

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

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

getBucketByKey

Terms.Bucket getBucketByKey(java.lang.String term)

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

getDocCountError

long getDocCountError()

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

getSumOfOtherDocCounts

long getSumOfOtherDocCounts()

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