org.apache.arrow.vector

Interface VariableWidthVector

All Superinterfaces:

AutoCloseable, Closeable, Iterable<ValueVector>, ValueVector

All Known Implementing Classes:

NullableVarBinaryVector, NullableVarCharVector, VarBinaryVector, VarCharVector

public interface VariableWidthVector
extends ValueVector

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VariableWidthVector.VariableWidthAccessor
static interface	VariableWidthVector.VariableWidthMutator

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

ValueVector.Accessor, ValueVector.Mutator

Method Summary

Modifier and Type	Method and Description
void	allocateNew(int totalBytes, int valueCount) Allocate a new memory space for this vector.
VariableWidthVector.VariableWidthAccessor	getAccessor()
int	getByteCapacity() Provide the maximum amount of variable width bytes that can be stored in this vector.
int	getCurrentSizeInBytes()
VariableWidthVector.VariableWidthMutator	getMutator()

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

allocateNew, allocateNewSafe, clear, close, getAllocator, getBuffers, getBufferSize, getBufferSizeFor, getDataBuffer, getField, getMinorType, getOffsetBuffer, getReader, getTransferPair, getTransferPair, getTransferPair, getValidityBuffer, getValueCapacity, makeTransferPair, reAlloc, setInitialCapacity

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

allocateNew

void allocateNew(int 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.

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

getMutator

VariableWidthVector.VariableWidthMutator getMutator()

Specified by:

getMutator in interface ValueVector

Returns:

an mutator that is used to write to this vector instance.

getAccessor

VariableWidthVector.VariableWidthAccessor getAccessor()

Specified by:

getAccessor in interface ValueVector

Returns:

an accessor that is used to read from this vector instance.

getCurrentSizeInBytes

int getCurrentSizeInBytes()