org.apache.arrow.vector.complex

Class FixedSizeListVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.complex.FixedSizeListVector

All Implemented Interfaces:

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

public class FixedSizeListVector
extends BaseValueVector
implements FieldVector, PromotableVector

Field Summary

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

allocator, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY, name

Constructor Summary

Constructors

Constructor and Description
FixedSizeListVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack schemaChangeCallback)
FixedSizeListVector(String name, BufferAllocator allocator, int listSize, DictionaryEncoding dictionary, CallBack schemaChangeCallback) Deprecated.

Method Summary

Modifier and Type	Method and Description
<T extends ValueVector> AddOrGetResult<T>	addOrGetVector(FieldType type)
void	allocateNew() Allocate new buffers.
boolean	allocateNewSafe() Allocates new buffers.
void	clear() Release any owned ArrowBuf and reset the ValueVector to the initial state.
void	copyFrom(int fromIndex, int thisIndex, FixedSizeListVector from)
void	copyFromSafe(int inIndex, int outIndex, FixedSizeListVector from)
static FixedSizeListVector	empty(String name, int size, BufferAllocator allocator)
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.
List<FieldVector>	getChildrenFromFields() the returned list is the same size as the list passed to initializeChildrenFromFields
ArrowBuf	getDataBuffer() Gets the underlying buffer associated with data vector
long	getDataBufferAddress() Gets the starting address of the underlying buffer associated with data vector
FieldVector	getDataVector()
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() Deprecated.
int	getListSize()
Types.MinorType	getMinorType()
int	getNullCount() Returns number of null elements in the vector
Object	getObject(int index) Get friendly type object from the vector
ArrowBuf	getOffsetBuffer() Gets the underlying buffer associated with offset vector
long	getOffsetBufferAddress() Gets the starting address of the underlying buffer associated with offset vector
UnionFixedSizeListReader	getReader()
TransferPair	getTransferPair(String ref, BufferAllocator allocator)
TransferPair	getTransferPair(String ref, BufferAllocator allocator, CallBack callBack)
ArrowBuf	getValidityBuffer() Gets the underlying buffer associated with validity vector
long	getValidityBufferAddress() Gets the starting address of the underlying buffer associated with validity vector
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
int	getValueCount() Gets the number of values
void	initializeChildrenFromFields(List<Field> children) Initializes the child vectors to be later loaded with loadBuffers
boolean	isNull(int index) Check whether an element in the vector is null
int	isSet(int index)
Iterator<ValueVector>	iterator()
void	loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers) loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
TransferPair	makeTransferPair(ValueVector target) makes a new transfer pair used to transfer underlying buffers
UnionVector	promoteToUnion()
void	reAlloc() Allocate new buffer with double capacity, and copy data into the new buffer.
void	reset() Reset the ValueVector to the initial state without releasing any owned ArrowBuf.
void	setInitialCapacity(int numRecords) Set the initial record capacity
void	setNotNull(int index)
void	setNull(int index)
void	setValueCount(int valueCount) Set number of values in the vector
int	size()

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

close, getAllocator, getTransferPair

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

FixedSizeListVector

@Deprecated
public FixedSizeListVector(String name,
                                       BufferAllocator allocator,
                                       int listSize,
                                       DictionaryEncoding dictionary,
                                       CallBack schemaChangeCallback)

Deprecated.

FixedSizeListVector

public FixedSizeListVector(String name,
                           BufferAllocator allocator,
                           FieldType fieldType,
                           CallBack schemaChangeCallback)

Method Detail

empty

public static FixedSizeListVector empty(String name,
                                        int size,
                                        BufferAllocator allocator)

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Specified by:

getField in interface ValueVector

Returns:

the field corresponding to this vector

getMinorType

public Types.MinorType getMinorType()

Specified by:

getMinorType in interface ValueVector

getListSize

public int getListSize()

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

@Deprecated
public List<BufferBacked> getFieldInnerVectors()

Deprecated.

Specified by:

getFieldInnerVectors in interface FieldVector

Returns:

the inner vectors for this field as defined by the TypeLayout

getReader

public UnionFixedSizeListReader getReader()

Specified by:

getReader in interface ValueVector

Returns:

a field reader that supports reading values from this vector.

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.

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.

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

getDataVector

public FieldVector getDataVector()

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.

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

Overrides:

clear in class BaseValueVector

reset

public void reset()

Description copied from interface: ValueVector

Reset the ValueVector to the initial state without releasing any owned ArrowBuf. Buffer capacities will remain unchanged and any previous data will be zeroed out. This includes buffers for data, validity, offset, etc. If the vector has any child vectors, they will also be reset.

Specified by:

reset in interface ValueVector

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 type)

Specified by:

addOrGetVector in interface PromotableVector

copyFromSafe

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

copyFrom

public void copyFrom(int fromIndex,
                     int thisIndex,
                     FixedSizeListVector from)

promoteToUnion

public UnionVector promoteToUnion()

Specified by:

promoteToUnion in interface PromotableVector

getValidityBufferAddress

public long getValidityBufferAddress()

Description copied from interface: FieldVector

Gets the starting address of the underlying buffer associated with validity vector

Specified by:

getValidityBufferAddress in interface FieldVector

Returns:

buffer address

getDataBufferAddress

public long getDataBufferAddress()

Description copied from interface: FieldVector

Gets the starting address of the underlying buffer associated with data vector

Specified by:

getDataBufferAddress in interface FieldVector

Returns:

buffer address

getOffsetBufferAddress

public long getOffsetBufferAddress()

Description copied from interface: FieldVector

Gets the starting address of the underlying buffer associated with offset vector

Specified by:

getOffsetBufferAddress in interface FieldVector

Returns:

buffer address

getValidityBuffer

public ArrowBuf getValidityBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with validity vector

Specified by:

getValidityBuffer in interface ValueVector

Returns:

buffer

getDataBuffer

public ArrowBuf getDataBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with data vector

Specified by:

getDataBuffer in interface ValueVector

Returns:

buffer

getOffsetBuffer

public ArrowBuf getOffsetBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with offset vector

Specified by:

getOffsetBuffer in interface ValueVector

Returns:

buffer

getObject

public Object getObject(int index)

Description copied from interface: ValueVector

Get friendly type object from the vector

Specified by:

getObject in interface ValueVector

Returns:

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:

isSet

public int isSet(int index)

getNullCount

public int getNullCount()

Description copied from interface: ValueVector

Returns number of null elements in the vector

Specified by:

getNullCount in interface ValueVector

Returns:

getValueCount

public int getValueCount()

Description copied from interface: ValueVector

Gets the number of values

Specified by:

getValueCount in interface ValueVector

Returns:

setNull

public void setNull(int index)

setNotNull

public void setNotNull(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

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)

Specified by:

getTransferPair in interface ValueVector

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator,
                                    CallBack callBack)

Specified by:

getTransferPair in interface ValueVector

makeTransferPair

public TransferPair makeTransferPair(ValueVector target)

Description copied from interface: ValueVector

makes a new transfer pair used to transfer underlying buffers

Specified by:

makeTransferPair in interface ValueVector

Parameters:

target - the target for the transfer

Returns:

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