Module org.elasticsearch.compute

Package org.elasticsearch.compute.aggregation

Record Class GroupingAggregatorFunction.IntermediateAddInput

java.lang.Object

java.lang.Record

org.elasticsearch.compute.aggregation.GroupingAggregatorFunction.IntermediateAddInput

All Implemented Interfaces:

Closeable, AutoCloseable, GroupingAggregatorFunction.AddInput, Releasable

Enclosing interface:

GroupingAggregatorFunction

public static record GroupingAggregatorFunction.IntermediateAddInput(GroupingAggregatorFunction fn, SeenGroupIds seenGroupIds, Page page)
extends Record
implements GroupingAggregatorFunction.AddInput

Constructor Summary

Constructors

Constructor	Description
IntermediateAddInput(GroupingAggregatorFunction fn, SeenGroupIds seenGroupIds, Page page)	Creates an instance of a IntermediateAddInput record class.

Method Summary

Modifier and Type	Method	Description
void	add(int positionOffset, IntArrayBlock groupIds)	Implementation of GroupingAggregatorFunction.AddInput.add(int, IntBlock) for a specific type of block.
void	add(int positionOffset, IntBigArrayBlock groupIds)	Implementation of GroupingAggregatorFunction.AddInput.add(int, IntBlock) for a specific type of block.
void	add(int positionOffset, IntVector groupIds)	Send a batch of group ids to the aggregator.
void	close()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
GroupingAggregatorFunction	fn()	Returns the value of the fn record component.
final int	hashCode()	Returns a hash code value for this object.
Page	page()	Returns the value of the page record component.
SeenGroupIds	seenGroupIds()	Returns the value of the seenGroupIds 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

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

add

Constructor Details

IntermediateAddInput

public IntermediateAddInput(GroupingAggregatorFunction fn,
 SeenGroupIds seenGroupIds,
 Page page)

Creates an instance of a IntermediateAddInput record class.

Parameters:

fn - the value for the fn record component

seenGroupIds - the value for the seenGroupIds record component

page - the value for the page record component

Method Details

add

public void add(int positionOffset,
 IntArrayBlock groupIds)

Description copied from interface: GroupingAggregatorFunction.AddInput

Implementation of GroupingAggregatorFunction.AddInput.add(int, IntBlock) for a specific type of block.

Specified by:

add in interface GroupingAggregatorFunction.AddInput

add

public void add(int positionOffset,
 IntBigArrayBlock groupIds)

Description copied from interface: GroupingAggregatorFunction.AddInput

Implementation of GroupingAggregatorFunction.AddInput.add(int, IntBlock) for a specific type of block.

Specified by:

add in interface GroupingAggregatorFunction.AddInput

add

public void add(int positionOffset,
 IntVector groupIds)

Description copied from interface: GroupingAggregatorFunction.AddInput

Send a batch of group ids to the aggregator. The groupIds may be offset from the start of the block to allow for sending chunks of group ids.

See GroupingAggregatorFunction.AddInput.add(int, IntBlock) for discussion on the offset. This method can only be called with blocks contained in a Vector which only allows a single value per position.

Specified by:

add in interface GroupingAggregatorFunction.AddInput

Parameters:

positionOffset - offset into the Page used to build this GroupingAggregatorFunction.AddInput of these ids

groupIds - Vector of group id, some of which may be null or multivalued

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.

fn

public GroupingAggregatorFunction fn()

Returns the value of the fn record component.

Returns:

the value of the fn record component

seenGroupIds

public SeenGroupIds seenGroupIds()

Returns the value of the seenGroupIds record component.

Returns:

the value of the seenGroupIds record component

page

public Page page()

Returns the value of the page record component.

Returns:

the value of the page record component