Package org.apache.flink.formats.json

Class AbstractJsonDeserializationSchema

java.lang.Object

org.apache.flink.formats.json.AbstractJsonDeserializationSchema

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData>, org.apache.flink.api.java.typeutils.ResultTypeQueryable<org.apache.flink.table.data.RowData>

Direct Known Subclasses:

JsonParserRowDataDeserializationSchema, JsonRowDataDeserializationSchema

public abstract class AbstractJsonDeserializationSchema
extends Object
implements org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData>

Deserialization schema from JSON to Flink Table/SQL internal data structure RowData. This is the abstract base class which has different implementation.

Failures during deserialization are forwarded as wrapped IOExceptions.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.api.common.serialization.DeserializationSchema

org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	failOnMissingField	Flag indicating whether to fail if a field is missing.
protected boolean	ignoreParseErrors	Flag indicating whether to ignore invalid fields/rows (default: throw an exception).
protected org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper	objectMapper	Object mapper for parsing the JSON.

Constructor Summary

Constructors

Constructor	Description
AbstractJsonDeserializationSchema(org.apache.flink.table.types.logical.RowType rowType, org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData> resultTypeInfo, boolean failOnMissingField, boolean ignoreParseErrors, org.apache.flink.formats.common.TimestampFormat timestampFormat)

Method Summary

Modifier and Type	Method	Description
org.apache.flink.table.data.RowData	deserialize(byte[] message)	Deprecated. Use DeserializationSchema.deserialize(byte[], Collector) instead.
boolean	equals(Object o)
org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData>	getProducedType()
int	hashCode()
boolean	isEndOfStream(org.apache.flink.table.data.RowData nextElement)
void	open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.api.common.serialization.DeserializationSchema

deserialize

Field Detail

failOnMissingField

protected final boolean failOnMissingField

Flag indicating whether to fail if a field is missing.

ignoreParseErrors

protected final boolean ignoreParseErrors

Flag indicating whether to ignore invalid fields/rows (default: throw an exception).

objectMapper

protected transient org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.ObjectMapper objectMapper

Object mapper for parsing the JSON.

Constructor Detail

AbstractJsonDeserializationSchema

public AbstractJsonDeserializationSchema(org.apache.flink.table.types.logical.RowType rowType,
                                         org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData> resultTypeInfo,
                                         boolean failOnMissingField,
                                         boolean ignoreParseErrors,
                                         org.apache.flink.formats.common.TimestampFormat timestampFormat)

Method Detail

open

public void open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context)
          throws Exception

Specified by:

open in interface org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData>

Throws:

Exception

deserialize

@Deprecated
public org.apache.flink.table.data.RowData deserialize(@Nullable
                                                       byte[] message)
                                                throws IOException

Deprecated.

Use DeserializationSchema.deserialize(byte[], Collector) instead. The implementation of deserialize(byte[]) will be removed in FLINK-37707.

Specified by:

deserialize in interface org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData>

Throws:

IOException

isEndOfStream

public boolean isEndOfStream(org.apache.flink.table.data.RowData nextElement)

Specified by:

isEndOfStream in interface org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData>

getProducedType

public org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData> getProducedType()

Specified by:

getProducedType in interface org.apache.flink.api.java.typeutils.ResultTypeQueryable<org.apache.flink.table.data.RowData>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object