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

public abstract class BaseDataValueVector
extends BaseValueVector
implements BufferBacked

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrowBuf	data

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.
ArrowBuf	getBuffer()
ArrowBuf[]	getBuffers(boolean clear) Return the underlying buffers associated with this vector.
int	getBufferSize()
TransferPair	getTransferPair(String ref, BufferAllocator allocator, CallBack callBack)
void	load(ArrowFieldNode fieldNode, ArrowBuf data)
static void	load(ArrowFieldNode fieldNode, List<BufferBacked> vectors, List<ArrowBuf> buffers)
void	reset() This method has a similar effect of allocateNew() without actually clearing and reallocating the value vector.
static void	truncateBufferBasedOnSize(List<ArrowBuf> buffers, int bufferIndex, int byteSize)
ArrowBuf	unLoad()
static List<ArrowBuf>	unload(List<BufferBacked> vectors)

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

checkBufRefs, close, compareTypes, getAllocator, getTransferPair, getValidityBufferSizeFromCount, iterator, releaseBuffer, 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, getBufferSizeFor, getDataBuffer, getField, getMinorType, getNullCount, getObject, getOffsetBuffer, getReader, getTransferPair, getValidityBuffer, getValueCapacity, getValueCount, isNull, makeTransferPair, reAlloc, setInitialCapacity, setValueCount

Field Detail

data

protected ArrowBuf data

Constructor Detail

BaseDataValueVector

public BaseDataValueVector(String name,
                   BufferAllocator allocator)

Method Detail

load

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

truncateBufferBasedOnSize

public static void truncateBufferBasedOnSize(List<ArrowBuf> buffers,
                             int bufferIndex,
                             int byteSize)

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

getTransferPair

public TransferPair getTransferPair(String ref,
                           BufferAllocator allocator,
                           CallBack callBack)

Specified by:

getTransferPair in interface ValueVector

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()

Specified by:

getBufferSize in interface ValueVector

Returns:

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

getBuffer

public ArrowBuf getBuffer()

load

public void load(ArrowFieldNode fieldNode,
        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