org.apache.flink.table.dataformat.vector.heap

Class HeapBytesVector

java.lang.Object

org.apache.flink.table.dataformat.vector.AbstractColumnVector

org.apache.flink.table.dataformat.vector.heap.AbstractHeapVector

org.apache.flink.table.dataformat.vector.heap.HeapBytesVector

All Implemented Interfaces:

Serializable, BytesColumnVector, ColumnVector

public class HeapBytesVector
extends AbstractHeapVector
implements BytesColumnVector

This class supports string and binary data by value reference -- i.e. each field is explicitly present, as opposed to provided by a dictionary reference. In some cases, all the values will be in the same byte array to begin with, but this need not be the case. If each value is in a separate byte array to start with, or not all of the values are in the same original byte array, you can still assign data by reference into this column vector. This gives flexibility to use this in multiple situations.

When setting data by reference, the caller is responsible for allocating the byte arrays used to hold the data. You can also set data by value, as long as you call the initBuffer() method first. You can mix "by value" and "by reference" in the same column vector, though that use is probably not typical.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.dataformat.vector.BytesColumnVector

BytesColumnVector.Bytes

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	buffer buffer to use when actually copying in data.
int[]	length The length of each field.
int[]	start start offset of each field.

Fields inherited from class org.apache.flink.table.dataformat.vector.heap.AbstractHeapVector

dictionaryIds, isNull

Fields inherited from class org.apache.flink.table.dataformat.vector.AbstractColumnVector

dictionary, noNulls

Constructor Summary

Constructors

Constructor and Description
HeapBytesVector(int size) Don't call this constructor except for testing purposes.

Method Summary

Modifier and Type	Method and Description
BytesColumnVector.Bytes	getBytes(int i)
void	reset() Resets the column to default state.
void	setVal(int elementNum, byte[] sourceBuf) Set a field by actually copying in to a local buffer.
void	setVal(int elementNum, byte[] sourceBuf, int start, int length) Set a field by actually copying in to a local buffer.

Methods inherited from class org.apache.flink.table.dataformat.vector.heap.AbstractHeapVector

getDictionaryIds, isNullAt, reserveDictionaryIds, setNullAt

Methods inherited from class org.apache.flink.table.dataformat.vector.AbstractColumnVector

hasDictionary, setDictionary

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.dataformat.vector.ColumnVector

isNullAt

Field Detail

start

public int[] start

start offset of each field.

length

public int[] length

The length of each field.

buffer

public byte[] buffer

buffer to use when actually copying in data.

Constructor Detail

HeapBytesVector

public HeapBytesVector(int size)

Don't call this constructor except for testing purposes.

Parameters:

size - number of elements in the column vector

Method Detail

reset

public void reset()

Description copied from class: AbstractHeapVector

Resets the column to default state. - fills the isNull array with false. - sets noNulls to true.

Specified by:

reset in interface ColumnVector

Overrides:

reset in class AbstractHeapVector

setVal

public void setVal(int elementNum,
                   byte[] sourceBuf,
                   int start,
                   int length)

Set a field by actually copying in to a local buffer. If you must actually copy data in to the array, use this method. DO NOT USE this method unless it's not practical to set data by reference with setRef(). Setting data by reference tends to run a lot faster than copying data in.

Parameters:

elementNum - index within column vector to set

sourceBuf - container of source data

start - start byte position within source

length - length of source byte sequence

setVal

public void setVal(int elementNum,
                   byte[] sourceBuf)

Set a field by actually copying in to a local buffer. If you must actually copy data in to the array, use this method. DO NOT USE this method unless it's not practical to set data by reference with setRef(). Setting data by reference tends to run a lot faster than copying data in.

Parameters:

elementNum - index within column vector to set

sourceBuf - container of source data

getBytes

public BytesColumnVector.Bytes getBytes(int i)

Specified by:

getBytes in interface BytesColumnVector