org.apache.arrow.vector

Class BaseValueVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, ValueVector

Direct Known Subclasses:

BaseFixedWidthVector, BaseRepeatedValueVector, BaseVariableWidthVector, FixedSizeListVector

public abstract class BaseValueVector
extends Object
implements ValueVector

Field Summary

Fields

Modifier and Type	Field and Description
protected BufferAllocator	allocator
static int	INITIAL_VALUE_ALLOCATION
static int	MAX_ALLOCATION_SIZE
static String	MAX_ALLOCATION_SIZE_PROPERTY
protected String	name

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseValueVector(String name, BufferAllocator allocator)

Method Summary

Modifier and Type	Method and Description
protected org.apache.arrow.vector.BaseValueVector.DataAndValidityBuffers	allocFixedDataAndValidityBufs(int valueCount, int typeWidth)
static boolean	checkBufRefs(ValueVector vv)
void	clear() Release any owned ArrowBuf and reset the ValueVector to the initial state.
void	close() Alternative to clear().
protected void	compareTypes(BaseValueVector target, String caller)
protected long	computeCombinedBufferSize(int valueCount, int typeWidth)
BufferAllocator	getAllocator()
TransferPair	getTransferPair(BufferAllocator allocator) To transfer quota responsibility.
protected static int	getValidityBufferSizeFromCount(int valueCount)
Iterator<ValueVector>	iterator()
protected ArrowBuf	releaseBuffer(ArrowBuf buffer)
String	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, getBuffers, getBufferSize, getBufferSizeFor, getDataBuffer, getField, getMinorType, getNullCount, getObject, getOffsetBuffer, getReader, getTransferPair, getTransferPair, getValidityBuffer, getValueCapacity, getValueCount, isNull, makeTransferPair, reAlloc, reset, setInitialCapacity, setValueCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

MAX_ALLOCATION_SIZE_PROPERTY

public static final String MAX_ALLOCATION_SIZE_PROPERTY

See Also:

Constant Field Values

MAX_ALLOCATION_SIZE

public static final int MAX_ALLOCATION_SIZE

INITIAL_VALUE_ALLOCATION

public static final int INITIAL_VALUE_ALLOCATION

See Also:

Constant Field Values

allocator

protected final BufferAllocator allocator

name

protected final String name

Constructor Detail

BaseValueVector

protected BaseValueVector(String name,
                          BufferAllocator allocator)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

clear

public void clear()

Description copied from interface: ValueVector

Release any owned ArrowBuf and reset the ValueVector to the initial state. If the vector has any child vectors, they will also be cleared.

Specified by:

clear in interface ValueVector

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

getTransferPair

public TransferPair getTransferPair(BufferAllocator allocator)

Description copied from interface: ValueVector

To transfer quota responsibility.

Specified by:

getTransferPair in interface ValueVector

Parameters:

allocator - the target allocator

Returns:

a transfer pair, creating a new target vector of the same type.

iterator

public Iterator<ValueVector> iterator()

Specified by:

iterator in interface Iterable<ValueVector>

checkBufRefs

public static boolean checkBufRefs(ValueVector vv)

getAllocator

public BufferAllocator getAllocator()

Specified by:

getAllocator in interface ValueVector

compareTypes

protected void compareTypes(BaseValueVector target,
                            String caller)

releaseBuffer

protected ArrowBuf releaseBuffer(ArrowBuf buffer)

getValidityBufferSizeFromCount

protected static int getValidityBufferSizeFromCount(int valueCount)

computeCombinedBufferSize

protected long computeCombinedBufferSize(int valueCount,
                                         int typeWidth)

allocFixedDataAndValidityBufs

protected org.apache.arrow.vector.BaseValueVector.DataAndValidityBuffers allocFixedDataAndValidityBufs(int valueCount,
                                                                                                       int typeWidth)