BaseFixedWidthVector (Arrow Vectors 0.11.0 API)

java.lang.Object
- org.apache.arrow.vector.BaseValueVector
- - org.apache.arrow.vector.BaseFixedWidthVector

すべての実装されたインタフェース:

Closeable, AutoCloseable, Iterable<ValueVector>, FieldVector, FixedWidthVector, ValueVector, VectorDefinitionSetter

直系の既知のサブクラス:

BigIntVector, BitVector, DateDayVector, DateMilliVector, DecimalVector, FixedSizeBinaryVector, Float4Vector, Float8Vector, IntervalDayVector, IntervalYearVector, IntVector, SmallIntVector, TimeMicroVector, TimeMilliVector, TimeNanoVector, TimeSecVector, TimeStampVector, TinyIntVector, UInt1Vector, UInt2Vector, UInt4Vector, UInt8Vector
```
public abstract class BaseFixedWidthVector
extends BaseValueVector
implements FixedWidthVector, FieldVector, VectorDefinitionSetter
```
BaseFixedWidthVector provides an abstract interface for implementing vectors of fixed width values. The vectors are nullable implying that zero or more elements in the vector could be NULL.

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected Field`	`field`
`protected int`	`validityAllocationSizeInBytes`
`protected ArrowBuf`	`validityBuffer`
`protected int`	`valueAllocationSizeInBytes`
`protected ArrowBuf`	`valueBuffer`
`protected int`	`valueCount`

クラスから継承されたフィールド org.apache.arrow.vector.BaseValueVector
allocator, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY, name

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`BaseFixedWidthVector(String name, BufferAllocator allocator, FieldType fieldType, int typeWidth)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`void`	`allocateNew()` Same as `allocateNewSafe()`.
`void`	`allocateNew(int valueCount)` Allocate memory for the vector to support storing at least the provided number of elements in the vector.
`boolean`	`allocateNewSafe()` Allocate memory for the vector.
`void`	`clear()` Same as `close()`
`void`	`close()` Close the vector and release the associated buffers.
`protected void`	`decrementAllocationMonitor()`
`ArrowBuf[]`	`getBuffers(boolean clear)` Return the underlying buffers associated with this vector.
`int`	`getBufferSize()` Get the size (number of bytes) of underlying buffers used by this vector
`int`	`getBufferSizeFor(int count)` Get the potential buffer size for a particular number of records.
`List<FieldVector>`	`getChildrenFromFields()` Get the inner child vectors.
`ArrowBuf`	`getDataBuffer()` Get the buffer that stores the data for elements in the vector.
`long`	`getDataBufferAddress()` Get the memory address of buffer that stores the data for elements in the vector.
`Field`	`getField()` Get information about how this field is materialized.
`List<ArrowBuf>`	`getFieldBuffers()` Get the buffers belonging to this vector
`List<BufferBacked>`	`getFieldInnerVectors()` 非推奨です。
`int`	`getNullCount()` Get the number of elements that are null in the vector
`ArrowBuf`	`getOffsetBuffer()` buffer that stores the offsets for elements in the vector.
`long`	`getOffsetBufferAddress()` Get the memory address of buffer that stores the offsets for elements in the vector.
`TransferPair`	`getTransferPair(BufferAllocator allocator)` Construct a transfer pair of this vector and another vector of same type.
`abstract TransferPair`	`getTransferPair(String ref, BufferAllocator allocator)` Construct a transfer pair of this vector and another vector of same type.
`TransferPair`	`getTransferPair(String ref, BufferAllocator allocator, CallBack callBack)` Construct a transfer pair of this vector and another vector of same type.
`ArrowBuf`	`getValidityBuffer()` Get buffer that manages the validity (NULL or NON-NULL nature) of elements in the vector.
`long`	`getValidityBufferAddress()` Get the memory address of buffer that manages the validity (NULL or NON-NULL nature) of elements in the vector.
`int`	`getValueCapacity()` Get the current value capacity for the vector
`int`	`getValueCount()` Get the value count of vector.
`protected void`	`handleSafe(int index)` * helper methods for setters * *
`protected void`	`incrementAllocationMonitor()`
`void`	`initializeChildrenFromFields(List<Field> children)` Initialize the children in schema for this Field.
`boolean`	`isNull(int index)` Check if element at given index is null.
`boolean`	`isSafe(int index)` Check if the given index is within the current value capacity of the vector
`int`	`isSet(int index)` Same as `isNull(int)`.
`void`	`loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers)` Load the buffers of this vector with provided source buffers.
`void`	`reAlloc()` Resize the vector to increase the capacity.
`void`	`reset()` Reset the vector to initial state.
`void`	`set(int index, byte[] value, int start, int length)`
`void`	`set(int index, ByteBuffer value, int start, int length)`
`void`	`setIndexDefined(int index)` Mark the particular position in the vector as non-null.
`void`	`setInitialCapacity(int valueCount)` Sets the desired value capacity for the vector.
`void`	`setSafe(int index, byte[] value, int start, int length)`
`void`	`setSafe(int index, ByteBuffer value, int start, int length)`
`void`	`setValueCount(int valueCount)` Set value count for the vector.
`void`	`splitAndTransferTo(int startIndex, int length, BaseFixedWidthVector target)` Slice this vector at desired index and length and transfer the corresponding data to the target vector.
`void`	`transferTo(BaseFixedWidthVector target)` Transfer this vector'data to another vector.
`void`	`zeroVector()` zero out the vector and the data in associated buffers.

クラスから継承されたメソッド org.apache.arrow.vector.BaseValueVector
checkBufRefs, compareTypes, getAllocator, getValidityBufferSizeFromCount, iterator, releaseBuffer, toString

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェースから継承されたメソッド org.apache.arrow.vector.ValueVector
getAllocator, getMinorType, getObject, getReader, makeTransferPair

インタフェースから継承されたメソッド java.lang.Iterable
forEach, iterator, spliterator

- フィールドの詳細
  - valueAllocationSizeInBytes
```
protected int valueAllocationSizeInBytes
```
  - validityAllocationSizeInBytes
```
protected int validityAllocationSizeInBytes
```
  - field
```
protected final Field field
```
  - validityBuffer
```
protected ArrowBuf validityBuffer
```
  - valueBuffer
```
protected ArrowBuf valueBuffer
```
  - valueCount
```
protected int valueCount
```
- コンストラクタの詳細
  - BaseFixedWidthVector
```
public BaseFixedWidthVector(String name,
                            BufferAllocator allocator,
                            FieldType fieldType,
                            int typeWidth)
```
- メソッドの詳細
  - getValidityBufferAddress
```
public long getValidityBufferAddress()
```
    Get the memory address of buffer that manages the validity (NULL or NON-NULL nature) of elements in the vector.
    
    定義:
    
    getValidityBufferAddress インタフェース内 FieldVector
    
    戻り値:
    
    starting address of the buffer
  - getDataBufferAddress
```
public long getDataBufferAddress()
```
    Get the memory address of buffer that stores the data for elements in the vector.
    
    定義:
    
    getDataBufferAddress インタフェース内 FieldVector
    
    戻り値:
    
    starting address of the buffer
  - getOffsetBufferAddress
```
public long getOffsetBufferAddress()
```
    Get the memory address of buffer that stores the offsets for elements in the vector. This operation is not supported for fixed-width vectors.
    
    定義:
    
    getOffsetBufferAddress インタフェース内 FieldVector
    
    戻り値:
    
    starting address of the buffer
    
    例外:
    
    UnsupportedOperationException - for fixed width vectors
  - getValidityBuffer
```
public ArrowBuf getValidityBuffer()
```
    Get buffer that manages the validity (NULL or NON-NULL nature) of elements in the vector. Consider it as a buffer for internal bit vector data structure.
    
    定義:
    
    getValidityBuffer インタフェース内 ValueVector
    
    戻り値:
    
    buffer
  - getDataBuffer
```
public ArrowBuf getDataBuffer()
```
    Get the buffer that stores the data for elements in the vector.
    
    定義:
    
    getDataBuffer インタフェース内 ValueVector
    
    戻り値:
    
    buffer
  - getOffsetBuffer
```
public ArrowBuf getOffsetBuffer()
```
    buffer that stores the offsets for elements in the vector. This operation is not supported for fixed-width vectors.
    
    定義:
    
    getOffsetBuffer インタフェース内 ValueVector
    
    戻り値:
    
    buffer
    
    例外:
    
    UnsupportedOperationException - for fixed width vectors
  - setInitialCapacity
```
public void setInitialCapacity(int valueCount)
```
    Sets the desired value capacity for the vector. This function doesn't allocate any memory for the vector.
    
    定義:
    
    setInitialCapacity インタフェース内 ValueVector
    
    パラメータ:
    
    valueCount - desired number of elements in the vector
  - getValueCapacity
```
public int getValueCapacity()
```
    Get the current value capacity for the vector
    
    定義:
    
    getValueCapacity インタフェース内 ValueVector
    
    戻り値:
    
    number of elements that vector can hold.
  - zeroVector
```
public void zeroVector()
```
    zero out the vector and the data in associated buffers.
    
    定義:
    
    zeroVector インタフェース内 FixedWidthVector
  - reset
```
public void reset()
```
    Reset the vector to initial state. Same as zeroVector(). Note that this method doesn't release any memory.
    
    定義:
    
    reset インタフェース内 ValueVector
  - close
```
public void close()
```
    Close the vector and release the associated buffers.
    
    定義:
    
    close インタフェース内 Closeable
    
    定義:
    
    close インタフェース内 AutoCloseable
    
    定義:
    
    close インタフェース内 ValueVector
    
    オーバーライド:
    
    close クラス内 BaseValueVector
  - clear
```
public void clear()
```
    Same as close()
    
    定義:
    
    clear インタフェース内 ValueVector
    
    オーバーライド:
    
    clear クラス内 BaseValueVector
  - incrementAllocationMonitor
```
protected void incrementAllocationMonitor()
```
  - decrementAllocationMonitor
```
protected void decrementAllocationMonitor()
```
  - allocateNew
```
public void allocateNew()
```
    Same as allocateNewSafe().
    
    定義:
    
    allocateNew インタフェース内 ValueVector
  - allocateNewSafe
```
public boolean allocateNewSafe()
```
    Allocate memory for the vector. We internally use a default value count of 4096 to allocate memory for at least these many elements in the vector. See allocateNew(int) for allocating memory for specific number of elements in the vector.
    
    定義:
    
    allocateNewSafe インタフェース内 ValueVector
    
    戻り値:
    
    false if memory allocation fails, true otherwise.
  - allocateNew
```
public void allocateNew(int valueCount)
```
    Allocate memory for the vector to support storing at least the provided number of elements in the vector. This method must be called prior to using the ValueVector.
    
    定義:
    
    allocateNew インタフェース内 FixedWidthVector
    
    パラメータ:
    
    valueCount - the desired number of elements in the vector
    
    例外:
    
    OutOfMemoryException
  - getBufferSizeFor
```
public int getBufferSizeFor(int count)
```
    Get the potential buffer size for a particular number of records.
    
    定義:
    
    getBufferSizeFor インタフェース内 ValueVector
    
    パラメータ:
    
    count - desired number of elements in the vector
    
    戻り値:
    
    estimated size of underlying buffers if the vector holds a given number of elements
  - getBufferSize
```
public int getBufferSize()
```
    Get the size (number of bytes) of underlying buffers used by this vector
    
    定義:
    
    getBufferSize インタフェース内 ValueVector
    
    戻り値:
    
    size of underlying buffers.
  - getField
```
public Field getField()
```
    Get information about how this field is materialized.
    
    定義:
    
    getField インタフェース内 ValueVector
    
    戻り値:
    
    the field corresponding to this vector
  - getBuffers
```
public ArrowBuf[] getBuffers(boolean clear)
```
    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).
    
    定義:
    
    getBuffers インタフェース内 ValueVector
    
    パラメータ:
    
    clear - Whether to clear vector before returning; the buffers will still be refcounted but the returned array will be the only reference to them
    
    戻り値:
    
    The underlying buffers that is used by this vector instance.
  - reAlloc
```
public void reAlloc()
```
    Resize the vector to increase the capacity. The internal behavior is to double the current value capacity.
    
    定義:
    
    reAlloc インタフェース内 ValueVector
  - getFieldInnerVectors
```
@Deprecated
public List<BufferBacked> getFieldInnerVectors()
```
    非推奨です。
    
    定義:
    
    getFieldInnerVectors インタフェース内 FieldVector
    
    戻り値:
    
    the inner vectors for this field as defined by the TypeLayout
  - initializeChildrenFromFields
```
public void initializeChildrenFromFields(List<Field> children)
```
    Initialize the children in schema for this Field. This operation is a NO-OP for scalar types since they don't have any children.
    
    定義:
    
    initializeChildrenFromFields インタフェース内 FieldVector
    
    パラメータ:
    
    children - the schema
    
    例外:
    
    IllegalArgumentException - if children is a non-empty list for scalar types.
  - getChildrenFromFields
```
public List<FieldVector> getChildrenFromFields()
```
    Get the inner child vectors.
    
    定義:
    
    getChildrenFromFields インタフェース内 FieldVector
    
    戻り値:
    
    list of child vectors for complex types, empty list for scalar vector types
  - loadFieldBuffers
```
public void loadFieldBuffers(ArrowFieldNode fieldNode,
                             List<ArrowBuf> ownBuffers)
```
    Load the buffers of this vector with provided source buffers. The caller manages the source buffers and populates them before invoking this method.
    
    定義:
    
    loadFieldBuffers インタフェース内 FieldVector
    
    パラメータ:
    
    fieldNode - the fieldNode indicating the value count
    
    ownBuffers - the buffers for this Field (own buffers only, children not included)
  - getFieldBuffers
```
public List<ArrowBuf> getFieldBuffers()
```
    Get the buffers belonging to this vector
    
    定義:
    
    getFieldBuffers インタフェース内 FieldVector
    
    戻り値:
    
    the inner buffers.
  - getTransferPair
```
public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator,
                                    CallBack callBack)
```
    Construct a transfer pair of this vector and another vector of same type.
    
    定義:
    
    getTransferPair インタフェース内 ValueVector
    
    パラメータ:
    
    ref - name of the target vector
    
    allocator - allocator for the target vector
    
    callBack -
    
    戻り値:
    
    TransferPair
  - getTransferPair
```
public TransferPair getTransferPair(BufferAllocator allocator)
```
    Construct a transfer pair of this vector and another vector of same type.
    
    定義:
    
    getTransferPair インタフェース内 ValueVector
    
    オーバーライド:
    
    getTransferPair クラス内 BaseValueVector
    
    パラメータ:
    
    allocator - allocator for the target vector
    
    戻り値:
    
    TransferPair
  - getTransferPair
```
public abstract TransferPair getTransferPair(String ref,
                                             BufferAllocator allocator)
```
    Construct a transfer pair of this vector and another vector of same type.
    
    定義:
    
    getTransferPair インタフェース内 ValueVector
    
    パラメータ:
    
    ref - name of the target vector
    
    allocator - allocator for the target vector
    
    戻り値:
    
    TransferPair
  - transferTo
```
public void transferTo(BaseFixedWidthVector target)
```
    Transfer this vector'data to another vector. The memory associated with this vector is transferred to the allocator of target vector for accounting and management purposes.
    
    パラメータ:
    
    target - destination vector for transfer
  - splitAndTransferTo
```
public void splitAndTransferTo(int startIndex,
                               int length,
                               BaseFixedWidthVector target)
```
    Slice this vector at desired index and length and transfer the corresponding data to the target vector.
    
    パラメータ:
    
    startIndex - start position of the split in source vector.
    
    length - length of the split.
    
    target - destination vector
  - getNullCount
```
public int getNullCount()
```
    Get the number of elements that are null in the vector
    
    定義:
    
    getNullCount インタフェース内 ValueVector
    
    戻り値:
    
    the number of null elements.
  - getValueCount
```
public int getValueCount()
```
    Get the value count of vector. This will always be zero unless setValueCount(int) has been called prior to calling this.
    
    定義:
    
    getValueCount インタフェース内 ValueVector
    
    戻り値:
    
    valueCount for the vector
  - setValueCount
```
public void setValueCount(int valueCount)
```
    Set value count for the vector.
    
    定義:
    
    setValueCount インタフェース内 ValueVector
    
    パラメータ:
    
    valueCount - value count to set
  - isSafe
```
public boolean isSafe(int index)
```
    Check if the given index is within the current value capacity of the vector
    
    パラメータ:
    
    index - position to check
    
    戻り値:
    
    true if index is within the current value capacity
  - isNull
```
public boolean isNull(int index)
```
    Check if element at given index is null.
    
    定義:
    
    isNull インタフェース内 ValueVector
    
    パラメータ:
    
    index - position of element
    
    戻り値:
    
    true if element at given index is null, false otherwise
  - isSet
```
public int isSet(int index)
```
    Same as isNull(int).
    
    パラメータ:
    
    index - position of element
    
    戻り値:
    
    1 if element at given index is not null, 0 otherwise
  - setIndexDefined
```
public void setIndexDefined(int index)
```
    Mark the particular position in the vector as non-null.
    
    定義:
    
    setIndexDefined インタフェース内 VectorDefinitionSetter
    
    パラメータ:
    
    index - position of the element.
  - set
```
public void set(int index,
                byte[] value,
                int start,
                int length)
```
  - setSafe
```
public void setSafe(int index,
                    byte[] value,
                    int start,
                    int length)
```
  - set
```
public void set(int index,
                ByteBuffer value,
                int start,
                int length)
```
  - setSafe
```
public void setSafe(int index,
                    ByteBuffer value,
                    int start,
                    int length)
```
  - handleSafe
```
protected void handleSafe(int index)
```
    * helper methods for setters * *

クラス BaseFixedWidthVector

フィールドのサマリー

クラスから継承されたフィールド org.apache.arrow.vector.BaseValueVector

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.apache.arrow.vector.BaseValueVector

クラスから継承されたメソッド java.lang.Object

インタフェースから継承されたメソッド org.apache.arrow.vector.ValueVector

インタフェースから継承されたメソッド java.lang.Iterable

フィールドの詳細

valueAllocationSizeInBytes

validityAllocationSizeInBytes

field

validityBuffer

valueBuffer

valueCount

コンストラクタの詳細

BaseFixedWidthVector

メソッドの詳細

getValidityBufferAddress

getDataBufferAddress

getOffsetBufferAddress

getValidityBuffer

getDataBuffer

getOffsetBuffer

setInitialCapacity

getValueCapacity

zeroVector

reset

close

clear

incrementAllocationMonitor

decrementAllocationMonitor

allocateNew

allocateNewSafe

allocateNew

getBufferSizeFor

getBufferSize

getField

getBuffers

reAlloc

getFieldInnerVectors

initializeChildrenFromFields

getChildrenFromFields

loadFieldBuffers

getFieldBuffers

getTransferPair

getTransferPair

getTransferPair

transferTo

splitAndTransferTo

getNullCount

getValueCount

setValueCount

isSafe

isNull

isSet

setIndexDefined

set

setSafe

set

setSafe

handleSafe