java.lang.Object

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

All Implemented Interfaces:: java.io.Closeable, java.lang.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 java.util.Set<Aggregator>`	`aggsUsedForSorting`
`protected TermsAggregator.BucketCountThresholds`	`bucketCountThresholds`
`protected Aggregator.SubAggCollectionMode`	`collectMode`
`protected DocValueFormat`	`format`
`protected BucketOrder`	`order`
`protected java.util.Comparator<InternalTerms.Bucket<?>>`	`partiallyBuiltBucketComparator`

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors
Constructor	Description
`TermsAggregator(java.lang.String name, AggregatorFactories factories, SearchContext context, Aggregator parent, TermsAggregator.BucketCountThresholds bucketCountThresholds, BucketOrder order, DocValueFormat format, Aggregator.SubAggCollectionMode collectMode, java.util.Map<java.lang.String,java.lang.Object> metadata)`

Method Summary

Modifier and Type	Method	Description
`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

beforeBuildingBuckets, collectDebugInfo, doPreCollection, getDeferringCollector

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

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doClose, doPostCollection, getLeafCollector, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, preGetSubLeafCollectors, scoreMode, subAggregator, subAggregators, 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 java.util.Comparator<InternalTerms.Bucket<?>> partiallyBuiltBucketComparator
- aggsUsedForSorting
  
  protected final java.util.Set<Aggregator> aggsUsedForSorting
- collectMode
  
  protected final Aggregator.SubAggCollectionMode collectMode
Constructor Details
- TermsAggregator
  
  public TermsAggregator(java.lang.String name, AggregatorFactories factories, SearchContext context, Aggregator parent, TermsAggregator.BucketCountThresholds bucketCountThresholds, BucketOrder order, DocValueFormat format, Aggregator.SubAggCollectionMode collectMode, java.util.Map<java.lang.String,java.lang.Object> metadata) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
Method Details
- 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

Class TermsAggregator

Nested Class Summary

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

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