Module org.elasticsearch.compute

Package org.elasticsearch.compute.aggregation

Record Class FilteredGroupingAggregatorFunction

java.lang.Object

java.lang.Record

org.elasticsearch.compute.aggregation.FilteredGroupingAggregatorFunction

All Implemented Interfaces:

Closeable, AutoCloseable, GroupingAggregatorFunction, Releasable

public record FilteredGroupingAggregatorFunction(GroupingAggregatorFunction next, ExpressionEvaluator filter)
extends Record
implements GroupingAggregatorFunction

A GroupingAggregatorFunction that wraps another, filtering which positions are supplied to the aggregator.

This filtering works by setting all of the group ids for filtered positions to null. GroupingAggregatorFunction will then skip collecting those positions.

Nested Class Summary

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

GroupingAggregatorFunction.AddInput, GroupingAggregatorFunction.IntermediateAddInput, GroupingAggregatorFunction.PreparedForEvaluation

Constructor Summary

Constructors

Constructor	Description
FilteredGroupingAggregatorFunction(GroupingAggregatorFunction next, ExpressionEvaluator filter)	Creates an instance of a FilteredGroupingAggregatorFunction record class.

Method Summary

Modifier and Type	Method	Description
void	addIntermediateInput(int positionOffset, IntArrayBlock groupIdVector, Page page)	Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	addIntermediateInput(int positionOffset, IntBigArrayBlock groupIdVector, Page page)	Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	addIntermediateInput(int positionOffset, IntVector groupIdVector, Page page)	Add data produced by GroupingAggregatorFunction.prepareEvaluateIntermediate(org.elasticsearch.compute.data.IntVector, org.elasticsearch.compute.aggregation.GroupingAggregatorEvaluationContext).
void	close()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ExpressionEvaluator	filter()	Returns the value of the filter record component.
final int	hashCode()	Returns a hash code value for this object.
int	intermediateBlockCount()	The number of blocks used by intermediate state.
GroupingAggregatorFunction	next()	Returns the value of the next record component.
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	prepareProcessIntermediateInputPage(SeenGroupIds seenGroupIds, Page page)	Prepare to process a single page of intermediate input.
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.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FilteredGroupingAggregatorFunction

public FilteredGroupingAggregatorFunction(GroupingAggregatorFunction next,
 ExpressionEvaluator filter)

Creates an instance of a FilteredGroupingAggregatorFunction record class.

Parameters:

next - the value for the next record component

filter - the value for the filter record component

Method Details

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

prepareProcessIntermediateInputPage

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

Description copied from interface: GroupingAggregatorFunction

Prepare to process a single page of intermediate 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:

prepareProcessIntermediateInputPage in interface GroupingAggregatorFunction

addIntermediateInput

public void addIntermediateInput(int positionOffset,
 IntArrayBlock groupIdVector,
 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 groupIdVector,
 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 groupIdVector,
 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.

intermediateBlockCount

public int intermediateBlockCount()

Description copied from interface: GroupingAggregatorFunction

The number of blocks used by intermediate state.

Specified by:

intermediateBlockCount in interface GroupingAggregatorFunction

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

next

public GroupingAggregatorFunction next()

Returns the value of the next record component.

Returns:

the value of the next record component

filter

public ExpressionEvaluator filter()

Returns the value of the filter record component.

Returns:

the value of the filter record component