org.elasticsearch.search.aggregations.bucket.terms

Class InternalTerms.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket

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

All Implemented Interfaces:

Streamable, ToXContent, MultiBucketsAggregation.Bucket, HasAggregations

Direct Known Subclasses:

StringTerms.Bucket

Enclosing class:

InternalTerms<A extends InternalTerms,B extends InternalTerms.Bucket>

public abstract static class InternalTerms.Bucket
extends Terms.Bucket

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

MultiBucketsAggregation.Bucket.SubAggregationComparator<B extends MultiBucketsAggregation.Bucket>

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 InternalAggregations	aggregations
protected long	docCount
protected long	docCountError
protected boolean	showDocCountError

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalTerms.Bucket(long docCount, InternalAggregations aggregations, boolean showDocCountError, long docCountError, ValueFormatter formatter)
protected	InternalTerms.Bucket(ValueFormatter formatter, boolean showDocCountError)

Method Summary

Methods

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
long	getDocCountError()
InternalTerms.Bucket	reduce(List<? extends InternalTerms.Bucket> buckets, InternalAggregation.ReduceContext context)

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.Terms.Bucket

getKeyAsNumber

Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

getProperty

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.bucket.MultiBucketsAggregation.Bucket

getKey, getKeyAsString

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

toXContent

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

readFrom, writeTo

Field Detail

docCount

protected long docCount

docCountError

protected long docCountError

aggregations

protected InternalAggregations aggregations

showDocCountError

protected boolean showDocCountError

Constructor Detail

InternalTerms.Bucket

protected InternalTerms.Bucket(ValueFormatter formatter,
                    boolean showDocCountError)

InternalTerms.Bucket

protected InternalTerms.Bucket(long docCount,
                    InternalAggregations aggregations,
                    boolean showDocCountError,
                    long docCountError,
                    ValueFormatter formatter)

Method Detail

getDocCount

public long getDocCount()

Returns:

The number of documents that fall within this bucket

getDocCountError

public long getDocCountError()

Specified by:

getDocCountError in class Terms.Bucket

getAggregations

public Aggregations getAggregations()

Returns:

The sub-aggregations of this bucket

reduce

public InternalTerms.Bucket reduce(List<? extends InternalTerms.Bucket> buckets,
                          InternalAggregation.ReduceContext context)