org.wikimedia.eventutilities.flink.formats.json

Class TypeInformationSchemaConversions

java.lang.Object

org.wikimedia.eventutilities.flink.formats.json.TypeInformationSchemaConversions

All Implemented Interfaces:

SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

@ParametersAreNonnullByDefault
public class TypeInformationSchemaConversions
extends Object
implements SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Implementation of SchemaConversions that can convert to Flink DataStream API TypeInformation. Used by JsonSchemaFlinkConverter. If you modify this class, please also augment DataTypeSchemaConversions accordingly. To handle proper conversion between Table API and DataStream, Flink needs the types consistently converted to the same underlying representations.

Nested Class Summary

Nested classes/interfaces inherited from interface org.wikimedia.eventutilities.core.event.types.SchemaConversions

SchemaConversions.RowField<T>

Constructor Summary

Constructors

Constructor and Description
TypeInformationSchemaConversions()

Method Summary

Modifier and Type	Method and Description
org.apache.flink.api.common.typeinfo.TypeInformation<?>	typeArray(org.apache.flink.api.common.typeinfo.TypeInformation<?> elementType, boolean elementsAreNullable) elementsAreNullable is ignored, element values can always be null.
org.apache.flink.api.common.typeinfo.TypeInformation<Boolean>	typeBoolean()
org.apache.flink.api.common.typeinfo.TypeInformation<Double>	typeDecimal()
org.apache.flink.api.common.typeinfo.TypeInformation<Long>	typeInteger()
org.apache.flink.api.common.typeinfo.TypeInformation<?>	typeMap(org.apache.flink.api.common.typeinfo.TypeInformation<?> keyType, org.apache.flink.api.common.typeinfo.TypeInformation<?> valueType, boolean valuesAreNullable) valuesAreNullable is ignored, an map values can always be null.
org.apache.flink.api.common.typeinfo.TypeInformation<Void>	typeNull()
org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row>	typeRow(List<SchemaConversions.RowField<org.apache.flink.api.common.typeinfo.TypeInformation<?>>> rowFields) Converts rowFields to TypeInformation of Row.
org.apache.flink.api.common.typeinfo.TypeInformation<String>	typeString()
org.apache.flink.api.common.typeinfo.TypeInformation<Instant>	typeTimestamp() There are many ways to represent timestamps.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypeInformationSchemaConversions

public TypeInformationSchemaConversions()

Method Detail

typeNull

public org.apache.flink.api.common.typeinfo.TypeInformation<Void> typeNull()

Specified by:

typeNull in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.VOID

typeBoolean

public org.apache.flink.api.common.typeinfo.TypeInformation<Boolean> typeBoolean()

Specified by:

typeBoolean in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.BOOLEAN

typeString

public org.apache.flink.api.common.typeinfo.TypeInformation<String> typeString()

Specified by:

typeString in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.STRING

typeDecimal

public org.apache.flink.api.common.typeinfo.TypeInformation<Double> typeDecimal()

Specified by:

typeDecimal in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.DOUBLE

typeInteger

public org.apache.flink.api.common.typeinfo.TypeInformation<Long> typeInteger()

Specified by:

typeInteger in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.LONG

typeTimestamp

public org.apache.flink.api.common.typeinfo.TypeInformation<Instant> typeTimestamp()

There are many ways to represent timestamps. We want to choose the representation that Flink chooses when converting from TimestampData to DataStream API types. In DataTypeSchemaConversions.typeTimestamp(), we use DataTypes.TIMESTAMP_LTZ(int), which will end up using org.apache.flink.table.data.conversion.LocalZonedTimestampInstantConverter when doing conversions. So, we choose Instant here.

Specified by:

typeTimestamp in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.INSTANT

typeArray

public org.apache.flink.api.common.typeinfo.TypeInformation<?> typeArray(org.apache.flink.api.common.typeinfo.TypeInformation<?> elementType,
                                                                         boolean elementsAreNullable)

elementsAreNullable is ignored, element values can always be null. See Types.OBJECT_ARRAY(org.apache.flink.api.common.typeinfo.TypeInformation<E>).

Specified by:

typeArray in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.OBJECT_ARRAY(org.apache.flink.api.common.typeinfo.TypeInformation<E>)(elementType)

typeMap

public org.apache.flink.api.common.typeinfo.TypeInformation<?> typeMap(org.apache.flink.api.common.typeinfo.TypeInformation<?> keyType,
                                                                       org.apache.flink.api.common.typeinfo.TypeInformation<?> valueType,
                                                                       boolean valuesAreNullable)

valuesAreNullable is ignored, an map values can always be null. See Types.MAP(org.apache.flink.api.common.typeinfo.TypeInformation<K>, org.apache.flink.api.common.typeinfo.TypeInformation<V>).

Specified by:

typeMap in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.MAP(org.apache.flink.api.common.typeinfo.TypeInformation<K>, org.apache.flink.api.common.typeinfo.TypeInformation<V>)(keyType, valueType)

typeRow

public org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> typeRow(@Nonnull
                                                                                                List<SchemaConversions.RowField<org.apache.flink.api.common.typeinfo.TypeInformation<?>>> rowFields)

Converts rowFields to TypeInformation of Row. RowField description and isNullable is ignored. Every field can be null independent of the field's type. See Types.ROW_NAMED(java.lang.String[], org.apache.flink.api.common.typeinfo.TypeInformation<?>...)

Specified by:

typeRow in interface SchemaConversions<org.apache.flink.api.common.typeinfo.TypeInformation<?>>

Returns:

Types.ROW_NAMED(java.lang.String[], org.apache.flink.api.common.typeinfo.TypeInformation<?>...) with RowFields names and types.