org.elasticsearch.search.aggregations.bucket

Class BucketsAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

Direct Known Subclasses:

FiltersAggregator, GeoHashGridAggregator, HistogramAggregator, RangeAggregator, SingleBucketAggregator, TermsAggregator

public abstract class BucketsAggregator
extends Aggregator

Nested Class Summary

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

Aggregator.BucketAggregationMode, Aggregator.Parser, Aggregator.SubAggCollectionMode

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

BucketCollector.BucketAnalysisCollector

Field Summary

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

bigArrays, bucketAggregationMode, COLLECT_MODE, collectableSubAggregators, context, depth, estimatedBucketCount, factories, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description
BucketsAggregator(String name, Aggregator.BucketAggregationMode bucketAggregationMode, AggregatorFactories factories, long estimatedBucketsCount, AggregationContext context, Aggregator parent)

Method Summary

Modifier and Type	Method and Description
protected InternalAggregations	bucketAggregations(long bucketOrd) Required method to build the child aggregations of the given bucket (identified by the bucket ordinal).
int	bucketDocCount(long bucketOrd) Utility method to return the number of documents that fell in the given bucket (identified by the bucket ordinal)
protected InternalAggregations	bucketEmptyAggregations() Utility method to build empty aggregations of the sub aggregators.
void	close() Called upon release of the aggregator.
protected void	collectBucket(int doc, long bucketOrd) Utility method to collect the given doc in the given bucket (identified by the bucket ordinal)
protected void	collectBucketNoCounts(int doc, long bucketOrd) Utility method to collect the given doc in the given bucket but not to update the doc counts of the bucket
protected void	collectExistingBucket(int doc, long bucketOrd) Same as collectBucket(int, long), but doesn't check if the docCounts needs to be re-sized.
IntArray	getDocCounts()
protected void	incrementBucketDocCount(long bucketOrd, int inc) Utility method to increment the doc counts of the given bucket (identified by the bucket ordinal)
protected long	maxBucketOrd() Return an upper bound of the maximum bucket ordinal seen so far.

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

bucketAggregationMode, buildAggregation, buildEmptyAggregation, buildEmptySubAggregations, context, depth, doClose, doPostCollection, estimatedBucketCount, gatherAnalysis, hasParentBucketAggregator, name, parent, postCollection, preCollection, runDeferredCollections, shouldCollect, shouldDefer, subAggregator, subAggregators

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

collect, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.lucene.ReaderContextAware

setNextReader

Constructor Detail

BucketsAggregator

public BucketsAggregator(String name,
                         Aggregator.BucketAggregationMode bucketAggregationMode,
                         AggregatorFactories factories,
                         long estimatedBucketsCount,
                         AggregationContext context,
                         Aggregator parent)

Method Detail

maxBucketOrd

protected final long maxBucketOrd()

Return an upper bound of the maximum bucket ordinal seen so far.

collectBucket

protected final void collectBucket(int doc,
                                   long bucketOrd)
                            throws IOException

Utility method to collect the given doc in the given bucket (identified by the bucket ordinal)

Throws:

IOException

collectExistingBucket

protected final void collectExistingBucket(int doc,
                                           long bucketOrd)
                                    throws IOException

Same as collectBucket(int, long), but doesn't check if the docCounts needs to be re-sized.

Throws:

IOException

getDocCounts

public IntArray getDocCounts()

collectBucketNoCounts

protected final void collectBucketNoCounts(int doc,
                                           long bucketOrd)
                                    throws IOException

Utility method to collect the given doc in the given bucket but not to update the doc counts of the bucket

Throws:

IOException

incrementBucketDocCount

protected final void incrementBucketDocCount(long bucketOrd,
                                             int inc)
                                      throws IOException

Utility method to increment the doc counts of the given bucket (identified by the bucket ordinal)

Throws:

IOException

bucketDocCount

public final int bucketDocCount(long bucketOrd)

Utility method to return the number of documents that fell in the given bucket (identified by the bucket ordinal)

bucketAggregations

protected final InternalAggregations bucketAggregations(long bucketOrd)

Required method to build the child aggregations of the given bucket (identified by the bucket ordinal).

bucketEmptyAggregations

protected final InternalAggregations bucketEmptyAggregations()

Utility method to build empty aggregations of the sub aggregators.

close

public final void close()

Description copied from class: Aggregator

Called upon release of the aggregator.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Releasable

Overrides:

close in class Aggregator