org.apache.arrow.vector

Class BaseDataValueVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseDataValueVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, BufferBacked, ValueVector

Direct Known Subclasses:

BigIntVector, BitVector, DateVector, DecimalVector, Float4Vector, Float8Vector, IntervalDayVector, IntervalYearVector, IntVector, NullableBigIntVector, NullableBitVector, NullableDateVector, NullableDecimalVector, NullableFloat4Vector, NullableFloat8Vector, NullableIntervalDayVector, NullableIntervalYearVector, NullableIntVector, NullableSmallIntVector, NullableTimeStampVector, NullableTimeVector, NullableTinyIntVector, NullableUInt1Vector, NullableUInt2Vector, NullableUInt4Vector, NullableUInt8Vector, NullableVarBinaryVector, NullableVarCharVector, SmallIntVector, TimeStampVector, TimeVector, TinyIntVector, UInt1Vector, UInt2Vector, UInt4Vector, UInt8Vector, VarBinaryVector, VarCharVector

public abstract class BaseDataValueVector
extends BaseValueVector
implements BufferBacked

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.arrow.vector.BaseValueVector

BaseValueVector.BaseAccessor, BaseValueVector.BaseMutator

Nested classes/interfaces inherited from interface org.apache.arrow.vector.ValueVector

ValueVector.Accessor, ValueVector.Mutator

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrowBuf	data
protected static byte[]	emptyByteArray

Fields inherited from class org.apache.arrow.vector.BaseValueVector

allocator, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY, name

Constructor Summary

Constructors

Constructor and Description
BaseDataValueVector(String name, BufferAllocator allocator)

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Release the underlying ArrowBuf and reset the ValueVector to empty.
void	close() Alternative to clear().
ArrowBuf	getBuffer()
ArrowBuf[]	getBuffers(boolean clear) Return the underlying buffers associated with this vector.
int	getBufferSize() Returns the number of bytes that is used by this vector instance.
void	load(ArrowBuf data)
static void	load(List<BufferBacked> vectors, List<ArrowBuf> buffers)
void	reset() This method has a similar effect of allocateNew() without actually clearing and reallocating the value vector.
ArrowBuf	unLoad()
static List<ArrowBuf>	unload(List<BufferBacked> vectors)

Methods inherited from class org.apache.arrow.vector.BaseValueVector

checkBufRefs, getAllocator, getTransferPair, iterator, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.arrow.vector.ValueVector

allocateNew, allocateNewSafe, getAccessor, getBufferSizeFor, getField, getMinorType, getMutator, getReader, getTransferPair, getValueCapacity, makeTransferPair, setInitialCapacity

Field Detail

emptyByteArray

protected static final byte[] emptyByteArray

data

protected ArrowBuf data

Constructor Detail

BaseDataValueVector

public BaseDataValueVector(String name,
                   BufferAllocator allocator)

Method Detail

load

public static void load(List<BufferBacked> vectors,
        List<ArrowBuf> buffers)

unload

public static List<ArrowBuf> unload(List<BufferBacked> vectors)

clear

public void clear()

Description copied from interface: ValueVector

Release the underlying ArrowBuf and reset the ValueVector to empty.

Specified by:

clear in interface ValueVector

Overrides:

clear in class BaseValueVector

close

public void close()

Description copied from interface: ValueVector

Alternative to clear(). Allows use as an AutoCloseable in try-with-resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ValueVector

Overrides:

close in class BaseValueVector

getBuffers

public ArrowBuf[] getBuffers(boolean clear)

Description copied from interface: ValueVector

Return the underlying buffers associated with this vector. Note that this doesn't impact the reference counts for this buffer so it only should be used for in-context access. Also note that this buffer changes regularly thus external classes shouldn't hold a reference to it (unless they change it).

Specified by:

getBuffers in interface ValueVector

Parameters:

clear - Whether to clear vector before returning; the buffers will still be refcounted; but the returned array will be the only reference to them

Returns:

The underlying buffers that is used by this vector instance.

getBufferSize

public int getBufferSize()

Description copied from interface: ValueVector

Returns the number of bytes that is used by this vector instance.

Specified by:

getBufferSize in interface ValueVector

getBuffer

public ArrowBuf getBuffer()

load

public void load(ArrowBuf data)

Specified by:

load in interface BufferBacked

unLoad

public ArrowBuf unLoad()

Specified by:

unLoad in interface BufferBacked

reset

public void reset()

This method has a similar effect of allocateNew() without actually clearing and reallocating the value vector. The purpose is to move the value vector to a "mutate" state