org.apache.flink.table.types.inference

Interface CallContextBase

All Known Subinterfaces:

CallContext

@PublicEvolving
public interface CallContextBase

Provides details about the function call for which type inference is performed.

Method Summary

Modifier and Type	Method and Description
<T> Optional<T>	getArgumentValue(int pos, Class<T> clazz) Returns the literal value of the argument at the given position, given that the argument is a literal, is not null, and can be expressed as an instance of the provided class.
FunctionDefinition	getFunctionDefinition() Returns the function definition that defines the function currently being called.
String	getName() Returns the function's name usually referencing the function in a catalog.
boolean	isArgumentLiteral(int pos) Returns whether the argument at the given position is a value literal.
boolean	isArgumentNull(int pos) Returns true if the argument at the given position is a literal and null, false otherwise.

Method Detail

getFunctionDefinition

FunctionDefinition getFunctionDefinition()

Returns the function definition that defines the function currently being called.

isArgumentLiteral

boolean isArgumentLiteral(int pos)

Returns whether the argument at the given position is a value literal.

isArgumentNull

boolean isArgumentNull(int pos)

Returns true if the argument at the given position is a literal and null, false otherwise.

Use isArgumentLiteral(int) before to check if the argument is actually a literal.

getArgumentValue

<T> Optional<T> getArgumentValue(int pos,
                                 Class<T> clazz)

Returns the literal value of the argument at the given position, given that the argument is a literal, is not null, and can be expressed as an instance of the provided class.

Use isArgumentLiteral(int) before to check if the argument is actually a literal.

getName

String getName()

Returns the function's name usually referencing the function in a catalog.

Note: The name is meant for debugging purposes only.