Module org.elasticsearch.compute

Package org.elasticsearch.compute.aggregation

Record Class GroupingAggregator

java.lang.Object

java.lang.Record

org.elasticsearch.compute.aggregation.GroupingAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, org.elasticsearch.core.Releasable

public record GroupingAggregator(GroupingAggregatorFunction aggregatorFunction, AggregatorMode mode)
extends Record
implements org.elasticsearch.core.Releasable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GroupingAggregator.Factory

Constructor Summary

Constructors

Constructor	Description
GroupingAggregator(GroupingAggregatorFunction aggregatorFunction, AggregatorMode mode)	Creates an instance of a GroupingAggregator record class.

Method Summary

Modifier and Type	Method	Description
GroupingAggregatorFunction	aggregatorFunction()	Returns the value of the aggregatorFunction record component.
void	close()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	evaluate(Block[] blocks, int offset, IntVector selected, GroupingAggregatorEvaluationContext evaluationContext)	Build the results for this aggregation.
int	evaluateBlockCount()	The number of Blocks required for evaluation.
final int	hashCode()	Returns a hash code value for this object.
AggregatorMode	mode()	Returns the value of the mode record component.
GroupingAggregatorFunction.AddInput	prepareProcessPage(SeenGroupIds seenGroupIds, Page page)	Prepare to process a single page of results.
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

GroupingAggregator

public GroupingAggregator(GroupingAggregatorFunction aggregatorFunction,
 AggregatorMode mode)

Creates an instance of a GroupingAggregator record class.

Parameters:

aggregatorFunction - the value for the aggregatorFunction record component

mode - the value for the mode record component

Method Details

evaluateBlockCount

public int evaluateBlockCount()

The number of Blocks required for evaluation.

prepareProcessPage

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

Prepare to process a single page of results.

evaluate

public void evaluate(Block[] blocks,
 int offset,
 IntVector selected,
 GroupingAggregatorEvaluationContext evaluationContext)

Build the results for this aggregation.

Parameters:

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

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface org.elasticsearch.core.Releasable

toString

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

aggregatorFunction

public GroupingAggregatorFunction aggregatorFunction()

Returns the value of the aggregatorFunction record component.

Returns:

the value of the aggregatorFunction record component

mode

public AggregatorMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component