org.apache.flink.table.functions

Class UserDefinedFunctionHelper

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunctionHelper

@Internal
public class UserDefinedFunctionHelper
extends Object

Utility methods for validation and extraction of types during function registration in a FunctionCatalog.

Method Summary

Modifier and Type	Method and Description
static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<ACC>	getAccumulatorTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction) Tries to infer the TypeInformation of an AggregateFunction's accumulator type.
static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<ACC>	getAccumulatorTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction, org.apache.flink.api.common.typeinfo.TypeInformation<ACC> scalaType) Tries to infer the TypeInformation of an AggregateFunction's accumulator type.
static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<T>	getReturnTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction) Tries to infer the TypeInformation of an AggregateFunction's accumulator type.
static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<T>	getReturnTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction, org.apache.flink.api.common.typeinfo.TypeInformation<T> scalaType) Tries to infer the TypeInformation of an AggregateFunction's accumulator type.
static <T> org.apache.flink.api.common.typeinfo.TypeInformation<T>	getReturnTypeOfTableFunction(org.apache.flink.table.functions.TableFunction<T> tableFunction) Tries to infer the TypeInformation of an AggregateFunction's accumulator type.
static <T> org.apache.flink.api.common.typeinfo.TypeInformation<T>	getReturnTypeOfTableFunction(org.apache.flink.table.functions.TableFunction<T> tableFunction, org.apache.flink.api.common.typeinfo.TypeInformation<T> scalaType) Tries to infer the TypeInformation of an AggregateFunction's accumulator type.
static void	prepareFunction(TableConfig config, org.apache.flink.table.functions.UserDefinedFunction function) Prepares a UserDefinedFunction for usage in the API.

Methods inherited from class java.lang.Object

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

Method Detail

getReturnTypeOfAggregateFunction

public static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<T> getReturnTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction)

Tries to infer the TypeInformation of an AggregateFunction's accumulator type.

Parameters:

aggregateFunction - The AggregateFunction for which the accumulator type is inferred.

Returns:

The inferred accumulator type of the AggregateFunction.

getReturnTypeOfAggregateFunction

public static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<T> getReturnTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction,
                                                                                                               org.apache.flink.api.common.typeinfo.TypeInformation<T> scalaType)

Tries to infer the TypeInformation of an AggregateFunction's accumulator type.

Parameters:

aggregateFunction - The AggregateFunction for which the accumulator type is inferred.

scalaType - The implicitly inferred type of the accumulator type.

Returns:

The inferred accumulator type of the AggregateFunction.

getAccumulatorTypeOfAggregateFunction

public static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<ACC> getAccumulatorTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction)

Tries to infer the TypeInformation of an AggregateFunction's accumulator type.

Parameters:

aggregateFunction - The AggregateFunction for which the accumulator type is inferred.

Returns:

The inferred accumulator type of the AggregateFunction.

getAccumulatorTypeOfAggregateFunction

public static <T,ACC> org.apache.flink.api.common.typeinfo.TypeInformation<ACC> getAccumulatorTypeOfAggregateFunction(org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> aggregateFunction,
                                                                                                                      org.apache.flink.api.common.typeinfo.TypeInformation<ACC> scalaType)

Tries to infer the TypeInformation of an AggregateFunction's accumulator type.

Parameters:

aggregateFunction - The AggregateFunction for which the accumulator type is inferred.

scalaType - The implicitly inferred type of the accumulator type.

Returns:

The inferred accumulator type of the AggregateFunction.

getReturnTypeOfTableFunction

public static <T> org.apache.flink.api.common.typeinfo.TypeInformation<T> getReturnTypeOfTableFunction(org.apache.flink.table.functions.TableFunction<T> tableFunction)

Tries to infer the TypeInformation of an AggregateFunction's accumulator type.

Parameters:

tableFunction - The TableFunction for which the accumulator type is inferred.

Returns:

The inferred accumulator type of the AggregateFunction.

getReturnTypeOfTableFunction

public static <T> org.apache.flink.api.common.typeinfo.TypeInformation<T> getReturnTypeOfTableFunction(org.apache.flink.table.functions.TableFunction<T> tableFunction,
                                                                                                       org.apache.flink.api.common.typeinfo.TypeInformation<T> scalaType)

Tries to infer the TypeInformation of an AggregateFunction's accumulator type.

Parameters:

tableFunction - The TableFunction for which the accumulator type is inferred.

scalaType - The implicitly inferred type of the accumulator type.

Returns:

The inferred accumulator type of the AggregateFunction.

prepareFunction

public static void prepareFunction(TableConfig config,
                                   org.apache.flink.table.functions.UserDefinedFunction function)

Prepares a UserDefinedFunction for usage in the API.