org.elasticsearch.search.aggregations.bucket

Class SingleBucketAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.SingleBucketAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

Direct Known Subclasses:

FilterAggregator, GlobalAggregator, MissingAggregator, NestedAggregator, ParentToChildrenAggregator, ReverseNestedAggregator

public abstract class SingleBucketAggregator
extends BucketsAggregator

A bucket aggregator that doesn't create new buckets.

Nested Class Summary

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

Modifier	Constructor and Description
protected	SingleBucketAggregator(String name, AggregatorFactories factories, AggregationContext aggregationContext, Aggregator parent)

Method Summary

Modifier and Type	Method and Description
boolean	shouldCollect()

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

Constructor Detail

SingleBucketAggregator

protected SingleBucketAggregator(String name,
                                 AggregatorFactories factories,
                                 AggregationContext aggregationContext,
                                 Aggregator parent)

Method Detail

shouldCollect

public boolean shouldCollect()

Specified by:

shouldCollect in class Aggregator

Returns:

Whether this aggregator is in the state where it can collect documents. Some aggregators can do their aggregations without actually collecting documents, for example, an aggregator that computes stats over unmapped fields doesn't need to collect anything as it knows to just return "empty" stats as the aggregation result.