org.apache.flink.table.types.logical

Class YearMonthIntervalType

java.lang.Object

org.apache.flink.table.types.logical.LogicalType

org.apache.flink.table.types.logical.YearMonthIntervalType

All Implemented Interfaces:

Serializable

@PublicEvolving
public final class YearMonthIntervalType
extends LogicalType

Logical type for a group of year-month interval types. The type must be parameterized to one of the following resolutions: interval of years, interval of years to months, or interval of months.

An interval of year-month consists of +years-months with values ranging from -9999-11 to +9999-11. The value representation is the same for all types of resolutions. For example, an interval of months of 50 is always represented in an interval-of-years-to-months format (with default year precision): +04-02.

The serialized string representation is INTERVAL YEAR(p), INTERVAL YEAR(p) TO MONTH, or INTERVAL MONTH where p is the number of digits of years (=year precision). p must have a value between 1 and 4 (both inclusive). If no year precision is specified, p is equal to 2.

A conversion from and to int describes the number of months. A conversion from Period ignores the days part.

See Also:

DayTimeIntervalType, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	YearMonthIntervalType.YearMonthResolution Supported resolutions of this type.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRECISION
static int	MAX_PRECISION
static int	MIN_PRECISION

Constructor Summary

Constructors

Constructor and Description
YearMonthIntervalType(boolean isNullable, YearMonthIntervalType.YearMonthResolution resolution, int yearPrecision)
YearMonthIntervalType(YearMonthIntervalType.YearMonthResolution resolution)
YearMonthIntervalType(YearMonthIntervalType.YearMonthResolution resolution, int yearPrecision)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(LogicalTypeVisitor<R> visitor)
String	asSerializableString() Returns a string that fully serializes this instance.
LogicalType	copy(boolean isNullable) Returns a deep copy of this type with possibly different nullability.
boolean	equals(Object o)
List<LogicalType>	getChildren()
Class<?>	getDefaultConversion() Returns the default conversion class.
YearMonthIntervalType.YearMonthResolution	getResolution()
int	getYearPrecision()
int	hashCode()
boolean	supportsInputConversion(Class<?> clazz) Returns whether an instance of the given class can be represented as a value of this logical type when entering the table ecosystem.
boolean	supportsOutputConversion(Class<?> clazz) Returns whether a value of this logical type can be represented as an instance of the given class when leaving the table ecosystem.

Methods inherited from class org.apache.flink.table.types.logical.LogicalType

asSummaryString, conversionSet, copy, getTypeRoot, is, is, isAnyOf, isAnyOf, isNullable, toString, withNullability

Methods inherited from class java.lang.Object

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

Field Detail

MIN_PRECISION

public static final int MIN_PRECISION

See Also:

Constant Field Values

MAX_PRECISION

public static final int MAX_PRECISION

See Also:

Constant Field Values

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

Constant Field Values

Constructor Detail

YearMonthIntervalType

public YearMonthIntervalType(boolean isNullable,
                             YearMonthIntervalType.YearMonthResolution resolution,
                             int yearPrecision)

YearMonthIntervalType

public YearMonthIntervalType(YearMonthIntervalType.YearMonthResolution resolution,
                             int yearPrecision)

YearMonthIntervalType

public YearMonthIntervalType(YearMonthIntervalType.YearMonthResolution resolution)

Method Detail

getResolution

public YearMonthIntervalType.YearMonthResolution getResolution()

getYearPrecision

public int getYearPrecision()

copy

public LogicalType copy(boolean isNullable)

Description copied from class: LogicalType

Returns a deep copy of this type with possibly different nullability.

Specified by:

copy in class LogicalType

Parameters:

isNullable - the intended nullability of the copied type

Returns:

a deep copy

asSerializableString

public String asSerializableString()

Description copied from class: LogicalType

Returns a string that fully serializes this instance. The serialized string can be used for transmitting or persisting a type.

See LogicalTypeParser for the reverse operation.

Specified by:

asSerializableString in class LogicalType

Returns:

detailed string for transmission or persistence

supportsInputConversion

public boolean supportsInputConversion(Class<?> clazz)

Description copied from class: LogicalType

Returns whether an instance of the given class can be represented as a value of this logical type when entering the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.

A supported conversion directly maps an input class to a logical type without loss of precision or type widening.

For example, java.lang.Long or long can be used as input for BIGINT independent of the set nullability.

Specified by:

supportsInputConversion in class LogicalType

Parameters:

clazz - input class to be converted into this logical type

Returns:

flag that indicates if instances of this class can be used as input into the table ecosystem

See Also:

LogicalType.getDefaultConversion()

supportsOutputConversion

public boolean supportsOutputConversion(Class<?> clazz)

Description copied from class: LogicalType

Returns whether a value of this logical type can be represented as an instance of the given class when leaving the table ecosystem. This method helps for the interoperability between JVM-based languages and the relational type system.

A supported conversion directly maps a logical type to an output class without loss of precision or type widening.

For example, java.lang.Long or long can be used as output for BIGINT if the type is not nullable. If the type is nullable, only java.lang.Long can represent this.

Specified by:

supportsOutputConversion in class LogicalType

Parameters:

clazz - output class to be converted from this logical type

Returns:

flag that indicates if instances of this class can be used as output from the table ecosystem

See Also:

LogicalType.getDefaultConversion()

getDefaultConversion

public Class<?> getDefaultConversion()

Description copied from class: LogicalType

Returns the default conversion class. A value of this logical type is expected to be an instance of the given class when entering or is represented as an instance of the given class when leaving the table ecosystem if no other conversion has been specified.

For example, java.lang.Long is the default input and output for BIGINT.

Specified by:

getDefaultConversion in class LogicalType

Returns:

default class to represent values of this logical type

See Also:

LogicalType.supportsInputConversion(Class), LogicalType.supportsOutputConversion(Class)

getChildren

public List<LogicalType> getChildren()

Specified by:

getChildren in class LogicalType

accept

public <R> R accept(LogicalTypeVisitor<R> visitor)

Specified by:

accept in class LogicalType

equals

public boolean equals(Object o)

Overrides:

equals in class LogicalType

hashCode

public int hashCode()

Overrides:

hashCode in class LogicalType