org.apache.beam.sdk.coders

Class RowCoder

java.lang.Object

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

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

org.apache.beam.sdk.coders.RowCoder

All Implemented Interfaces:

java.io.Serializable

@Experimental
public class RowCoder
extends CustomCoder<Row>

A Coder for Row. It wraps the Coder for each element directly.

See Also:

Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
static <T> Coder<T>	coderForPrimitiveType(Schema.TypeName typeName) Returns the coder used for a given primitive type.
boolean	consistentWithEquals() Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).
Row	decode(java.io.InputStream inStream) Decodes a value of type T from the given input stream in the given context.
void	encode(Row value, java.io.OutputStream outStream) Encodes the given value of type T onto the given output stream.
static long	estimatedSizeBytes(Row row) Return the estimated serialized size of a give row object.
Schema	getSchema()
static RowCoder	of(Schema schema)
void	verifyDeterministic() Throw Coder.NonDeterministicException if the coding is not deterministic.

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

getCoderArguments

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

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

Method Detail

of

public static RowCoder of(Schema schema)

encode

public void encode(Row 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<Row>

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 Row 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<Row>

Throws:

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

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

getSchema

public Schema getSchema()

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<Row>

Throws:

Coder.NonDeterministicException - if this coder is not deterministic.

consistentWithEquals

public boolean consistentWithEquals()

Description copied from class: Coder

Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).

Whenever the encoded bytes of two values are equal, then the original values are equal according to Objects.equals(). Note that this is well-defined for null.

This condition is most notably false for arrays. More generally, this condition is false whenever equals() compares object identity, rather than performing a semantic/structural comparison.

By default, returns false.

Overrides:

consistentWithEquals in class Coder<Row>

coderForPrimitiveType

public static <T> Coder<T> coderForPrimitiveType(Schema.TypeName typeName)

Returns the coder used for a given primitive type.

estimatedSizeBytes

public static long estimatedSizeBytes(Row row)

Return the estimated serialized size of a give row object.