FixedSizeListVector (Apache Arrow Java Root POM 14.0.1 API)

java.lang.Object
- org.apache.arrow.vector.BaseValueVector
- - org.apache.arrow.vector.complex.FixedSizeListVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, BaseListVector, PromotableVector, FieldVector, ValueVector
```
public class FixedSizeListVector
extends BaseValueVector
implements BaseListVector, PromotableVector
```
A ListVector where every list value is of the same size.

Field Summary
- Fields inherited from class org.apache.arrow.vector.BaseValueVector
  allocator, fieldReader, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY

Constructor Summary

Constructors
Constructor and Description
`FixedSizeListVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack unusedSchemaChangeCallback)` Creates a new instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<OUT,IN> OUT`	`accept(VectorVisitor<OUT,IN> visitor, IN value)` Accept a generic `VectorVisitor` and return the result.
`<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, ValueVector from)` Copy a cell value from a particular index in source vector to a particular position in this vector.
`void`	`copyFromSafe(int inIndex, int outIndex, ValueVector from)` Same as `ValueVector.copyFrom(int, int, ValueVector)` except that it handles the case when the capacity of the vector needs to be expanded before copy.
`static FixedSizeListVector`	`empty(String name, int size, BufferAllocator allocator)`
`ArrowBuf[]`	`getBuffers(boolean clear)` Return the underlying buffers associated with this vector.
`int`	`getBufferSize()` Get the number of bytes used by this vector.
`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()`
`int`	`getElementEndIndex(int index)` Get data vector end index with the given list index.
`int`	`getElementStartIndex(int index)` Get data vector start index with the given list index.
`Field`	`getField()` Get information about how this field is materialized.
`List<ArrowBuf>`	`getFieldBuffers()` Get the buffers of the fields, (same size as getFieldVectors() since it is their content).
`List<BufferBacked>`	`getFieldInnerVectors()` Deprecated. This API will be removed as the current implementations no longer support inner vectors.
`int`	`getListSize()` Get the fixed size for each list.
`Types.MinorType`	`getMinorType()`
`String`	`getName()` Gets the name of the vector.
`int`	`getNullCount()` Returns number of null elements in the vector.
`List<?>`	`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()` Default implementation to create a reader for the vector.
`protected FieldReader`	`getReaderImpl()` Each vector has a different reader that implements the FieldReader interface.
`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.
`UnionFixedSizeListWriter`	`getWriter()`
`int`	`hashCode(int index)` Returns hashCode of element in index with the default hasher.
`int`	`hashCode(int index, ArrowBufHasher hasher)` Returns hashCode of element in index with the given hasher.
`void`	`initializeChildrenFromFields(List<Field> children)` Initializes the child vectors to be later loaded with loadBuffers.
`boolean`	`isNull(int index)` Returns whether the value at index null.
`int`	`isSet(int index)` Returns non-zero when the value at index is non-null.
`Iterator<ValueVector>`	`iterator()`
`void`	`loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers)` Loads data in the vectors.
`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)` Sets the value at index to not-null.
`void`	`setNull(int index)` Sets the value at index to null.
`void`	`setValueCount(int valueCount)` Set number of values in the vector.
`int`	`size()` Get value indicating if inner vector is set.
`int`	`startNewValue(int index)` Start a new value in the list vector.

Methods inherited from class org.apache.arrow.vector.BaseValueVector
checkBufRefs, close, getAllocator, getTransferPair, getValidityBufferSizeFromCount, releaseBuffer, toString, transferBuffer

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, validate, validateFull

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - FixedSizeListVector
```
public FixedSizeListVector(String name,
                           BufferAllocator allocator,
                           FieldType fieldType,
                           CallBack unusedSchemaChangeCallback)
```
    Creates a new instance.
    
    Parameters:
    
    name - The name for the vector.
    
    allocator - The allocator to use for creating/reallocating buffers for the vector.
    
    fieldType - The underlying data type of the vector.
    
    unusedSchemaChangeCallback - Currently unused.
- 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
  - getName
```
public String getName()
```
    Description copied from interface: ValueVector
    
    Gets the name of the vector.
    
    Specified by:
    
    getName in interface ValueVector
    
    Specified by:
    
    getName in class BaseValueVector
    
    Returns:
    
    the name of the vector.
  - getListSize
```
public int getListSize()
```
    Get the fixed size for each list.
  - 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
    
    Get the buffers of the fields, (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. This API will be removed as the current implementations no longer support inner vectors.
    
    Get the inner vectors.
    
    Specified by:
    
    getFieldInnerVectors in interface FieldVector
    
    Returns:
    
    the inner vectors for this field as defined by the TypeLayout
  - getReaderImpl
```
protected FieldReader getReaderImpl()
```
    Description copied from class: BaseValueVector
    
    Each vector has a different reader that implements the FieldReader interface. Overridden methods must make sure to return the correct concrete reader implementation.
    
    Specified by:
    
    getReaderImpl in class BaseValueVector
    
    Returns:
    
    Returns a lambda that initializes a reader when called.
  - getReader
```
public UnionFixedSizeListReader getReader()
```
    Description copied from class: BaseValueVector
    
    Default implementation to create a reader for the vector. Depends on the individual vector class' implementation of BaseValueVector.getReaderImpl() to initialize the reader appropriately.
    
    Specified by:
    
    getReader in interface ValueVector
    
    Overrides:
    
    getReader in class BaseValueVector
    
    Returns:
    
    Concrete instance of FieldReader by using double-checked locking.
  - 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()
```
  - startNewValue
```
public int startNewValue(int index)
```
    Start a new value in the list vector.
    
    Parameters:
    
    index - index of the value to start
  - getWriter
```
public UnionFixedSizeListWriter getWriter()
```
  - 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()
```
    Description copied from interface: ValueVector
    
    Get the number of bytes used by this vector.
    
    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()
```
    Get value indicating if inner vector is set.
    
    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,
                         ValueVector from)
```
    Description copied from interface: ValueVector
    
    Same as ValueVector.copyFrom(int, int, ValueVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.
    
    Specified by:
    
    copyFromSafe in interface ValueVector
    
    Overrides:
    
    copyFromSafe in class BaseValueVector
    
    Parameters:
    
    inIndex - position to copy from in source vector
    
    outIndex - position to copy to in this vector
    
    from - source vector
  - copyFrom
```
public void copyFrom(int fromIndex,
                     int thisIndex,
                     ValueVector from)
```
    Description copied from interface: ValueVector
    
    Copy a cell value from a particular index in source vector to a particular position in this vector.
    
    Specified by:
    
    copyFrom in interface ValueVector
    
    Overrides:
    
    copyFrom in class BaseValueVector
    
    Parameters:
    
    fromIndex - position to copy from in source vector
    
    thisIndex - position to copy to in this vector
    
    from - source vector
  - 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 List<?> getObject(int index)
```
    Description copied from interface: ValueVector
    
    Get friendly type object from the vector.
    
    Specified by:
    
    getObject in interface ValueVector
    
    Parameters:
    
    index - index of object to get
    
    Returns:
    
    friendly type object
  - isNull
```
public boolean isNull(int index)
```
    Returns whether the value at index null.
    
    Specified by:
    
    isNull in interface ValueVector
    
    Parameters:
    
    index - index to check for null
    
    Returns:
    
    true if element is null
  - isSet
```
public int isSet(int index)
```
    Returns non-zero when the value at index is non-null.
  - getNullCount
```
public int getNullCount()
```
    Description copied from interface: ValueVector
    
    Returns number of null elements in the vector.
    
    Specified by:
    
    getNullCount in interface ValueVector
    
    Returns:
    
    number of null elements
  - getValueCount
```
public int getValueCount()
```
    Description copied from interface: ValueVector
    
    Gets the number of values.
    
    Specified by:
    
    getValueCount in interface ValueVector
    
    Returns:
    
    number of values in the vector
  - setNull
```
public void setNull(int index)
```
    Sets the value at index to null. Reallocates if index is larger than capacity.
    
    Specified by:
    
    setNull in interface FieldVector
    
    Parameters:
    
    index - the value to change
  - setNotNull
```
public void setNotNull(int index)
```
    Sets the value at index to not-null. Reallocates if index is larger than capacity.
  - 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.
  - hashCode
```
public int hashCode(int index)
```
    Description copied from interface: ValueVector
    
    Returns hashCode of element in index with the default hasher.
    
    Specified by:
    
    hashCode in interface ValueVector
  - hashCode
```
public int hashCode(int index,
                    ArrowBufHasher hasher)
```
    Description copied from interface: ValueVector
    
    Returns hashCode of element in index with the given hasher.
    
    Specified by:
    
    hashCode in interface ValueVector
  - accept
```
public <OUT,IN> OUT accept(VectorVisitor<OUT,IN> visitor,
                           IN value)
```
    Description copied from interface: ValueVector
    
    Accept a generic VectorVisitor and return the result.
    
    Specified by:
    
    accept in interface ValueVector
    
    Type Parameters:
    
    OUT - the output result type.
    
    IN - the input data together with visitor.
  - getElementStartIndex
```
public int getElementStartIndex(int index)
```
    Description copied from interface: BaseListVector
    
    Get data vector start index with the given list index.
    
    Specified by:
    
    getElementStartIndex in interface BaseListVector
  - getElementEndIndex
```
public int getElementEndIndex(int index)
```
    Description copied from interface: BaseListVector
    
    Get data vector end index with the given list index.
    
    Specified by:
    
    getElementEndIndex in interface BaseListVector

Class FixedSizeListVector

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

Constructor Detail

FixedSizeListVector

Method Detail

empty

getField

getMinorType

getName

getListSize

initializeChildrenFromFields

getChildrenFromFields

loadFieldBuffers

getFieldBuffers

getFieldInnerVectors

getReaderImpl

getReader

allocateNew

allocateNewSafe

reAlloc

getDataVector

startNewValue

getWriter

setInitialCapacity

getValueCapacity

getBufferSize

getBufferSizeFor

iterator

clear

reset

getBuffers

size

addOrGetVector

copyFromSafe

copyFrom

promoteToUnion

getValidityBufferAddress

getDataBufferAddress

getOffsetBufferAddress

getValidityBuffer

getDataBuffer

getOffsetBuffer

getObject

isNull

isSet

getNullCount

getValueCount

setNull

setNotNull

setValueCount

getTransferPair

getTransferPair

makeTransferPair

hashCode

hashCode

accept

getElementStartIndex

getElementEndIndex