org.apache.arrow.vector.complex

Class BaseRepeatedValueVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.complex.BaseRepeatedValueVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, RepeatedValueVector, ValueVector

Direct Known Subclasses:

ListVector

public abstract class BaseRepeatedValueVector
extends BaseValueVector
implements RepeatedValueVector

Field Summary

Fields

Modifier and Type	Field and Description
protected CallBack	callBack
static String	DATA_VECTOR_NAME
static FieldVector	DEFAULT_DATA_VECTOR
static byte	OFFSET_WIDTH
protected int	offsetAllocationSizeInBytes
protected ArrowBuf	offsetBuffer
protected int	valueCount
protected FieldVector	vector

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

allocator, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY, name

Fields inherited from interface org.apache.arrow.vector.complex.RepeatedValueVector

DEFAULT_REPEAT_PER_RECORD

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseRepeatedValueVector(String name, BufferAllocator allocator, CallBack callBack)
protected	BaseRepeatedValueVector(String name, BufferAllocator allocator, FieldVector vector, CallBack callBack)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ValueVector> AddOrGetResult<T>	addOrGetVector(FieldType fieldType)
boolean	allocateNewSafe() Allocates new buffers.
protected void	allocateOffsetBuffer(long size)
void	clear() Release the underlying ArrowBuf and reset the ValueVector to empty.
ArrowBuf[]	getBuffers(boolean clear) Return the underlying buffers associated with this vector.
int	getBufferSize()
int	getBufferSizeFor(int valueCount) Returns the number of bytes that is used by this vector if it holds the given number of values.
FieldVector	getDataVector()
int	getInnerValueCount()
int	getInnerValueCountAt(int index)
protected int	getOffsetBufferValueCapacity()
UInt4Vector	getOffsetVector() Deprecated.
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
int	getValueCount() Gets the number of values
boolean	isEmpty(int index)
boolean	isNull(int index) Check whether an element in the vector is null
Iterator<ValueVector>	iterator()
void	reAlloc() Allocate new buffer with double capacity, and copy data into the new buffer.
protected void	reallocOffsetBuffer()
protected void	replaceDataVector(FieldVector v)
void	setInitialCapacity(int numRecords) Set the initial record capacity
void	setValueCount(int valueCount) Set number of values in the vector
int	size()
int	startNewValue(int index)

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

checkBufRefs, close, compareTypes, getAllocator, getTransferPair, getValidityBufferSizeFromCount, 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, close, getAllocator, getDataBuffer, getField, getMinorType, getNullCount, getObject, getOffsetBuffer, getReader, getTransferPair, getTransferPair, getTransferPair, getValidityBuffer, makeTransferPair

Field Detail

DEFAULT_DATA_VECTOR

public static final FieldVector DEFAULT_DATA_VECTOR

DATA_VECTOR_NAME

public static final String DATA_VECTOR_NAME

See Also:

Constant Field Values

OFFSET_WIDTH

public static final byte OFFSET_WIDTH

See Also:

Constant Field Values

offsetBuffer

protected ArrowBuf offsetBuffer

vector

protected FieldVector vector

callBack

protected final CallBack callBack

valueCount

protected int valueCount

offsetAllocationSizeInBytes

protected int offsetAllocationSizeInBytes

Constructor Detail

BaseRepeatedValueVector

protected BaseRepeatedValueVector(String name,
                       BufferAllocator allocator,
                       CallBack callBack)

BaseRepeatedValueVector

protected BaseRepeatedValueVector(String name,
                       BufferAllocator allocator,
                       FieldVector vector,
                       CallBack callBack)

Method Detail

allocateNewSafe

public boolean allocateNewSafe()

Description copied from interface: ValueVector

Allocates new buffers. ValueVector implements logic to determine how much to allocate.

Specified by:

allocateNewSafe in interface ValueVector

Returns:

Returns true if allocation was successful.

allocateOffsetBuffer

protected void allocateOffsetBuffer(long size)

reAlloc

public void reAlloc()

Description copied from interface: ValueVector

Allocate new buffer with double capacity, and copy data into the new buffer. Replace vector's buffer with new buffer, and release old one

Specified by:

reAlloc in interface ValueVector

reallocOffsetBuffer

protected void reallocOffsetBuffer()

getOffsetVector

@Deprecated
public UInt4Vector getOffsetVector()

Deprecated.

Specified by:

getOffsetVector in interface RepeatedValueVector

Returns:

the underlying offset vector or null if none exists.

getDataVector

public FieldVector getDataVector()

Specified by:

getDataVector in interface RepeatedValueVector

Returns:

the underlying data vector or null if none exists.

setInitialCapacity

public void setInitialCapacity(int numRecords)

Description copied from interface: ValueVector

Set the initial record capacity

Specified by:

setInitialCapacity in interface ValueVector

Parameters:

numRecords - the initial record capacity.

getValueCapacity

public int getValueCapacity()

Description copied from interface: ValueVector

Returns the maximum number of values that can be stored in this vector instance.

Specified by:

getValueCapacity in interface ValueVector

Returns:

the maximum number of values that can be stored in this vector instance.

getOffsetBufferValueCapacity

protected int getOffsetBufferValueCapacity()

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ValueVector

Returns:

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

getBufferSizeFor

public int getBufferSizeFor(int valueCount)

Description copied from interface: ValueVector

Returns the number of bytes that is used by this vector if it holds the given number of values. The result will be the same as if setValueCount() were called, followed by calling getBufferSize(), but without any of the closing side-effects that setValueCount() implies wrt finishing off the population of a vector. Some operations might wish to use this to determine how much memory has been used by a vector so far, even though it is not finished being populated.

Specified by:

getBufferSizeFor in interface ValueVector

Parameters:

valueCount - the number of values to assume this vector contains

Returns:

the buffer size if this vector is holding valueCount values

iterator

public Iterator<ValueVector> iterator()

Specified by:

iterator in interface Iterable<ValueVector>

Overrides:

iterator in class BaseValueVector

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

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.

size

public int size()

Returns:

1 if inner vector is explicitly set via #addOrGetVector else 0

addOrGetVector

public <T extends ValueVector> AddOrGetResult<T> addOrGetVector(FieldType fieldType)

replaceDataVector

protected void replaceDataVector(FieldVector v)

getValueCount

public int getValueCount()

Description copied from interface: ValueVector

Gets the number of values

Specified by:

getValueCount in interface ValueVector

Returns:

getInnerValueCount

public int getInnerValueCount()

getInnerValueCountAt

public int getInnerValueCountAt(int index)

isNull

public boolean isNull(int index)

Description copied from interface: ValueVector

Check whether an element in the vector is null

Specified by:

isNull in interface ValueVector

Returns:

isEmpty

public boolean isEmpty(int index)

startNewValue

public int startNewValue(int index)

setValueCount

public void setValueCount(int valueCount)

Description copied from interface: ValueVector

Set number of values in the vector

Specified by:

setValueCount in interface ValueVector