org.apache.flink.table.runtime.typeutils

Class BinaryRowSerializer

java.lang.Object

org.apache.flink.api.common.typeutils.TypeSerializer<T>

org.apache.flink.table.runtime.typeutils.AbstractRowSerializer<BinaryRow>

org.apache.flink.table.runtime.typeutils.BinaryRowSerializer

All Implemented Interfaces:

Serializable

public class BinaryRowSerializer
extends AbstractRowSerializer<BinaryRow>

Serializer for BinaryRow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BinaryRowSerializer.BinaryRowSerializerSnapshot TypeSerializerSnapshot for BinaryRowSerializer.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH_SIZE_IN_BYTES

Constructor Summary

Constructors

Constructor and Description
BinaryRowSerializer(int numFields)

Method Summary

Modifier and Type	Method and Description
void	checkSkipReadForFixLengthPart(org.apache.flink.runtime.memory.AbstractPagedInputView source) We need skip bytes to read when the remain bytes of current segment is not enough to write binary row fixed part.
BinaryRow	copy(BinaryRow from)
BinaryRow	copy(BinaryRow from, BinaryRow reuse)
void	copy(org.apache.flink.core.memory.DataInputView source, org.apache.flink.core.memory.DataOutputView target)
void	copyFromPagesToView(org.apache.flink.runtime.memory.AbstractPagedInputView source, org.apache.flink.core.memory.DataOutputView target) Copy a binaryRow which stored in paged input view to output view.
BinaryRow	createInstance()
BinaryRow	deserialize(BinaryRow reuse, org.apache.flink.core.memory.DataInputView source)
BinaryRow	deserialize(org.apache.flink.core.memory.DataInputView source)
BinaryRow	deserializeFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView) De-serializes a record from the given source paged input view.
BinaryRow	deserializeFromPages(BinaryRow reuse, org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView) Reuse version of AbstractRowSerializer.deserializeFromPages(AbstractPagedInputView).
org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>	duplicate()
boolean	equals(Object obj)
int	getArity() Get the number of fields.
int	getFixedLengthPartSize()
int	getLength()
int	getSerializedRowFixedPartLength() Return fixed part length to serialize one row.
int	hashCode()
boolean	isImmutableType()
BinaryRow	mapFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView) Map a record from the given source paged input view.
BinaryRow	mapFromPages(BinaryRow reuse, org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView) Reuse version of AbstractRowSerializer.mapFromPages(AbstractPagedInputView).
void	pointTo(int length, BinaryRow reuse, org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView) Point row to memory segments with offset(in the AbstractPagedInputView) and length.
void	serialize(BinaryRow record, org.apache.flink.core.memory.DataOutputView target)
int	serializeToPages(BinaryRow record, org.apache.flink.runtime.memory.AbstractPagedOutputView headerLessView) Serializes the given record to the given target paged output view.
static void	serializeWithoutLengthSlow(BinaryRow record, org.apache.flink.core.memory.MemorySegmentWritable out)
org.apache.flink.api.common.typeutils.TypeSerializerSnapshot<BinaryRow>	snapshotConfiguration()
BinaryRow	toBinaryRow(BinaryRow baseRow) Convert a BaseRow to a BinaryRow.

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH_SIZE_IN_BYTES

public static final int LENGTH_SIZE_IN_BYTES

See Also:

Constant Field Values

Constructor Detail

BinaryRowSerializer

public BinaryRowSerializer(int numFields)

Method Detail

isImmutableType

public boolean isImmutableType()

Specified by:

isImmutableType in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

duplicate

public org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow> duplicate()

Specified by:

duplicate in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

createInstance

public BinaryRow createInstance()

Specified by:

createInstance in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

copy

public BinaryRow copy(BinaryRow from)

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

copy

public BinaryRow copy(BinaryRow from,
                      BinaryRow reuse)

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

getLength

public int getLength()

Specified by:

getLength in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

serialize

public void serialize(BinaryRow record,
                      org.apache.flink.core.memory.DataOutputView target)
               throws IOException

Specified by:

serialize in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

Throws:

IOException

deserialize

public BinaryRow deserialize(org.apache.flink.core.memory.DataInputView source)
                      throws IOException

Specified by:

deserialize in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

Throws:

IOException

deserialize

public BinaryRow deserialize(BinaryRow reuse,
                             org.apache.flink.core.memory.DataInputView source)
                      throws IOException

Specified by:

deserialize in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

Throws:

IOException

getArity

public int getArity()

Description copied from class: AbstractRowSerializer

Get the number of fields.

Specified by:

getArity in class AbstractRowSerializer<BinaryRow>

toBinaryRow

public BinaryRow toBinaryRow(BinaryRow baseRow)
                      throws IOException

Description copied from class: AbstractRowSerializer

Convert a BaseRow to a BinaryRow.

Specified by:

toBinaryRow in class AbstractRowSerializer<BinaryRow>

Throws:

IOException

serializeToPages

public int serializeToPages(BinaryRow record,
                            org.apache.flink.runtime.memory.AbstractPagedOutputView headerLessView)
                     throws IOException

Description copied from class: AbstractRowSerializer

Serializes the given record to the given target paged output view. Some implementations may skip some bytes if current page does not have enough space left, .e.g BinaryRow.

Specified by:

serializeToPages in class AbstractRowSerializer<BinaryRow>

Parameters:

record - The record to serialize.

headerLessView - The output view to write the serialized data to.

Returns:

Returns the skipped number of bytes.

Throws:

IOException - Thrown, if the serialization encountered an I/O related error. Typically raised by the output view, which may have an underlying I/O channel to which it delegates.

serializeWithoutLengthSlow

public static void serializeWithoutLengthSlow(BinaryRow record,
                                              org.apache.flink.core.memory.MemorySegmentWritable out)
                                       throws IOException

Throws:

IOException

deserializeFromPages

public BinaryRow deserializeFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView)
                               throws IOException

Description copied from class: AbstractRowSerializer

De-serializes a record from the given source paged input view. For consistency with serialize format, some implementations may need to skip some bytes of source before de-serializing, .e.g BinaryRow. Typically, the content read from source should be copied out when de-serializing, and we are not expecting the underlying data from source is reused. If you have such requirement, see AbstractRowSerializer.mapFromPages(AbstractPagedInputView).

Specified by:

deserializeFromPages in class AbstractRowSerializer<BinaryRow>

Parameters:

headerLessView - The input view from which to read the data.

Returns:

The de-serialized element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

deserializeFromPages

public BinaryRow deserializeFromPages(BinaryRow reuse,
                                      org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView)
                               throws IOException

Description copied from class: AbstractRowSerializer

Reuse version of AbstractRowSerializer.deserializeFromPages(AbstractPagedInputView).

Specified by:

deserializeFromPages in class AbstractRowSerializer<BinaryRow>

Throws:

IOException

mapFromPages

public BinaryRow mapFromPages(org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView)
                       throws IOException

Description copied from class: AbstractRowSerializer

Map a record from the given source paged input view. This method provides a possibility to achieve zero copy when de-serializing. You can either choose copy or not copy the content read from source, but we encourage to make it zero copy.

If you choose the zero copy way, you have to deal with the lifecycle of the pages properly.

Specified by:

mapFromPages in class AbstractRowSerializer<BinaryRow>

Parameters:

headerLessView - The input view from which to read the data.

Returns:

The mapped element.

Throws:

IOException - Thrown, if the de-serialization encountered an I/O related error. Typically raised by the input view, which may have an underlying I/O channel from which it reads.

mapFromPages

public BinaryRow mapFromPages(BinaryRow reuse,
                              org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView)
                       throws IOException

Description copied from class: AbstractRowSerializer

Reuse version of AbstractRowSerializer.mapFromPages(AbstractPagedInputView).

Specified by:

mapFromPages in class AbstractRowSerializer<BinaryRow>

Throws:

IOException

copyFromPagesToView

public void copyFromPagesToView(org.apache.flink.runtime.memory.AbstractPagedInputView source,
                                org.apache.flink.core.memory.DataOutputView target)
                         throws IOException

Copy a binaryRow which stored in paged input view to output view.

Parameters:

source - source paged input view where the binary row stored

target - the target output view.

Throws:

IOException

pointTo

public void pointTo(int length,
                    BinaryRow reuse,
                    org.apache.flink.runtime.memory.AbstractPagedInputView headerLessView)
             throws IOException

Point row to memory segments with offset(in the AbstractPagedInputView) and length.

Parameters:

length - row length.

reuse - reuse BinaryRow object.

headerLessView - source memory segments container.

Throws:

IOException

checkSkipReadForFixLengthPart

public void checkSkipReadForFixLengthPart(org.apache.flink.runtime.memory.AbstractPagedInputView source)
                                   throws IOException

We need skip bytes to read when the remain bytes of current segment is not enough to write binary row fixed part. See BinaryRow.

Throws:

IOException

getSerializedRowFixedPartLength

public int getSerializedRowFixedPartLength()

Return fixed part length to serialize one row.

getFixedLengthPartSize

public int getFixedLengthPartSize()

copy

public void copy(org.apache.flink.core.memory.DataInputView source,
                 org.apache.flink.core.memory.DataOutputView target)
          throws IOException

Specified by:

copy in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

Throws:

IOException

equals

public boolean equals(Object obj)

Specified by:

equals in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

hashCode

public int hashCode()

Specified by:

hashCode in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>

snapshotConfiguration

public org.apache.flink.api.common.typeutils.TypeSerializerSnapshot<BinaryRow> snapshotConfiguration()

Specified by:

snapshotConfiguration in class org.apache.flink.api.common.typeutils.TypeSerializer<BinaryRow>