Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations

Class AggregationReduceContext.ForFinal

java.lang.Object

org.elasticsearch.search.aggregations.AggregationReduceContext

org.elasticsearch.search.aggregations.AggregationReduceContext.ForFinal

Enclosing class:

AggregationReduceContext

public static final class AggregationReduceContext.ForFinal
extends AggregationReduceContext

A AggregationReduceContext to perform the final reduction.

Nested Class Summary

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

AggregationReduceContext.Builder, AggregationReduceContext.ForFinal, AggregationReduceContext.ForPartial

Constructor Summary

Constructors

Constructor	Description
ForFinal(BigArrays bigArrays, ScriptService scriptService, Supplier<Boolean> isCanceled, AggregationBuilder builder, IntConsumer multiBucketConsumer, PipelineAggregator.PipelineTree pipelineTreeRoot)
ForFinal(BigArrays bigArrays, ScriptService scriptService, Supplier<Boolean> isCanceled, AggregatorFactories.Builder builders, IntConsumer multiBucketConsumer)

Method Summary

Modifier and Type	Method	Description
protected void	consumeBucketCountAndMaybeBreak(int size)
protected AggregationReduceContext	forSubAgg(AggregationBuilder sub)
boolean	isFinalReduce()	Returns true iff the current reduce phase is the final reduce phase.
PipelineAggregator.PipelineTree	pipelineTreeRoot()	The root of the tree of pipeline aggregations for this request.

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

bigArrays, builder, consumeBucketsAndMaybeBreak, forAgg, isCanceled, scriptService

Methods inherited from class java.lang.Object

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

Constructor Details

ForFinal

public ForFinal(BigArrays bigArrays,
 ScriptService scriptService,
 Supplier<Boolean> isCanceled,
 AggregatorFactories.Builder builders,
 IntConsumer multiBucketConsumer)

ForFinal

public ForFinal(BigArrays bigArrays,
 ScriptService scriptService,
 Supplier<Boolean> isCanceled,
 AggregationBuilder builder,
 IntConsumer multiBucketConsumer,
 PipelineAggregator.PipelineTree pipelineTreeRoot)

Method Details

isFinalReduce

public boolean isFinalReduce()

Description copied from class: AggregationReduceContext

Returns true iff the current reduce phase is the final reduce phase. This indicates if operations like pipeline aggregations should be applied or if specific features like minDocCount should be taken into account. Operations that are potentially losing information can only be applied during the final reduce phase.

Specified by:

isFinalReduce in class AggregationReduceContext

consumeBucketCountAndMaybeBreak

protected void consumeBucketCountAndMaybeBreak(int size)

Specified by:

consumeBucketCountAndMaybeBreak in class AggregationReduceContext

pipelineTreeRoot

public PipelineAggregator.PipelineTree pipelineTreeRoot()

Description copied from class: AggregationReduceContext

The root of the tree of pipeline aggregations for this request.

Specified by:

pipelineTreeRoot in class AggregationReduceContext

forSubAgg

protected AggregationReduceContext forSubAgg(AggregationBuilder sub)

Specified by:

forSubAgg in class AggregationReduceContext