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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BaseRepeatedValueVector.BaseRepeatedAccessor
class	BaseRepeatedValueVector.BaseRepeatedMutator

Nested classes/interfaces inherited from class org.apache.arrow.vector.BaseValueVector

BaseValueVector.BaseAccessor, BaseValueVector.BaseMutator

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

RepeatedValueVector.RepeatedAccessor, RepeatedValueVector.RepeatedMutator

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

ValueVector.Accessor, ValueVector.Mutator

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_VECTOR_NAME
static FieldVector	DEFAULT_DATA_VECTOR
protected UInt4Vector	offsets
static String	OFFSETS_VECTOR_NAME
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)
protected	BaseRepeatedValueVector(String name, BufferAllocator allocator, FieldVector vector)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ValueVector> AddOrGetResult<T>	addOrGetVector(Types.MinorType minorType)
boolean	allocateNewSafe() Allocates new buffers.
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() Returns the number of bytes that is used by this vector instance.
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() Returns the underlying data vector or null if none exists.
UInt4Vector	getOffsetVector() Returns the underlying offset vector or null if none exists.
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
Iterator<ValueVector>	iterator()
protected void	replaceDataVector(FieldVector v)
void	setInitialCapacity(int numRecords) Set the initial record capacity
int	size() Returns 1 if inner vector is explicitly set via #addOrGetVector else 0

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

checkBufRefs, close, getAllocator, getTransferPair, 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.complex.RepeatedValueVector

getAccessor, getMutator

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

allocateNew, close, getAllocator, getField, getMinorType, getReader, getTransferPair, getTransferPair, makeTransferPair

Field Detail

DEFAULT_DATA_VECTOR

public static final FieldVector DEFAULT_DATA_VECTOR

OFFSETS_VECTOR_NAME

public static final String OFFSETS_VECTOR_NAME

See Also:

Constant Field Values

DATA_VECTOR_NAME

public static final String DATA_VECTOR_NAME

See Also:

Constant Field Values

offsets

protected final UInt4Vector offsets

vector

protected FieldVector vector

Constructor Detail

BaseRepeatedValueVector

protected BaseRepeatedValueVector(String name,
                       BufferAllocator allocator)

BaseRepeatedValueVector

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

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.

getOffsetVector

public UInt4Vector getOffsetVector()

Description copied from interface: RepeatedValueVector

Returns the underlying offset vector or null if none exists. TODO(DRILL-2995): eliminate exposing low-level interfaces.

Specified by:

getOffsetVector in interface RepeatedValueVector

getDataVector

public FieldVector getDataVector()

Description copied from interface: RepeatedValueVector

Returns the underlying data vector or null if none exists.

Specified by:

getDataVector in interface RepeatedValueVector

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

getBufferSize

public int getBufferSize()

Description copied from interface: ValueVector

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

Specified by:

getBufferSize in interface ValueVector

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 Mutator.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(Types.MinorType minorType)

replaceDataVector

protected void replaceDataVector(FieldVector v)