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.terms.TermsAggregator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.apache.lucene.search.Collector, Releasable

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.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<Aggregator>	aggsUsedForSorting
protected TermsAggregator.BucketCountThresholds	bucketCountThresholds
protected Aggregator.SubAggCollectionMode	collectMode
protected DocValueFormat	format
protected Terms.Order	order

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 and Description
TermsAggregator(java.lang.String name, AggregatorFactories factories, SearchContext context, Aggregator parent, TermsAggregator.BucketCountThresholds bucketCountThresholds, Terms.Order order, DocValueFormat format, Aggregator.SubAggCollectionMode collectMode, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)

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, collectExistingBucket, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd

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

buildEmptySubAggregations, context, doClose, doPostCollection, doPreCollection, getDeferringCollector, getLeafCollector, getLeafCollector, metaData, name, needsScores, parent, pipelineAggregators, postCollection, preCollection, runDeferredCollections, subAggregator, subAggregators, toString

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

buildAggregation, buildEmptyAggregation, descendsFromBucketAggregator

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

wrap

Methods inherited from class java.lang.Object

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

Field Detail

format

protected final DocValueFormat format

bucketCountThresholds

protected final TermsAggregator.BucketCountThresholds bucketCountThresholds

order

protected final Terms.Order order

aggsUsedForSorting

protected final java.util.Set<Aggregator> aggsUsedForSorting

collectMode

protected final Aggregator.SubAggCollectionMode collectMode

Constructor Detail

TermsAggregator

public TermsAggregator(java.lang.String name,
                       AggregatorFactories factories,
                       SearchContext context,
                       Aggregator parent,
                       TermsAggregator.BucketCountThresholds bucketCountThresholds,
                       Terms.Order order,
                       DocValueFormat format,
                       Aggregator.SubAggCollectionMode collectMode,
                       java.util.List<PipelineAggregator> pipelineAggregators,
                       java.util.Map<java.lang.String,java.lang.Object> metaData)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

shouldDefer

protected boolean shouldDefer(Aggregator aggregator)

Description copied from class: AggregatorBase

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 AggregatorBase.runDeferredCollections(long...) for the selected set of buckets that survive the pruning.

Overrides:

shouldDefer in class AggregatorBase

Parameters:

aggregator - the child aggregator

Returns:

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