Module org.elasticsearch.compute

Package org.elasticsearch.compute.aggregation

Record Class FilteredAggregatorFunction

java.lang.Object

java.lang.Record

org.elasticsearch.compute.aggregation.FilteredAggregatorFunction

All Implemented Interfaces:

Closeable, AutoCloseable, AggregatorFunction, Releasable

public record FilteredAggregatorFunction(AggregatorFunction next, ExpressionEvaluator filter)
extends Record
implements AggregatorFunction

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

This works by running the filter and providing its results in the mask parameter for addRawInput(org.elasticsearch.compute.data.Page, org.elasticsearch.compute.data.BooleanVector).

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addIntermediateInput(Page page)	Add a pre-aggregated page worth of "intermediate" input.
void	addRawInput(Page page, BooleanVector mask)	Add a page worth of data to the aggregation.
void	close()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	evaluateFinal(Block[] blocks, int offset, DriverContext driverContext)	Build the final results from running this agg.
void	evaluateIntermediate(Block[] blocks, int offset, DriverContext driverContext)	Build pre-aggregated "intermediate" data to pass to the AggregatorFunction.addIntermediateInput(org.elasticsearch.compute.data.Page).
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.
AggregatorFunction	next()	Returns the value of the next record component.
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

FilteredAggregatorFunction

public FilteredAggregatorFunction(AggregatorFunction next,
 ExpressionEvaluator filter)

Creates an instance of a FilteredAggregatorFunction record class.

Parameters:

next - the value for the next record component

filter - the value for the filter record component

Method Details

addRawInput

public void addRawInput(Page page,
 BooleanVector mask)

Description copied from interface: AggregatorFunction

Add a page worth of data to the aggregation.

Specified by:

addRawInput in interface AggregatorFunction

Parameters:

mask - a mask to apply to the positions. If the position is false then the aggregation should skip it.

addIntermediateInput

public void addIntermediateInput(Page page)

Description copied from interface: AggregatorFunction

Add a pre-aggregated page worth of "intermediate" input. This intermediate input will have been created by calling AggregatorFunction.evaluateIntermediate(org.elasticsearch.compute.data.Block[], int, org.elasticsearch.compute.operator.DriverContext) on this agg, though likely in a different Driver and maybe on a different physical node.

Specified by:

addIntermediateInput in interface AggregatorFunction

evaluateIntermediate

public void evaluateIntermediate(Block[] blocks,
 int offset,
 DriverContext driverContext)

Description copied from interface: AggregatorFunction

Build pre-aggregated "intermediate" data to pass to the AggregatorFunction.addIntermediateInput(org.elasticsearch.compute.data.Page).

Specified by:

evaluateIntermediate in interface AggregatorFunction

Parameters:

blocks - write the output into this array

offset - write the first Block at this offset in blocks

evaluateFinal

public void evaluateFinal(Block[] blocks,
 int offset,
 DriverContext driverContext)

Description copied from interface: AggregatorFunction

Build the final results from running this agg.

Specified by:

evaluateFinal in interface AggregatorFunction

Parameters:

blocks - write the output into this array

offset - write the first Block at this offset in blocks

intermediateBlockCount

public int intermediateBlockCount()

Description copied from interface: AggregatorFunction

The number of blocks used by intermediate state.

Specified by:

intermediateBlockCount in interface AggregatorFunction

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