Package org.apache.flink.table.types.logical

Class TimeType

  • All Implemented Interfaces:
    Serializable
    @PublicEvolving
public final class TimeType
extends LogicalType
    Logical type of a time WITHOUT time zone consisting of hour:minute:second[.fractional] with up to nanosecond precision and values ranging from 00:00:00.000000000 to 23:59:59.999999999. Compared to the SQL standard, leap seconds (23:59:60 and 23:59:61) are not supported as the semantics are closer to LocalTime. A time WITH time zone is not provided.

    The serialized string representation is TIME(p) where p is the number of digits of fractional seconds (=precision). p must have a value between 0 and 9 (both inclusive). If no precision is specified, p is equal to 0. TIME(p) WITHOUT TIME ZONE is a synonym for this type.

    A conversion from and to int describes the number of milliseconds of the day. A conversion from and to long describes the number of nanoseconds of the day.

    See Also:
    Serialized Form

    • Constructor Detail

      • TimeType

        public TimeType​(boolean isNullable,
                int precision)

      • TimeType

        public TimeType​(int precision)

      • TimeType

        public TimeType()

    • Method Detail

      • getPrecision

        public int getPrecision()

      • 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()