edu.snu.coral.compiler.frontend.beam.coder

Class PairCoder<A,B>

java.lang.Object

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

org.apache.beam.sdk.coders.StructuredCoder<Pair<A,B>>

edu.snu.coral.compiler.frontend.beam.coder.PairCoder<A,B>

Type Parameters:

A - type for the left coder.

B - type for the right coder.

All Implemented Interfaces:

Serializable

public final class PairCoder<A,B>
extends org.apache.beam.sdk.coders.StructuredCoder<Pair<A,B>>

BEAM Coder for Pair. Reference: KvCoder in BEAM.

See Also:

Serialized Form

Nested Class Summary

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

org.apache.beam.sdk.coders.Coder.Context, org.apache.beam.sdk.coders.Coder.NonDeterministicException

Method Summary

Modifier and Type	Method and Description
boolean	consistentWithEquals()
Pair<A,B>	decode(InputStream inStream)
void	encode(Pair<A,B> pair, OutputStream outStream)
List<? extends org.apache.beam.sdk.coders.Coder<?>>	getCoderArguments()
boolean	isRegisterByteSizeObserverCheap(Pair<A,B> pair) Returns whether both leftCoder and rightCoder are considered not expensive.
static <A,B> PairCoder<A,B>	of(org.apache.beam.sdk.coders.Coder<A> leftCoder, org.apache.beam.sdk.coders.Coder<B> rightCoder) static initializer of the class.
void	registerByteSizeObserver(Pair<A,B> pair, org.apache.beam.sdk.util.common.ElementByteSizeObserver observer) Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder.
Object	structuralValue(Pair<A,B> pair)
void	verifyDeterministic()

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

equals, getComponents, getEncodedTypeDescriptor, hashCode, toString

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

decode, encode, getEncodedElementByteSize, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Method Detail

of

public static <A,B> PairCoder<A,B> of(org.apache.beam.sdk.coders.Coder<A> leftCoder,
                                      org.apache.beam.sdk.coders.Coder<B> rightCoder)

static initializer of the class.

Type Parameters:

A - type of the left element.

B - type of the right element.

Parameters:

leftCoder - left coder.

rightCoder - right coder.

Returns:

the new PairCoder.

encode

public void encode(Pair<A,B> pair,
                   OutputStream outStream)
            throws IOException

Specified by:

encode in class org.apache.beam.sdk.coders.Coder<Pair<A,B>>

Throws:

IOException

decode

public Pair<A,B> decode(InputStream inStream)
                 throws IOException

Specified by:

decode in class org.apache.beam.sdk.coders.Coder<Pair<A,B>>

Throws:

IOException

getCoderArguments

public List<? extends org.apache.beam.sdk.coders.Coder<?>> getCoderArguments()

Specified by:

getCoderArguments in class org.apache.beam.sdk.coders.Coder<Pair<A,B>>

verifyDeterministic

public void verifyDeterministic()
                         throws org.apache.beam.sdk.coders.Coder.NonDeterministicException

Specified by:

verifyDeterministic in class org.apache.beam.sdk.coders.Coder<Pair<A,B>>

Throws:

org.apache.beam.sdk.coders.Coder.NonDeterministicException

consistentWithEquals

public boolean consistentWithEquals()

Overrides:

consistentWithEquals in class org.apache.beam.sdk.coders.StructuredCoder<Pair<A,B>>

structuralValue

public Object structuralValue(Pair<A,B> pair)

Overrides:

structuralValue in class org.apache.beam.sdk.coders.StructuredCoder<Pair<A,B>>

isRegisterByteSizeObserverCheap

public boolean isRegisterByteSizeObserverCheap(Pair<A,B> pair)

Returns whether both leftCoder and rightCoder are considered not expensive.

Overrides:

isRegisterByteSizeObserverCheap in class org.apache.beam.sdk.coders.Coder<Pair<A,B>>

registerByteSizeObserver

public void registerByteSizeObserver(Pair<A,B> pair,
                                     org.apache.beam.sdk.util.common.ElementByteSizeObserver observer)
                              throws Exception

Notifies ElementByteSizeObserver about the byte size of the encoded value using this coder.

Overrides:

registerByteSizeObserver in class org.apache.beam.sdk.coders.Coder<Pair<A,B>>

Throws:

Exception