org.elasticsearch.search.aggregations.bucket.terms

Class TermsAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

Direct Known Subclasses:

GlobalOrdinalsStringTermsAggregator, LongTermsAggregator, StringTermsAggregator

public abstract class TermsAggregator
extends BucketsAggregator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TermsAggregator.BucketCountThresholds

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

Modifier and Type	Field and Description
protected Set<Aggregator>	aggsUsedForSorting
protected TermsAggregator.BucketCountThresholds	bucketCountThresholds
protected Terms.Order	order
protected Aggregator.SubAggCollectionMode	subAggCollectMode

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
TermsAggregator(String name, Aggregator.BucketAggregationMode bucketAggregationMode, AggregatorFactories factories, long estimatedBucketsCount, AggregationContext context, Aggregator parent, TermsAggregator.BucketCountThresholds bucketCountThresholds, Terms.Order order, Aggregator.SubAggCollectionMode subAggCollectMode)

Method Summary

Modifier and Type	Method and Description
protected boolean	shouldDefer(Aggregator aggregator) This method should be overidden by subclasses that want to defer calculation of a child aggregation until a first pass is complete and a set of buckets has been pruned.

Methods inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator

bucketAggregations, bucketDocCount, bucketEmptyAggregations, close, collectBucket, collectBucketNoCounts, collectExistingBucket, getDocCounts, incrementBucketDocCount, maxBucketOrd

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, 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

Field Detail

bucketCountThresholds

protected final TermsAggregator.BucketCountThresholds bucketCountThresholds

order

protected Terms.Order order

aggsUsedForSorting

protected Set<Aggregator> aggsUsedForSorting

subAggCollectMode

protected Aggregator.SubAggCollectionMode subAggCollectMode

Constructor Detail

TermsAggregator

public TermsAggregator(String name,
                       Aggregator.BucketAggregationMode bucketAggregationMode,
                       AggregatorFactories factories,
                       long estimatedBucketsCount,
                       AggregationContext context,
                       Aggregator parent,
                       TermsAggregator.BucketCountThresholds bucketCountThresholds,
                       Terms.Order order,
                       Aggregator.SubAggCollectionMode subAggCollectMode)

Method Detail

shouldDefer

protected boolean shouldDefer(Aggregator aggregator)

Description copied from class: Aggregator

This method should be overidden by subclasses that want to defer calculation of a child aggregation until a first pass is complete and a set of buckets has been pruned. Deferring collection will require the recording of all doc/bucketIds from the first pass and then the sub class should call Aggregator.runDeferredCollections(long...) for the selected set of buckets that survive the pruning.

Overrides:

shouldDefer in class Aggregator

Parameters:

aggregator - the child aggregator

Returns:

true if the aggregator should be deferred until a first pass at collection has completed