Package dev.frostlake.functions.scalar

Class GroupingIdFn

java.lang.Object

dev.frostlake.functions.BuiltInFunction

dev.frostlake.functions.scalar.GroupingIdFn

public class GroupingIdFn
extends BuiltInFunction

GROUPING_ID(e1, …, en) — returns the integer bit-vector describing which of the grouping expressions are aggregated over in the current row: each ei contributes one bit (1 when it is rolled up / not in this grouping set, 0 when it is grouped by), with e1 as the most significant bit. Equivalent to GROUPING(e1, …, en) for the same argument list.

In a plain GROUP BY context this evaluates to 0. The actual per-row mask for ROLLUP/CUBE/GROUPING SETS super-group rows is computed in GroupByAggregateEvaluator (see computeGroupingMask), which overrides this base result.

Constructor Summary

Constructors

Constructor	Description
GroupingIdFn()

Method Summary

Modifier and Type	Method	Description
Object	evaluate(List<Object> args)	Computes the function's result over its already-evaluated argument values.
int	getMaxArgCount()	The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).
int	getMinArgCount()	The fewest arguments a call to this function may pass; fewer is an argument-count error.

Methods inherited from class dev.frostlake.functions.BuiltInFunction

approximateRejection, binaryRejection, booleanRejection, evaluate, fileRejection, geoRejection, getName, getReturnType, isVariadic, refusesMissingArgumentsByType, semiStructuredRejection, structuredRejection, temporalRejection, temporalRejection, temporalRejection, textRejection, uuidRejection, vectorRejection

Methods inherited from class java.lang.Object

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

Constructor Details

GroupingIdFn

public GroupingIdFn()

Method Details

evaluate

public Object evaluate(List<Object> args)

Description copied from class: BuiltInFunction

Computes the function's result over its already-evaluated argument values. A SQL NULL argument arrives as Java null, and returning null makes the SQL result NULL.

Specified by:

evaluate in class BuiltInFunction

Parameters:

args - the argument values, in call order

Returns:

the function's value for these arguments, or null for SQL NULL

getMinArgCount

public int getMinArgCount()

Description copied from class: BuiltInFunction

The fewest arguments a call to this function may pass; fewer is an argument-count error.

Specified by:

getMinArgCount in class BuiltInFunction

Returns:

the minimum accepted argument count

getMaxArgCount

public int getMaxArgCount()

Description copied from class: BuiltInFunction

The most arguments a call to this function may pass; Integer.MAX_VALUE marks a variadic function (see BuiltInFunction.isVariadic()).

Specified by:

getMaxArgCount in class BuiltInFunction

Returns:

the maximum accepted argument count