Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket

Class BucketsAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.AggregatorBase

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable

Direct Known Subclasses:

AbstractHistogramAggregator, BinaryRangeAggregator, CompositeAggregator, DeferableBucketAggregator, FiltersAggregator, GeoGridAggregator, GlobalAggregator, IpPrefixAggregator, MissingAggregator, NestedAggregator, RandomSamplerAggregator, RangeAggregator, ReverseNestedAggregator

public abstract class BucketsAggregator
extends AggregatorBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	BucketsAggregator.BucketBuilderForFixedCount<B>
protected static interface	BucketsAggregator.BucketBuilderForVariable<B>
protected static interface	BucketsAggregator.ResultBuilderForVariable<B>
protected static interface	BucketsAggregator.SingleBucketResultBuilder

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

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

BucketCollector.BucketCollectorWrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected final DocCountProvider	docCountProvider

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

collectableSubAggregators, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_BUCKET_COLLECTOR, NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
BucketsAggregator(String name, AggregatorFactories factories, AggregationContext aggCtx, Aggregator parent, CardinalityUpperBound bucketCardinality, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
Aggregator.BucketComparator	bucketComparator(String key, SortOrder order)	Builds a comparator that compares two buckets aggregated by this Aggregator.
final long	bucketDocCount(long bucketOrd)	Utility method to return the number of documents that fell in the given bucket (identified by the bucket ordinal)
protected final <B> InternalAggregation[]	buildAggregationsForFixedBucketCount(long[] owningBucketOrds, int bucketsPerOwningBucketOrd, BucketsAggregator.BucketBuilderForFixedCount<B> bucketBuilder, Function<List<B>,InternalAggregation> resultBuilder)	Build aggregation results for an aggregator that has a fixed number of buckets per owning ordinal.
protected final InternalAggregation[]	buildAggregationsForSingleBucket(long[] owningBucketOrds, BucketsAggregator.SingleBucketResultBuilder resultBuilder)	Build aggregation results for an aggregator that always contain a single bucket.
protected final <B> InternalAggregation[]	buildAggregationsForVariableBuckets(long[] owningBucketOrds, LongKeyedBucketOrds bucketOrds, BucketsAggregator.BucketBuilderForVariable<B> bucketBuilder, BucketsAggregator.ResultBuilderForVariable<B> resultBuilder)	Build aggregation results for an aggregator with a varying number of long keyed buckets.
protected final <B> void	buildSubAggsForAllBuckets(B[][] buckets, ToLongFunction<B> bucketToOrd, BiConsumer<B,InternalAggregations> setAggs)	Build the sub aggregation results for a list of buckets and set them on the buckets.
protected final IntFunction<InternalAggregations>	buildSubAggsForBuckets(long[] bucketOrdsToCollect)	Build the results of the sub-aggregations of the buckets at each of the provided ordinals.
final void	close()	Called upon release of the aggregator.
final void	collectBucket(LeafBucketCollector subCollector, int doc, long bucketOrd)	Utility method to collect the given doc in the given bucket (identified by the bucket ordinal)
final void	collectExistingBucket(LeafBucketCollector subCollector, int doc, long bucketOrd)	Same as collectBucket(LeafBucketCollector, int, long), but doesn't check if the docCounts needs to be re-sized.
static boolean	descendsFromGlobalAggregator(Aggregator parent)
LongArray	getDocCounts()
final void	grow(long maxBucketOrd)	Ensure there are at least maxBucketOrd buckets available.
final void	incrementBucketDocCount(long bucketOrd, long inc)	Utility method to increment the doc counts of the given bucket (identified by the bucket ordinal)
final long	maxBucketOrd()	Return an upper bound of the maximum bucket ordinal seen so far.
protected void	preGetSubLeafCollectors(org.apache.lucene.index.LeafReaderContext ctx)	Can be overridden by aggregator implementations that like the perform an operation before the leaf collectors of children aggregators are instantiated for the next segment.
protected void	prepareSubAggs(long[] ordsToCollect)	Hook to allow taking an action before building the sub agg results.
Aggregator	resolveSortPath(AggregationPath.PathElement next, Iterator<AggregationPath.PathElement> path)	Resolve a sort path to the target.
final void	rewriteBuckets(long newNumBuckets, LongUnaryOperator mergeMap)	Merge doc counts.

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

addRequestCircuitBreakerBytes, bigArrays, buildEmptySubAggregations, doClose, doPostCollection, doPreCollection, getLeafCollector, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, releaseAggregations, scoreMode, searcher, subAggregator, subAggregators, topLevelQuery, toString

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

buildAggregations, buildEmptyAggregation, buildTopLevel, collectDebugInfo, resolveSortPathOnValidAgg

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

asCollector

Methods inherited from class java.lang.Object

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

Field Details

docCountProvider

protected final DocCountProvider docCountProvider

Constructor Details

BucketsAggregator

public BucketsAggregator(String name,
 AggregatorFactories factories,
 AggregationContext aggCtx,
 Aggregator parent,
 CardinalityUpperBound bucketCardinality,
 Map<String,Object> metadata)
                  throws IOException

Throws:

IOException

Method Details

maxBucketOrd

public final long maxBucketOrd()

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

grow

public final void grow(long maxBucketOrd)

Ensure there are at least maxBucketOrd buckets available.

collectBucket

public final void collectBucket(LeafBucketCollector subCollector,
 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

public final void collectExistingBucket(LeafBucketCollector subCollector,
 int doc,
 long bucketOrd)
                                 throws IOException

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

Throws:

IOException

rewriteBuckets

public final void rewriteBuckets(long newNumBuckets,
 LongUnaryOperator mergeMap)

Merge doc counts. If the Aggregator is delayed then you must also call BestBucketsDeferringCollector.rewriteBuckets(LongUnaryOperator) to merge the delayed buckets.

Parameters:

mergeMap - a unary operator which maps a bucket's ordinal to the ordinal it should be merged with. If a bucket's ordinal is mapped to -1 then the bucket is removed entirely.

getDocCounts

public LongArray getDocCounts()

incrementBucketDocCount

public final void incrementBucketDocCount(long bucketOrd,
 long inc)

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

bucketDocCount

public final long bucketDocCount(long bucketOrd)

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

prepareSubAggs

protected void prepareSubAggs(long[] ordsToCollect)
                       throws IOException

Hook to allow taking an action before building the sub agg results.

Throws:

IOException

buildSubAggsForBuckets

protected final IntFunction<InternalAggregations> buildSubAggsForBuckets(long[] bucketOrdsToCollect)
                                                                  throws IOException

Build the results of the sub-aggregations of the buckets at each of the provided ordinals.

Most aggregations should probably use something like buildSubAggsForAllBuckets(Object[][], ToLongFunction, BiConsumer) or buildAggregationsForVariableBuckets(long[], LongKeyedBucketOrds, BucketBuilderForVariable, ResultBuilderForVariable) or buildAggregationsForFixedBucketCount(long[], int, BucketBuilderForFixedCount, Function) or buildAggregationsForSingleBucket(long[], SingleBucketResultBuilder) instead of calling this directly.

Returns:

the sub-aggregation results in the same order as the provided array of ordinals

Throws:

IOException

buildSubAggsForAllBuckets

protected final <B> void buildSubAggsForAllBuckets(B[][] buckets,
 ToLongFunction<B> bucketToOrd,
 BiConsumer<B,InternalAggregations> setAggs)
                                            throws IOException

Build the sub aggregation results for a list of buckets and set them on the buckets. This is usually used by aggregations that are selective in which bucket they build. They use some mechanism of selecting a list of buckets to build use this method to "finish" building the results.

Parameters:

buckets - the buckets to finish building

bucketToOrd - how to convert a bucket into an ordinal

setAggs - how to set the sub-aggregation results on a bucket

Throws:

IOException

buildAggregationsForFixedBucketCount

protected final <B> InternalAggregation[] buildAggregationsForFixedBucketCount(long[] owningBucketOrds,
 int bucketsPerOwningBucketOrd,
 BucketsAggregator.BucketBuilderForFixedCount<B> bucketBuilder,
 Function<List<B>,InternalAggregation> resultBuilder)
                                                                        throws IOException

Build aggregation results for an aggregator that has a fixed number of buckets per owning ordinal.

Type Parameters:

B - the type of the bucket

Parameters:

owningBucketOrds - owning bucket ordinals for which to build the results

bucketsPerOwningBucketOrd - how many buckets there are per ord

bucketBuilder - how to build a bucket

resultBuilder - how to build a result from buckets

Throws:

IOException

buildAggregationsForSingleBucket

protected final InternalAggregation[] buildAggregationsForSingleBucket(long[] owningBucketOrds,
 BucketsAggregator.SingleBucketResultBuilder resultBuilder)
                                                                throws IOException

Build aggregation results for an aggregator that always contain a single bucket.

Parameters:

owningBucketOrds - owning bucket ordinals for which to build the results

resultBuilder - how to build a result from the sub aggregation results

Throws:

IOException

buildAggregationsForVariableBuckets

protected final <B> InternalAggregation[] buildAggregationsForVariableBuckets(long[] owningBucketOrds,
 LongKeyedBucketOrds bucketOrds,
 BucketsAggregator.BucketBuilderForVariable<B> bucketBuilder,
 BucketsAggregator.ResultBuilderForVariable<B> resultBuilder)
                                                                       throws IOException

Build aggregation results for an aggregator with a varying number of long keyed buckets.

Parameters:

owningBucketOrds - owning bucket ordinals for which to build the results

bucketOrds - hash of values to the bucket ordinal

Throws:

IOException

close

public final void close()

Description copied from class: AggregatorBase

Called upon release of the aggregator.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

Overrides:

close in class AggregatorBase

resolveSortPath

public Aggregator resolveSortPath(AggregationPath.PathElement next,
 Iterator<AggregationPath.PathElement> path)

Description copied from class: Aggregator

Resolve a sort path to the target.

The default implementation throws an exception but we override it on aggregations that support sorting.

Overrides:

resolveSortPath in class Aggregator

bucketComparator

public Aggregator.BucketComparator bucketComparator(String key,
 SortOrder order)

Description copied from class: Aggregator

Builds a comparator that compares two buckets aggregated by this Aggregator.

The default implementation throws an exception but we override it on aggregations that support sorting.

Overrides:

bucketComparator in class Aggregator

descendsFromGlobalAggregator

public static boolean descendsFromGlobalAggregator(Aggregator parent)

preGetSubLeafCollectors

protected void preGetSubLeafCollectors(org.apache.lucene.index.LeafReaderContext ctx)
                                throws IOException

Description copied from class: AggregatorBase

Can be overridden by aggregator implementations that like the perform an operation before the leaf collectors of children aggregators are instantiated for the next segment.

Overrides:

preGetSubLeafCollectors in class AggregatorBase

Throws:

IOException