org.apache.beam.sdk.values.reflect

Class InferredRowCoder<T>

java.lang.Object

org.apache.beam.sdk.coders.Coder<T>

org.apache.beam.sdk.coders.CustomCoder<T>

org.apache.beam.sdk.values.reflect.InferredRowCoder<T>

All Implemented Interfaces:

java.io.Serializable

@Experimental
public abstract class InferredRowCoder<T>
extends CustomCoder<T>

Provides interface to create Schema and then Row instances based on the element type.

Relies on delegate elementCoder to encode original elements.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Constructor Summary

Constructors

Constructor and Description
InferredRowCoder()

Method Summary

Modifier and Type	Method and Description
Row	createRow(T element)
T	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
void	encode(T value, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
static <W> InferredRowCoder<W>	of(java.lang.Class<W> elementType, Coder<W> elementCoder) Creates a InferredRowCoder delegating to the elementCoder for encoding the PCollection elements.
static <W extends java.io.Serializable> InferredRowCoder<W>	ofSerializable(java.lang.Class<W> elementType) Creates a InferredRowCoder delegating to the SerializableCoder for encoding the PCollection elements.
RowCoder	rowCoder()
Schema	schema()
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.
InferredRowCoder<T>	withSchemaFactory(SchemaFactory schemaFactory) Returns a InferredRowCoder with row type factory overridden by schemaFactory.

Methods inherited from class org.apache.beam.sdk.coders.CustomCoder

getCoderArguments

Methods inherited from class org.apache.beam.sdk.coders.Coder

consistentWithEquals, decode, encode, getEncodedElementByteSize, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Detail

InferredRowCoder

public InferredRowCoder()

Method Detail

ofSerializable

public static <W extends java.io.Serializable> InferredRowCoder<W> ofSerializable(java.lang.Class<W> elementType)

Creates a InferredRowCoder delegating to the SerializableCoder for encoding the PCollection elements.

of

public static <W> InferredRowCoder<W> of(java.lang.Class<W> elementType,
                                         Coder<W> elementCoder)

Creates a InferredRowCoder delegating to the elementCoder for encoding the PCollection elements.

withSchemaFactory

public InferredRowCoder<T> withSchemaFactory(SchemaFactory schemaFactory)

Returns a InferredRowCoder with row type factory overridden by schemaFactory.

schema

public Schema schema()

rowCoder

public RowCoder rowCoder()

createRow

public Row createRow(T element)

encode

public void encode(T value,
                   java.io.OutputStream outStream)
            throws java.io.IOException

Description copied from class: Coder

Encodes the given value of type T onto the given output stream.

Specified by:

encode in class Coder<T>

Throws:

java.io.IOException - if writing to the OutputStream fails for some reason

CoderException - if the value could not be encoded for some reason

decode

public T decode(java.io.InputStream inStream)
         throws java.io.IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value.

Specified by:

decode in class Coder<T>

Throws:

java.io.IOException - if reading from the InputStream fails for some reason

CoderException - if the value could not be decoded for some reason

verifyDeterministic

public void verifyDeterministic()
                         throws Coder.NonDeterministicException

Description copied from class: CustomCoder

Throw Coder.NonDeterministicException if the coding is not deterministic.

In order for a Coder to be considered deterministic, the following must be true:

• two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
• the Coder always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.

Overrides:

verifyDeterministic in class CustomCoder<T>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.