org.apache.flink.table.expressions

Class ApiExpressionUtils

java.lang.Object

org.apache.flink.table.expressions.ApiExpressionUtils

@Internal
public final class ApiExpressionUtils
extends Object

Utilities for API-specific Expressions.

Field Summary

Fields

Modifier and Type	Field and Description
static long	MILLIS_PER_DAY
static long	MILLIS_PER_HOUR
static long	MILLIS_PER_MINUTE
static long	MILLIS_PER_SECOND

Method Summary

Modifier and Type	Method and Description
static ValueLiteralExpression	intervalOfMillis(long millis)
static ValueLiteralExpression	intervalOfMonths(int months)
static boolean	isFunction(Expression expression, BuiltInFunctionDefinition functionDefinition) Checks if the given expression is a given builtin function.
static boolean	isFunctionOfKind(Expression expression, FunctionKind kind) Checks if the expression is a function call of given type.
static LocalReferenceExpression	localRef(String name, DataType dataType)
static LookupCallExpression	lookupCall(String name, Expression... args)
static Expression	objectToExpression(Object expression) Converts a given object to an expression.
static SqlCallExpression	sqlCall(String sqlExpression)
static TableReferenceExpression	tableRef(String name, QueryOperation queryOperation)
static TableReferenceExpression	tableRef(String name, Table table)
static Expression	toMilliInterval(Expression e, long multiplier)
static Expression	toMonthInterval(Expression e, int multiplier)
static Expression	toRowInterval(Expression e)
static TypeLiteralExpression	typeLiteral(DataType dataType)
static UnresolvedCallExpression	unresolvedCall(FunctionDefinition functionDefinition, Expression... args)
static UnresolvedCallExpression	unresolvedCall(FunctionDefinition functionDefinition, List<Expression> args)
static UnresolvedCallExpression	unresolvedCall(FunctionIdentifier functionIdentifier, FunctionDefinition functionDefinition, Expression... args)
static UnresolvedCallExpression	unresolvedCall(FunctionIdentifier functionIdentifier, FunctionDefinition functionDefinition, List<Expression> args)
static UnresolvedReferenceExpression	unresolvedRef(String name)
static Expression	unwrapFromApi(Expression expression)
static ValueLiteralExpression	valueLiteral(Object value)
static ValueLiteralExpression	valueLiteral(Object value, DataType dataType)

Methods inherited from class java.lang.Object

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

Field Detail

MILLIS_PER_SECOND

public static final long MILLIS_PER_SECOND

See Also:

Constant Field Values

MILLIS_PER_MINUTE

public static final long MILLIS_PER_MINUTE

See Also:

Constant Field Values

MILLIS_PER_HOUR

public static final long MILLIS_PER_HOUR

See Also:

Constant Field Values

MILLIS_PER_DAY

public static final long MILLIS_PER_DAY

See Also:

Constant Field Values

Method Detail

objectToExpression

public static Expression objectToExpression(Object expression)

Converts a given object to an expression.

It converts:

• null to null literal
• Row to a call to a row constructor expression
• Map to a call to a map constructor expression
• List to a call to an array constructor expression
• arrays to a call to an array constructor expression
• Scala's Seq to an array constructor via reflection
• Scala's Map to a map constructor via reflection
• Scala's BigDecimal to a DECIMAL literal
• if none of the above applies, the function tries to convert the object to a value literal with valueLiteral(Object)

Parameters:

expression - An object to convert to an expression

unwrapFromApi

public static Expression unwrapFromApi(Expression expression)

localRef

public static LocalReferenceExpression localRef(String name,
                                                DataType dataType)

valueLiteral

public static ValueLiteralExpression valueLiteral(Object value)

valueLiteral

public static ValueLiteralExpression valueLiteral(Object value,
                                                  DataType dataType)

typeLiteral

public static TypeLiteralExpression typeLiteral(DataType dataType)

unresolvedRef

public static UnresolvedReferenceExpression unresolvedRef(String name)

unresolvedCall

public static UnresolvedCallExpression unresolvedCall(@Nullable
                                                      FunctionIdentifier functionIdentifier,
                                                      FunctionDefinition functionDefinition,
                                                      Expression... args)

unresolvedCall

public static UnresolvedCallExpression unresolvedCall(@Nullable
                                                      FunctionIdentifier functionIdentifier,
                                                      FunctionDefinition functionDefinition,
                                                      List<Expression> args)

unresolvedCall

public static UnresolvedCallExpression unresolvedCall(FunctionDefinition functionDefinition,
                                                      Expression... args)

unresolvedCall

public static UnresolvedCallExpression unresolvedCall(FunctionDefinition functionDefinition,
                                                      List<Expression> args)

tableRef

public static TableReferenceExpression tableRef(String name,
                                                Table table)

tableRef

public static TableReferenceExpression tableRef(String name,
                                                QueryOperation queryOperation)

lookupCall

public static LookupCallExpression lookupCall(String name,
                                              Expression... args)

sqlCall

public static SqlCallExpression sqlCall(String sqlExpression)

toMonthInterval

public static Expression toMonthInterval(Expression e,
                                         int multiplier)

intervalOfMillis

public static ValueLiteralExpression intervalOfMillis(long millis)

toMilliInterval

public static Expression toMilliInterval(Expression e,
                                         long multiplier)

intervalOfMonths

public static ValueLiteralExpression intervalOfMonths(int months)

toRowInterval

public static Expression toRowInterval(Expression e)

isFunctionOfKind

public static boolean isFunctionOfKind(Expression expression,
                                       FunctionKind kind)

Checks if the expression is a function call of given type.

Parameters:

expression - expression to check

kind - expected type of function

Returns:

true if the expression is function call of given type, false otherwise

isFunction

public static boolean isFunction(Expression expression,
                                 BuiltInFunctionDefinition functionDefinition)

Checks if the given expression is a given builtin function.

Parameters:

expression - expression to check

functionDefinition - expected function definition

Returns:

true if the given expression is a given function call