org.apache.arrow.vector.complex

Class ListVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.complex.BaseRepeatedValueVector

org.apache.arrow.vector.complex.ListVector

All Implemented Interfaces:

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

public class ListVector
extends BaseRepeatedValueVector
implements FieldVector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ListVector.Accessor
class	ListVector.Mutator

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

BaseRepeatedValueVector.BaseRepeatedAccessor, 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

Field Summary

Fields inherited from class org.apache.arrow.vector.complex.BaseRepeatedValueVector

DATA_VECTOR_NAME, DEFAULT_DATA_VECTOR, OFFSETS_VECTOR_NAME, 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

Constructor and Description
ListVector(String name, BufferAllocator allocator, CallBack callBack)

Method Summary

Methods

Modifier and Type	Method and Description
<T extends ValueVector> AddOrGetResult<T>	addOrGetVector(Types.MinorType minorType)
void	allocateNew() Allocate new buffers.
boolean	allocateNewSafe() Allocates new buffers.
void	clear() Release the underlying ArrowBuf and reset the ValueVector to empty.
void	copyFrom(int inIndex, int outIndex, ListVector from)
void	copyFromSafe(int inIndex, int outIndex, ListVector from)
ListVector.Accessor	getAccessor() Returns an accessor that is used to read from this vector instance.
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.
List<FieldVector>	getChildrenFromFields() the returned list is the same size as the list passed to initializeChildrenFromFields
FieldVector	getDataVector() Returns the underlying data vector or null if none exists.
Field	getField() Get information about how this field is materialized.
List<ArrowBuf>	getFieldBuffers() (same size as getFieldVectors() since it is their content)
List<BufferBacked>	getFieldInnerVectors()
Types.MinorType	getMinorType()
ListVector.Mutator	getMutator() Returns an mutator that is used to write to this vector instance.
FieldReader	getReader() Returns a field reader that supports reading values from this vector.
TransferPair	getTransferPair(String ref, BufferAllocator allocator)
UnionListWriter	getWriter()
void	initializeChildrenFromFields(List<Field> children) Initializes the child vectors to be later loaded with loadBuffers
void	loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers) loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
TransferPair	makeTransferPair(ValueVector target) Returns a new transfer pair that is used to transfer underlying buffers into the target vector.
UnionVector	promoteToUnion()

Methods inherited from class org.apache.arrow.vector.complex.BaseRepeatedValueVector

getBufferSizeFor, getOffsetVector, getValueCapacity, iterator, replaceDataVector, setInitialCapacity, size

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.ValueVector

close, getAllocator, getBufferSizeFor, getTransferPair, getValueCapacity, setInitialCapacity

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

ListVector

public ListVector(String name,
          BufferAllocator allocator,
          CallBack callBack)

Method Detail

initializeChildrenFromFields

public void initializeChildrenFromFields(List<Field> children)

Description copied from interface: FieldVector

Initializes the child vectors to be later loaded with loadBuffers

Specified by:

initializeChildrenFromFields in interface FieldVector

Parameters:

children - the schema

getChildrenFromFields

public List<FieldVector> getChildrenFromFields()

Description copied from interface: FieldVector

the returned list is the same size as the list passed to initializeChildrenFromFields

Specified by:

getChildrenFromFields in interface FieldVector

Returns:

the children according to schema (empty for primitive types)

loadFieldBuffers

public void loadFieldBuffers(ArrowFieldNode fieldNode,
                    List<ArrowBuf> ownBuffers)

Description copied from interface: FieldVector

loads data in the vectors (ownBuffers must be the same size as getFieldVectors())

Specified by:

loadFieldBuffers in interface FieldVector

Parameters:

fieldNode - the fieldNode

ownBuffers - the buffers for this Field (own buffers only, children not included)

getFieldBuffers

public List<ArrowBuf> getFieldBuffers()

Description copied from interface: FieldVector

(same size as getFieldVectors() since it is their content)

Specified by:

getFieldBuffers in interface FieldVector

Returns:

the buffers containing the data for this vector (ready for reading)

getFieldInnerVectors

public List<BufferBacked> getFieldInnerVectors()

Specified by:

getFieldInnerVectors in interface FieldVector

Returns:

the inner vectors for this field as defined by the TypeLayout

getWriter

public UnionListWriter getWriter()

allocateNew

public void allocateNew()
                 throws OutOfMemoryException

Description copied from interface: ValueVector

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

Specified by:

allocateNew in interface ValueVector

Throws:

OutOfMemoryException - Thrown if no memory can be allocated.

copyFromSafe

public void copyFromSafe(int inIndex,
                int outIndex,
                ListVector from)

copyFrom

public void copyFrom(int inIndex,
            int outIndex,
            ListVector from)

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

Overrides:

getDataVector in class BaseRepeatedValueVector

getTransferPair

public TransferPair getTransferPair(String ref,
                           BufferAllocator allocator)

Specified by:

getTransferPair in interface ValueVector

makeTransferPair

public TransferPair makeTransferPair(ValueVector target)

Description copied from interface: ValueVector

Returns a new transfer pair that is used to transfer underlying buffers into the target vector.

Specified by:

makeTransferPair in interface ValueVector

getAccessor

public ListVector.Accessor getAccessor()

Description copied from interface: ValueVector

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

Specified by:

getAccessor in interface RepeatedValueVector

Specified by:

getAccessor in interface ValueVector

getMutator

public ListVector.Mutator getMutator()

Description copied from interface: ValueVector

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

Specified by:

getMutator in interface RepeatedValueVector

Specified by:

getMutator in interface ValueVector

getReader

public FieldReader getReader()

Description copied from interface: ValueVector

Returns a field reader that supports reading values from this vector.

Specified by:

getReader in interface ValueVector

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

Overrides:

allocateNewSafe in class BaseRepeatedValueVector

Returns:

Returns true if allocation was successful.

addOrGetVector

public <T extends ValueVector> AddOrGetResult<T> addOrGetVector(Types.MinorType minorType)

Overrides:

addOrGetVector in class BaseRepeatedValueVector

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

Overrides:

getBufferSize in class BaseRepeatedValueVector

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Specified by:

getField in interface ValueVector

getMinorType

public Types.MinorType getMinorType()

Specified by:

getMinorType in interface ValueVector

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 BaseRepeatedValueVector

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

Overrides:

getBuffers in class BaseRepeatedValueVector

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.

promoteToUnion

public UnionVector promoteToUnion()