org.apache.flink.table.types.logical

Class RawType<T>

java.lang.Object

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

org.apache.flink.table.types.logical.RawType<T>

Type Parameters:

T - originating class for this type

All Implemented Interfaces:

Serializable

@PublicEvolving
public final class RawType<T>
extends LogicalType

Logical type of an arbitrary serialized type. This type is a black box within the table ecosystem and is only deserialized at the edges. The raw type is an extension to the SQL standard.

The serialized string representation is RAW('c', 's') where c is the originating class and s is the serialized TypeSerializerSnapshot in Base64 encoding.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT

Constructor Summary

Constructors

Constructor and Description
RawType(boolean isNullable, Class<T> clazz, TypeSerializer<T> serializer)
RawType(Class<T> clazz, TypeSerializer<T> serializer)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(LogicalTypeVisitor<R> visitor)
String	asSerializableString() Returns a string that fully serializes this instance.
String	asSummaryString() Returns a string that summarizes this type for printing to a console.
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.
Class<T>	getOriginatingClass()
String	getSerializerString() Returns the serialized TypeSerializerSnapshot in Base64 encoding of this raw type.
TypeSerializer<T>	getTypeSerializer()
int	hashCode()
static RawType<?>	restore(ClassLoader classLoader, String className, String serializerString) Restores a raw type from the components of a serialized string representation.
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

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

FORMAT

public static final String FORMAT

See Also:

Constant Field Values

Constructor Detail

RawType

public RawType(boolean isNullable,
               Class<T> clazz,
               TypeSerializer<T> serializer)

RawType

public RawType(Class<T> clazz,
               TypeSerializer<T> serializer)

Method Detail

getOriginatingClass

public Class<T> getOriginatingClass()

getTypeSerializer

public TypeSerializer<T> getTypeSerializer()

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

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

restore

public static RawType<?> restore(ClassLoader classLoader,
                                 String className,
                                 String serializerString)

Restores a raw type from the components of a serialized string representation.

getSerializerString

public String getSerializerString()

Returns the serialized TypeSerializerSnapshot in Base64 encoding of this raw type.