org.elasticsearch.search.aggregations

Class NonCollectingAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.NonCollectingAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

Direct Known Subclasses:

RangeAggregator.Unmapped

public abstract class NonCollectingAggregator
extends Aggregator

An aggregator that is not collected, this can typically be used when running an aggregation over a field that doesn't have a mapping.

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	NonCollectingAggregator(String name, AggregationContext context, Aggregator parent)
protected	NonCollectingAggregator(String name, AggregationContext context, Aggregator parent, AggregatorFactories subFactories)

Method Summary

Modifier and Type	Method and Description
InternalAggregation	buildAggregation(long owningBucketOrdinal)
void	collect(int doc, long owningBucketOrdinal) Called during the query phase, to collect & aggregate the given document.
void	setNextReader(org.apache.lucene.index.AtomicReaderContext reader)
boolean	shouldCollect()

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

bucketAggregationMode, buildEmptyAggregation, buildEmptySubAggregations, close, context, depth, doClose, doPostCollection, estimatedBucketCount, gatherAnalysis, hasParentBucketAggregator, name, parent, postCollection, preCollection, runDeferredCollections, shouldDefer, subAggregator, subAggregators

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

wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

NonCollectingAggregator

protected NonCollectingAggregator(String name,
                                  AggregationContext context,
                                  Aggregator parent,
                                  AggregatorFactories subFactories)

NonCollectingAggregator

protected NonCollectingAggregator(String name,
                                  AggregationContext context,
                                  Aggregator parent)

Method Detail

setNextReader

public final void setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

shouldCollect

public final 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.

collect

public final void collect(int doc,
                          long owningBucketOrdinal)
                   throws IOException

Description copied from class: BucketCollector

Called during the query phase, to collect & aggregate the given document.

Specified by:

collect in class BucketCollector

owningBucketOrdinal - The ordinal of the bucket this aggregator belongs to, assuming this aggregator is not a top level aggregator. Typically, aggregators with #bucketAggregationMode set to Aggregator.BucketAggregationMode.MULTI_BUCKETS will heavily depend on this ordinal. Other aggregators may or may not use it and can see this ordinal as just an extra information for the aggregation context. For top level aggregators, the ordinal will always be equal to 0.

Throws:

IOException

buildAggregation

public final InternalAggregation buildAggregation(long owningBucketOrdinal)

Specified by:

buildAggregation in class Aggregator

Returns:

The aggregated & built aggregation