org.apache.flink.table.types.logical.utils

Class LogicalTypeChecks

java.lang.Object

org.apache.flink.table.types.logical.utils.LogicalTypeChecks

@Internal
public final class LogicalTypeChecks
extends Object

Utilities for checking LogicalType and avoiding a lot of type casting and repetitive work.

Method Summary

Modifier and Type	Method and Description
static boolean	areTypesCompatible(LogicalType thisType, LogicalType thatType) Returns true if the two given types are compatible.
static int	getDayPrecision(LogicalType logicalType)
static int	getFieldCount(LogicalType logicalType) Returns the field count of row and structured types.
static int	getFractionalPrecision(LogicalType logicalType)
static int	getLength(LogicalType logicalType)
static int	getPrecision(LogicalType logicalType) Returns the precision of all types that define a precision implicitly or explicitly.
static int	getScale(LogicalType logicalType) Returns the scale of all types that define a scale implicitly or explicitly.
static int	getYearPrecision(LogicalType logicalType)
static boolean	hasDayPrecision(LogicalType logicalType, int yearPrecision)
static boolean	hasFamily(LogicalType logicalType, LogicalTypeFamily family)
static boolean	hasFractionalPrecision(LogicalType logicalType, int fractionalPrecision)
static boolean	hasLength(LogicalType logicalType, int length)
static boolean	hasPrecision(LogicalType logicalType, int precision) Checks the precision of a type that defines a precision implicitly or explicitly.
static boolean	hasRoot(LogicalType logicalType, LogicalTypeRoot typeRoot)
static boolean	hasScale(LogicalType logicalType, int scale) Checks the scale of all types that define a scale implicitly or explicitly.
static boolean	hasYearPrecision(LogicalType logicalType, int yearPrecision)
static boolean	isCompositeType(LogicalType logicalType) Checks if the given type is a composite type.
static boolean	isProctimeAttribute(LogicalType logicalType)
static boolean	isRowtimeAttribute(LogicalType logicalType)
static boolean	isSingleFieldInterval(LogicalType logicalType)
static boolean	isTimeAttribute(LogicalType logicalType)

Methods inherited from class java.lang.Object

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

Method Detail

hasRoot

public static boolean hasRoot(LogicalType logicalType,
                              LogicalTypeRoot typeRoot)

hasFamily

public static boolean hasFamily(LogicalType logicalType,
                                LogicalTypeFamily family)

isTimeAttribute

public static boolean isTimeAttribute(LogicalType logicalType)

isRowtimeAttribute

public static boolean isRowtimeAttribute(LogicalType logicalType)

isProctimeAttribute

public static boolean isProctimeAttribute(LogicalType logicalType)

isCompositeType

public static boolean isCompositeType(LogicalType logicalType)

Checks if the given type is a composite type.

Parameters:

logicalType - Logical data type to check

Returns:

True if the type is composite type.

getLength

public static int getLength(LogicalType logicalType)

getFieldCount

public static int getFieldCount(LogicalType logicalType)

Returns the field count of row and structured types.

hasLength

public static boolean hasLength(LogicalType logicalType,
                                int length)

getPrecision

public static int getPrecision(LogicalType logicalType)

Returns the precision of all types that define a precision implicitly or explicitly.

hasPrecision

public static boolean hasPrecision(LogicalType logicalType,
                                   int precision)

Checks the precision of a type that defines a precision implicitly or explicitly.

getScale

public static int getScale(LogicalType logicalType)

Returns the scale of all types that define a scale implicitly or explicitly.

hasScale

public static boolean hasScale(LogicalType logicalType,
                               int scale)

Checks the scale of all types that define a scale implicitly or explicitly.

getYearPrecision

public static int getYearPrecision(LogicalType logicalType)

hasYearPrecision

public static boolean hasYearPrecision(LogicalType logicalType,
                                       int yearPrecision)

getDayPrecision

public static int getDayPrecision(LogicalType logicalType)

hasDayPrecision

public static boolean hasDayPrecision(LogicalType logicalType,
                                      int yearPrecision)

getFractionalPrecision

public static int getFractionalPrecision(LogicalType logicalType)

hasFractionalPrecision

public static boolean hasFractionalPrecision(LogicalType logicalType,
                                             int fractionalPrecision)

isSingleFieldInterval

public static boolean isSingleFieldInterval(LogicalType logicalType)

areTypesCompatible

public static boolean areTypesCompatible(LogicalType thisType,
                                         LogicalType thatType)

Returns true if the two given types are compatible. Types are compatible is for atomic types (VARCHAR, INT, BOOLEAN, etc..), they must be fully equal (i.e. LogicalType.equals(Object)), for complex types (ARRAY, ROW, MAP, etc..), they must be in the same type but ignore field names and other logical attributes, and all the children types (LogicalType.getChildren()) must be compatible too.