Module org.elasticsearch.compute

Package org.elasticsearch.compute.aggregation

Class PresentGroupingAggregatorFunction

java.lang.Object

org.elasticsearch.compute.aggregation.PresentGroupingAggregatorFunction

All Implemented Interfaces:

Closeable, AutoCloseable, GroupingAggregatorFunction, Releasable

public class PresentGroupingAggregatorFunction
extends Object
implements GroupingAggregatorFunction

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.compute.aggregation.GroupingAggregatorFunction

GroupingAggregatorFunction.AddInput, GroupingAggregatorFunction.IntermediateAddInput, GroupingAggregatorFunction.PreparedForEvaluation

Method Summary

Modifier and Type	Method	Description
void	addIntermediateInput(int positionOffset, IntArrayBlock groups, Page page)	Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	addIntermediateInput(int positionOffset, IntBigArrayBlock groups, Page page)	Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	addIntermediateInput(int positionOffset, IntVector groups, Page page)	Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	close()
int	intermediateBlockCount()	The number of blocks used by intermediate state.
static List<IntermediateStateDesc>	intermediateStateDesc()
GroupingAggregatorFunction.PreparedForEvaluation	prepareEvaluateFinal(IntVector selected, GroupingAggregatorEvaluationContext ctx)	Prepare to build the final results for this aggregation.
GroupingAggregatorFunction.PreparedForEvaluation	prepareEvaluateIntermediate(IntVector selected, GroupingAggregatorEvaluationContext ctx)	Prepare to build the intermediate results for this aggregation.
GroupingAggregatorFunction.AddInput	prepareProcessRawInputPage(SeenGroupIds seenGroupIds, Page page)	Prepare to process a single page of raw input.
void	selectedMayContainUnseenGroups(SeenGroupIds seenGroupIds)	Call this to signal to the aggregation that the selected parameter that's passed to GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) or GroupingAggregatorFunction.prepareEvaluateFinal(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) may reference groups that haven't been seen.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.compute.aggregation.GroupingAggregatorFunction

prepareProcessIntermediateInputPage

Method Details

intermediateStateDesc

public static List<IntermediateStateDesc> intermediateStateDesc()

intermediateBlockCount

public int intermediateBlockCount()

Description copied from interface: GroupingAggregatorFunction

The number of blocks used by intermediate state.

Specified by:

intermediateBlockCount in interface GroupingAggregatorFunction

prepareProcessRawInputPage

public GroupingAggregatorFunction.AddInput prepareProcessRawInputPage(SeenGroupIds seenGroupIds,
 Page page)

Description copied from interface: GroupingAggregatorFunction

Prepare to process a single page of raw input.

This should load the input Blocks and check their types and select an optimal path and return that path as an GroupingAggregatorFunction.AddInput.

Returns null to opt out of the callback loop for this page entirely, e.g. when the values block is all-null and contributes nothing to the aggregation.

Specified by:

prepareProcessRawInputPage in interface GroupingAggregatorFunction

selectedMayContainUnseenGroups

public void selectedMayContainUnseenGroups(SeenGroupIds seenGroupIds)

Description copied from interface: GroupingAggregatorFunction

Call this to signal to the aggregation that the selected parameter that's passed to GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) or GroupingAggregatorFunction.prepareEvaluateFinal(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext) may reference groups that haven't been seen. This puts the underlying storage into a mode where it'll track which group ids have been seen, even if that increases the overhead.

Specified by:

selectedMayContainUnseenGroups in interface GroupingAggregatorFunction

addIntermediateInput

public void addIntermediateInput(int positionOffset,
 IntArrayBlock groups,
 Page page)

Description copied from interface: GroupingAggregatorFunction

Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).

Specified by:

addIntermediateInput in interface GroupingAggregatorFunction

addIntermediateInput

public void addIntermediateInput(int positionOffset,
 IntBigArrayBlock groups,
 Page page)

Description copied from interface: GroupingAggregatorFunction

Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).

Specified by:

addIntermediateInput in interface GroupingAggregatorFunction

addIntermediateInput

public void addIntermediateInput(int positionOffset,
 IntVector groups,
 Page page)

Description copied from interface: GroupingAggregatorFunction

Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).

Specified by:

addIntermediateInput in interface GroupingAggregatorFunction

prepareEvaluateIntermediate

public GroupingAggregatorFunction.PreparedForEvaluation prepareEvaluateIntermediate(IntVector selected,
 GroupingAggregatorEvaluationContext ctx)

Description copied from interface: GroupingAggregatorFunction

Prepare to build the intermediate results for this aggregation.

Specified by:

prepareEvaluateIntermediate in interface GroupingAggregatorFunction

Parameters:

selected - the groupIds that have been selected to be included in the results. Always ascending.

prepareEvaluateFinal

public GroupingAggregatorFunction.PreparedForEvaluation prepareEvaluateFinal(IntVector selected,
 GroupingAggregatorEvaluationContext ctx)

Description copied from interface: GroupingAggregatorFunction

Prepare to build the final results for this aggregation.

Specified by:

prepareEvaluateFinal in interface GroupingAggregatorFunction

Parameters:

selected - the groupIds that have been selected to be included in the results. Always ascending.

This function is called in the coordinator node after all intermediate results have been gathered from the worker nodes, and aggregated into intermediate blocks.

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable