Module org.apache.arrow.vector

Package org.apache.arrow.vector

Interface VariableWidthVector

All Superinterfaces:

AutoCloseable, Closeable, DensityAwareVector, ElementAddressableVector, Iterable<ValueVector>, ValueVector

All Known Subinterfaces:

VariableWidthFieldVector

All Known Implementing Classes:

BaseLargeVariableWidthVector, BaseVariableWidthVector, BaseVariableWidthViewVector, LargeVarBinaryVector, LargeVarCharVector, VarBinaryVector, VarCharVector, ViewVarBinaryVector, ViewVarCharVector

public interface VariableWidthVector
extends ElementAddressableVector, DensityAwareVector

Interface vectors that contain variable width members (e.g. Strings, Lists, etc).

Method Summary

Modifier and Type	Method	Description
void	allocateNew(int valueCount)	Allocate a new memory space for this vector.
void	allocateNew(long totalBytes, int valueCount)	Allocate a new memory space for this vector.
int	getByteCapacity()	Provide the maximum amount of variable width bytes that can be stored in this vector.
int	sizeOfValueBuffer()	Provide the number of bytes contained in the valueBuffer.

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

setInitialCapacity

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

getDataPointer, getDataPointer

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

accept, allocateNew, allocateNewSafe, clear, close, copyFrom, copyFromSafe, getAllocator, getBuffers, getBufferSize, getBufferSizeFor, getDataBuffer, getField, getMinorType, getName, getNullCount, getObject, getOffsetBuffer, getReader, getTransferPair, getTransferPair, getTransferPair, getTransferPair, getTransferPair, getValidityBuffer, getValueCapacity, getValueCount, hashCode, hashCode, isNull, makeTransferPair, reAlloc, reset, setInitialCapacity, setValueCount, validate, validateFull

Method Details

allocateNew

void allocateNew(long totalBytes,
 int valueCount)

Allocate a new memory space for this vector. Must be called prior to using the ValueVector.

Parameters:

totalBytes - Desired size of the underlying data buffer.

valueCount - Number of values in the vector.

allocateNew

void allocateNew(int valueCount)

Allocate a new memory space for this vector. Must be called prior to using the ValueVector. The initial size in bytes is either default (or) reused from previous allocation

Parameters:

valueCount - Number of values in the vector.

getByteCapacity

int getByteCapacity()

Provide the maximum amount of variable width bytes that can be stored in this vector.

Returns:

the byte capacity of this vector

sizeOfValueBuffer

int sizeOfValueBuffer()

Provide the number of bytes contained in the valueBuffer.

Returns:

the number of bytes in valueBuffer.