org.apache.flink.table.types.logical

Enum LogicalTypeRoot

java.lang.Object

java.lang.Enum<LogicalTypeRoot>

org.apache.flink.table.types.logical.LogicalTypeRoot

All Implemented Interfaces:

Serializable, Comparable<LogicalTypeRoot>

@PublicEvolving
public enum LogicalTypeRoot
extends Enum<LogicalTypeRoot>

An enumeration of logical type roots containing static information about logical data types.

A root is an essential description of a LogicalType without additional parameters. For example, a parameterized logical type DECIMAL(12,3) possesses all characteristics of its root DECIMAL. Additionally, a logical type root enables efficient comparison during the evaluation of types.

The enumeration is very close to the SQL standard in terms of naming and completeness. However, it reflects just a subset of the evolving standard and contains some extensions (such as NULL, SYMBOL, or RAW).

See the type-implementing classes for a more detailed description of each type.

Note to implementers: Whenever we perform a match against a type root (e.g. using a switch/case statement), it is recommended to:

• Order the items by the type root definition in this class for easy readability.
• Think about the behavior of all type roots for the implementation. A default fallback is dangerous when introducing a new type root in the future.
• In many runtime cases, resolve the indirection of DISTINCT_TYPE: return myMethod(((DistinctType) type).getSourceType)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY
BIGINT
BINARY
BOOLEAN
CHAR
DATE
DECIMAL
DISTINCT_TYPE
DOUBLE
FLOAT
INTEGER
INTERVAL_DAY_TIME
INTERVAL_YEAR_MONTH
MAP
MULTISET
NULL
RAW
ROW
SMALLINT
STRUCTURED_TYPE
SYMBOL
TIME_WITHOUT_TIME_ZONE
TIMESTAMP_WITH_LOCAL_TIME_ZONE
TIMESTAMP_WITH_TIME_ZONE
TIMESTAMP_WITHOUT_TIME_ZONE
TINYINT
UNRESOLVED
VARBINARY
VARCHAR

Method Summary

Modifier and Type	Method and Description
Set<LogicalTypeFamily>	getFamilies()
static LogicalTypeRoot	valueOf(String name) Returns the enum constant of this type with the specified name.
static LogicalTypeRoot[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CHAR

public static final LogicalTypeRoot CHAR

VARCHAR

public static final LogicalTypeRoot VARCHAR

BOOLEAN

public static final LogicalTypeRoot BOOLEAN

BINARY

public static final LogicalTypeRoot BINARY

VARBINARY

public static final LogicalTypeRoot VARBINARY

DECIMAL

public static final LogicalTypeRoot DECIMAL

TINYINT

public static final LogicalTypeRoot TINYINT

SMALLINT

public static final LogicalTypeRoot SMALLINT

INTEGER

public static final LogicalTypeRoot INTEGER

BIGINT

public static final LogicalTypeRoot BIGINT

FLOAT

public static final LogicalTypeRoot FLOAT

DOUBLE

public static final LogicalTypeRoot DOUBLE

DATE

public static final LogicalTypeRoot DATE

TIME_WITHOUT_TIME_ZONE

public static final LogicalTypeRoot TIME_WITHOUT_TIME_ZONE

TIMESTAMP_WITHOUT_TIME_ZONE

public static final LogicalTypeRoot TIMESTAMP_WITHOUT_TIME_ZONE

TIMESTAMP_WITH_TIME_ZONE

public static final LogicalTypeRoot TIMESTAMP_WITH_TIME_ZONE

TIMESTAMP_WITH_LOCAL_TIME_ZONE

public static final LogicalTypeRoot TIMESTAMP_WITH_LOCAL_TIME_ZONE

INTERVAL_YEAR_MONTH

public static final LogicalTypeRoot INTERVAL_YEAR_MONTH

INTERVAL_DAY_TIME

public static final LogicalTypeRoot INTERVAL_DAY_TIME

ARRAY

public static final LogicalTypeRoot ARRAY

MULTISET

public static final LogicalTypeRoot MULTISET

MAP

public static final LogicalTypeRoot MAP

ROW

public static final LogicalTypeRoot ROW

DISTINCT_TYPE

public static final LogicalTypeRoot DISTINCT_TYPE

STRUCTURED_TYPE

public static final LogicalTypeRoot STRUCTURED_TYPE

NULL

public static final LogicalTypeRoot NULL

RAW

public static final LogicalTypeRoot RAW

SYMBOL

public static final LogicalTypeRoot SYMBOL

UNRESOLVED

public static final LogicalTypeRoot UNRESOLVED

Method Detail

values

public static LogicalTypeRoot[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LogicalTypeRoot c : LogicalTypeRoot.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LogicalTypeRoot valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFamilies

public Set<LogicalTypeFamily> getFamilies()