Class UserDefinedSqlAggregationFunction

java.lang.Object

com.activeviam.directquery.api.UserDefinedSqlAggregationFunction

public final class UserDefinedSqlAggregationFunction
extends Object

User defined Sql aggregation function.

This must be the counterpart of a "core" Atoti aggregation, with the same key. This core aggregation can be either a IUserDefinedAggregateFunction or a IAggregationFunction.

Example for a Sum product aggregation.

UserDefinedSqlAggregationFunction.builder()
        .pluginKey("MY_SUM_PRODUCT")
        .inputsNumber(2)
        .sqlExpressionProviders(
            List.of(
                sqlColumnNames ->
                    "SUM(" + sqlColumnNames.get(0) + " * " + sqlColumnNames.get(1) + ")"))
        .outputTypes(List.of(StandardTypes.DOUBLE))
        .build();

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UserDefinedSqlAggregationFunction.IBuildMe	Builder final step.
static interface	UserDefinedSqlAggregationFunction.INeedInputsNumberBuilder	Builder for the inputs number.
static interface	UserDefinedSqlAggregationFunction.INeedOutputTypesBuilder	Builder for the output types.
static interface	UserDefinedSqlAggregationFunction.INeedPluginKeyBuilder	Builder for plugin key.
static interface	UserDefinedSqlAggregationFunction.INeedReaggregable	Builder for re-aggregation capability.
static interface	UserDefinedSqlAggregationFunction.INeedSqlExpressionProvidersBuilder	Builder for expressions providers.

Method Summary

Modifier and Type	Method	Description
static UserDefinedSqlAggregationFunction.INeedPluginKeyBuilder	builder()	Return a fluent builder of an UserDefinedSqlAggregationFunction.
boolean	equals(Object o)
int	hashCode()
int	inputsNumber()
List<IFieldType>	outputTypes()
String	pluginKey()
@Nullable String	reaggPluginKey()
@Nullable ISqlAggregationResultTransformer	resultTransformer()
List<Function<List<String>, String>>	sqlExpressionProviders()
String	toString()

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static UserDefinedSqlAggregationFunction.INeedPluginKeyBuilder builder()

Return a fluent builder of an UserDefinedSqlAggregationFunction.

pluginKey

public String pluginKey()

inputsNumber

public int inputsNumber()

sqlExpressionProviders

public List<Function<List<String>, String>> sqlExpressionProviders()

outputTypes

public List<IFieldType> outputTypes()

reaggPluginKey

public @Nullable String reaggPluginKey()

resultTransformer

public @Nullable ISqlAggregationResultTransformer resultTransformer()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object