@Internal public final class TableAggregateFunctionDefinition extends Object implements FunctionDefinition
This class can be dropped once we introduce a new type inference.
| Constructor and Description |
|---|
TableAggregateFunctionDefinition(String name,
TableAggregateFunction<?,?> aggregateFunction,
TypeInformation<?> resultTypeInfo,
TypeInformation<?> accTypeInfo) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object o) |
TypeInformation<?> |
getAccumulatorTypeInfo() |
FunctionKind |
getKind()
Returns the kind of function this definition describes.
|
String |
getName() |
Set<FunctionRequirement> |
getRequirements()
Returns the set of requirements this definition demands.
|
TypeInformation<?> |
getResultTypeInfo() |
TableAggregateFunction<?,?> |
getTableAggregateFunction() |
TypeInference |
getTypeInference(DataTypeFactory typeFactory)
Returns the logic for performing type inference of a call to this function definition.
|
int |
hashCode() |
boolean |
isDeterministic()
Returns information about the determinism of the function's results.
|
String |
toString() |
public TableAggregateFunctionDefinition(String name, TableAggregateFunction<?,?> aggregateFunction, TypeInformation<?> resultTypeInfo, TypeInformation<?> accTypeInfo)
public String getName()
public TableAggregateFunction<?,?> getTableAggregateFunction()
public TypeInformation<?> getResultTypeInfo()
public TypeInformation<?> getAccumulatorTypeInfo()
public FunctionKind getKind()
FunctionDefinitiongetKind in interface FunctionDefinitionpublic TypeInference getTypeInference(DataTypeFactory typeFactory)
FunctionDefinitionThe type inference process is responsible for inferring unknown types of input arguments, validating input arguments, and producing result types. The type inference process happens independent of a function body. The output of the type inference is used to search for a corresponding runtime implementation.
Instances of type inference can be created by using TypeInference.newBuilder().
See BuiltInFunctionDefinitions for concrete usage examples.
getTypeInference in interface FunctionDefinitionpublic Set<FunctionRequirement> getRequirements()
FunctionDefinitiongetRequirements in interface FunctionDefinitionpublic boolean isDeterministic()
FunctionDefinitionIt returns true if and only if a call to this function is guaranteed to
always return the same result given the same parameters. true is assumed by
default. If the function is not purely functional like random(), date(), now(), ...
this method must return false.
Furthermore, return false if the planner should always execute this function
on the cluster side. In other words: the planner should not perform constant expression
reduction during planning for constant calls to this function.
isDeterministic in interface FunctionDefinitionCopyright © 2014–2021 The Apache Software Foundation. All rights reserved.