Package 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.AggregatorBase

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.DeferableBucketAggregator

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

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, Releasable

Direct Known Subclasses:

GlobalOrdinalsStringTermsAggregator, MapStringTermsAggregator, NumericTermsAggregator

public abstract class TermsAggregator
extends DeferableBucketAggregator

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermsAggregator.BucketCountThresholds

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

BucketsAggregator.BucketBuilderForFixedCount<B>, BucketsAggregator.BucketBuilderForVariable<B>, BucketsAggregator.ResultBuilderForVariable<B>, BucketsAggregator.SingleBucketResultBuilder

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field	Description
protected final Set<Aggregator>	aggsUsedForSorting
protected final TermsAggregator.BucketCountThresholds	bucketCountThresholds
protected final Aggregator.SubAggCollectionMode	collectMode
protected final DocValueFormat	format
protected final BucketOrder	order
protected final Comparator<InternalTerms.Bucket<?>>	partiallyBuiltBucketComparator

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

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_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
TermsAggregator(String name, AggregatorFactories factories, AggregationContext context, Aggregator parent, TermsAggregator.BucketCountThresholds bucketCountThresholds, BucketOrder order, DocValueFormat format, Aggregator.SubAggCollectionMode collectMode, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
static Set<Aggregator>	aggsUsedForSorting(Aggregator root, BucketOrder order)	Walks through bucket order and extracts all aggregations used for sorting
static boolean	descendsFromNestedAggregator(Aggregator parent)
protected boolean	shouldDefer(Aggregator aggregator)	This method should be overridden 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.DeferableBucketAggregator

buildDeferringCollector, collectDebugInfo, deferringCollector, doPreCollection, prepareSubAggs

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

bucketComparator, bucketDocCount, buildAggregationsForFixedBucketCount, buildAggregationsForSingleBucket, buildAggregationsForVariableBuckets, buildSubAggsForAllBuckets, buildSubAggsForBuckets, buildSubAggsForBuckets, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, preGetSubLeafCollectors, resolveSortPath, rewriteBuckets

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

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

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

buildAggregations, buildEmptyAggregation, buildTopLevel, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Field Details

format

protected final DocValueFormat format

bucketCountThresholds

protected final TermsAggregator.BucketCountThresholds bucketCountThresholds

order

protected final BucketOrder order

partiallyBuiltBucketComparator

protected final Comparator<InternalTerms.Bucket<?>> partiallyBuiltBucketComparator

aggsUsedForSorting

protected final Set<Aggregator> aggsUsedForSorting

collectMode

protected final Aggregator.SubAggCollectionMode collectMode

Constructor Details

TermsAggregator

public TermsAggregator(String name,
 AggregatorFactories factories,
 AggregationContext context,
 Aggregator parent,
 TermsAggregator.BucketCountThresholds bucketCountThresholds,
 BucketOrder order,
 DocValueFormat format,
 Aggregator.SubAggCollectionMode collectMode,
 Map<String,Object> metadata)
                throws IOException

Throws:

IOException

Method Details

aggsUsedForSorting

public static Set<Aggregator> aggsUsedForSorting(Aggregator root,
 BucketOrder order)

Walks through bucket order and extracts all aggregations used for sorting

descendsFromNestedAggregator

public static boolean descendsFromNestedAggregator(Aggregator parent)

shouldDefer

protected boolean shouldDefer(Aggregator aggregator)

Description copied from class: DeferableBucketAggregator

This method should be overridden 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.

Overrides:

shouldDefer in class DeferableBucketAggregator

Parameters:

aggregator - the child aggregator

Returns:

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