Module org.elasticsearch.server
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,Releasable
- Direct Known Subclasses:
GlobalOrdinalsStringTermsAggregator,MapStringTermsAggregator,NumericTermsAggregator
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic final recordThis class provides bucket thresholds configuration, but can be used ensure default value immutabilityNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator
BucketsAggregator.BucketBuilderForFixedCount<B>, BucketsAggregator.BucketBuilderForVariable<B>, BucketsAggregator.ResultBuilderForVariable<B>, BucketsAggregator.SingleBucketResultBuilderNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.Aggregator
Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionModeNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.BucketCollector
BucketCollector.BucketCollectorWrapper -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final Set<Aggregator> protected final TermsAggregator.BucketCountThresholdsprotected final Aggregator.SubAggCollectionModeprotected final DocValueFormatprotected final BucketOrderFields inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator
docCountProviderFields inherited from class org.elasticsearch.search.aggregations.AggregatorBase
collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregatorsFields inherited from class org.elasticsearch.search.aggregations.BucketCollector
NO_OP_BUCKET_COLLECTOR, NO_OP_COLLECTOR -
Constructor Summary
ConstructorsConstructorDescriptionTermsAggregator(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 TypeMethodDescriptionstatic Set<Aggregator> aggsUsedForSorting(Aggregator root, BucketOrder order) Walks through bucket order and extracts all aggregations used for sortingstatic booleanprotected booleanshouldDefer(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, prepareSubAggsMethods inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator
bucketComparator, bucketDocCount, buildAggregationsForFixedBucketCount, buildAggregationsForSingleBucket, buildAggregationsForVariableBuckets, buildSubAggsForAllBuckets, buildSubAggsForAllBuckets, buildSubAggsForBuckets, checkRealMemoryCBForInternalBucket, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, preGetSubLeafCollectors, resolveSortPath, rewriteBucketsMethods inherited from class org.elasticsearch.search.aggregations.AggregatorBase
addRequestCircuitBreakerBytes, bigArrays, buildAggregations, buildEmptySubAggregations, checkRealMemoryCB, doClose, doPostCollection, getLeafCollector, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, releaseAggregations, scoreMode, searcher, subAggregator, subAggregators, topLevelQuery, toStringMethods inherited from class org.elasticsearch.search.aggregations.Aggregator
buildAggregations, buildEmptyAggregation, buildTopLevel, resolveSortPathOnValidAggMethods inherited from class org.elasticsearch.search.aggregations.BucketCollector
asCollector
-
Field Details
-
format
-
bucketCountThresholds
-
order
-
aggsUsedForSorting
-
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
Walks through bucket order and extracts all aggregations used for sorting -
descendsFromNestedAggregator
-
shouldDefer
Description copied from class:DeferableBucketAggregatorThis 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:
shouldDeferin classDeferableBucketAggregator- Parameters:
aggregator- the child aggregator- Returns:
- true if the aggregator should be deferred until a first pass at collection has completed
-