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

Class SymbolType<T extends TableSymbol>

  • Type Parameters:
    T - Legacy generic that will be dropped in the next major version. If we dropped it earlier, we would break LogicalTypeVisitor implementation.
    All Implemented Interfaces:
    Serializable
    @PublicEvolving
public final class SymbolType<T extends TableSymbol>
extends LogicalType
    Logical type for representing symbol values. The symbol type is an extension to the SQL standard and only serves as a helper type within the expression stack.

    A symbol type accepts conversions from and to Enum. But note that this is not an enum type for users.

    This type has no serializable string representation.

    See Also:
    Serialized Form

    • Constructor Detail

      • SymbolType

        @Deprecated
public SymbolType​(boolean isNullable,
                  Class<T> clazz)
        Deprecated.
        Symbol types have been simplified to not require a class.

      • SymbolType

        @Deprecated
public SymbolType​(Class<T> clazz)
        Deprecated.
        Symbol types have been simplified to not require a class.

      • SymbolType

        public SymbolType​(boolean isNullable)

      • SymbolType

        public SymbolType()

    • Method Detail

      • 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

      • asSummaryString

        public String asSummaryString()
        Description copied from class: LogicalType
        Returns a string that summarizes this type for printing to a console. An implementation might shorten long names or skips very specific properties.

        Use LogicalType.asSerializableString() for a type string that fully serializes this instance.

        Overrides:
        asSummaryString in class LogicalType
        Returns:
        summary string of this type for debugging purposes

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