org.apache.flink.table.functions

Class ScalarFunctionDefinition

java.lang.Object

org.apache.flink.table.functions.ScalarFunctionDefinition

All Implemented Interfaces:

FunctionDefinition

@PublicEvolving
public final class ScalarFunctionDefinition
extends Object
implements FunctionDefinition

The function definition of an user-defined scalar function.

This class can be dropped once we introduce a new type inference.

Constructor Summary

Constructors

Constructor and Description
ScalarFunctionDefinition(String name, ScalarFunction scalarFunction)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
FunctionKind	getKind() Returns the kind of function this definition describes.
Set<FunctionRequirement>	getRequirements() Returns the set of requirements this definition demands.
ScalarFunction	getScalarFunction()
int	hashCode()
boolean	isDeterministic() Returns information about the determinism of the function's results.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalarFunctionDefinition

public ScalarFunctionDefinition(String name,
                                ScalarFunction scalarFunction)

Method Detail

getScalarFunction

public ScalarFunction getScalarFunction()

getKind

public FunctionKind getKind()

Description copied from interface: FunctionDefinition

Returns the kind of function this definition describes.

Specified by:

getKind in interface FunctionDefinition

getRequirements

public Set<FunctionRequirement> getRequirements()

Description copied from interface: FunctionDefinition

Returns the set of requirements this definition demands.

Specified by:

getRequirements in interface FunctionDefinition

isDeterministic

public boolean isDeterministic()

Description copied from interface: FunctionDefinition

Returns information about the determinism of the function's results.

It 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 pure functional like random(), date(), now(), ... this method must return false.

Specified by:

isDeterministic in interface FunctionDefinition

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object