BaseRepeatedValueVector (Arrow Vectors 0.11.0 API)

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

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

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

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

ListVector
```
public abstract class BaseRepeatedValueVector
extends BaseValueVector
implements RepeatedValueVector
```

フィールドのサマリー

フィールド
修飾子とタイプ	フィールドと説明
`protected CallBack`	`callBack`
`static String`	`DATA_VECTOR_NAME`
`static FieldVector`	`DEFAULT_DATA_VECTOR`
`static byte`	`OFFSET_WIDTH`
`protected int`	`offsetAllocationSizeInBytes`
`protected ArrowBuf`	`offsetBuffer`
`protected int`	`valueCount`
`protected FieldVector`	`vector`

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

インタフェースから継承されたフィールド org.apache.arrow.vector.complex.RepeatedValueVector
DEFAULT_REPEAT_PER_RECORD

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

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`BaseRepeatedValueVector(String name, BufferAllocator allocator, CallBack callBack)`
`protected`	`BaseRepeatedValueVector(String name, BufferAllocator allocator, FieldVector vector, CallBack callBack)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`<T extends ValueVector> AddOrGetResult<T>`	`addOrGetVector(FieldType fieldType)`
`boolean`	`allocateNewSafe()` Allocates new buffers.
`protected void`	`allocateOffsetBuffer(long size)`
`void`	`clear()` Release any owned ArrowBuf and reset the ValueVector to the initial state.
`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.
`FieldVector`	`getDataVector()`
`int`	`getInnerValueCount()`
`int`	`getInnerValueCountAt(int index)`
`protected int`	`getOffsetBufferValueCapacity()`
`UInt4Vector`	`getOffsetVector()` 非推奨です。
`int`	`getValueCapacity()` Returns the maximum number of values that can be stored in this vector instance.
`int`	`getValueCount()` Gets the number of values
`boolean`	`isEmpty(int index)`
`boolean`	`isNull(int index)` Check whether an element in the vector is null
`Iterator<ValueVector>`	`iterator()`
`void`	`reAlloc()` Allocate new buffer with double capacity, and copy data into the new buffer.
`protected void`	`reallocOffsetBuffer()`
`protected void`	`replaceDataVector(FieldVector v)`
`void`	`reset()` Reset the ValueVector to the initial state without releasing any owned ArrowBuf.
`void`	`setInitialCapacity(int numRecords)` Set the initial record capacity
`void`	`setInitialCapacity(int numRecords, double density)` Specialized version of setInitialCapacity() for ListVector.
`void`	`setValueCount(int valueCount)` Set number of values in the vector
`int`	`size()`
`int`	`startNewValue(int index)`

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

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

インタフェースから継承されたメソッド org.apache.arrow.vector.ValueVector
allocateNew, close, getAllocator, getDataBuffer, getField, getMinorType, getNullCount, getObject, getOffsetBuffer, getReader, getTransferPair, getTransferPair, getTransferPair, getValidityBuffer, makeTransferPair

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

- フィールドの詳細
  - DEFAULT_DATA_VECTOR
```
public static final FieldVector DEFAULT_DATA_VECTOR
```
  - DATA_VECTOR_NAME
```
public static final String DATA_VECTOR_NAME
```
    関連項目:
    
    定数フィールド値
  - OFFSET_WIDTH
```
public static final byte OFFSET_WIDTH
```
    関連項目:
    
    定数フィールド値
  - offsetBuffer
```
protected ArrowBuf offsetBuffer
```
  - vector
```
protected FieldVector vector
```
  - callBack
```
protected final CallBack callBack
```
  - valueCount
```
protected int valueCount
```
  - offsetAllocationSizeInBytes
```
protected int offsetAllocationSizeInBytes
```
- コンストラクタの詳細
  - BaseRepeatedValueVector
```
protected BaseRepeatedValueVector(String name,
                                  BufferAllocator allocator,
                                  CallBack callBack)
```
  - BaseRepeatedValueVector
```
protected BaseRepeatedValueVector(String name,
                                  BufferAllocator allocator,
                                  FieldVector vector,
                                  CallBack callBack)
```
- メソッドの詳細
  - allocateNewSafe
```
public boolean allocateNewSafe()
```
    インタフェースからコピーされた説明: ValueVector
    
    Allocates new buffers. ValueVector implements logic to determine how much to allocate.
    
    定義:
    
    allocateNewSafe インタフェース内 ValueVector
    
    戻り値:
    
    Returns true if allocation was successful.
  - allocateOffsetBuffer
```
protected void allocateOffsetBuffer(long size)
```
  - reAlloc
```
public void reAlloc()
```
    インタフェースからコピーされた説明: 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
    
    定義:
    
    reAlloc インタフェース内 ValueVector
  - reallocOffsetBuffer
```
protected void reallocOffsetBuffer()
```
  - getOffsetVector
```
@Deprecated
public UInt4Vector getOffsetVector()
```
    非推奨です。
    
    定義:
    
    getOffsetVector インタフェース内 RepeatedValueVector
    
    戻り値:
    
    the underlying offset vector or null if none exists.
  - getDataVector
```
public FieldVector getDataVector()
```
    定義:
    
    getDataVector インタフェース内 RepeatedValueVector
    
    戻り値:
    
    the underlying data vector or null if none exists.
  - setInitialCapacity
```
public void setInitialCapacity(int numRecords)
```
    インタフェースからコピーされた説明: ValueVector
    
    Set the initial record capacity
    
    定義:
    
    setInitialCapacity インタフェース内 ValueVector
    
    パラメータ:
    
    numRecords - the initial record capacity.
  - setInitialCapacity
```
public void setInitialCapacity(int numRecords,
                               double density)
```
    Specialized version of setInitialCapacity() for ListVector. This is used by some callers when they want to explicitly control and be conservative about memory allocated for inner data vector. This is very useful when we are working with memory constraints for a query and have a fixed amount of memory reserved for the record batch. In such cases, we are likely to face OOM or related problems when we reserve memory for a record batch with value count x and do setInitialCapacity(x) such that each vector allocates only what is necessary and not the default amount but the multiplier forces the memory requirement to go beyond what was needed.
    
    定義:
    
    setInitialCapacity インタフェース内 DensityAwareVector
    
    パラメータ:
    
    numRecords - value count
    
    density - density of ListVector. Density is the average size of list per position in the List vector. For example, a density value of 10 implies each position in the list vector has a list of 10 values. A density value of 0.1 implies out of 10 positions in the list vector, 1 position has a list of size 1 and remaining positions are null (no lists) or empty lists. This helps in tightly controlling the memory we provision for inner data vector.
  - getValueCapacity
```
public int getValueCapacity()
```
    インタフェースからコピーされた説明: ValueVector
    
    Returns the maximum number of values that can be stored in this vector instance.
    
    定義:
    
    getValueCapacity インタフェース内 ValueVector
    
    戻り値:
    
    the maximum number of values that can be stored in this vector instance.
  - getOffsetBufferValueCapacity
```
protected int getOffsetBufferValueCapacity()
```
  - getBufferSize
```
public int getBufferSize()
```
    定義:
    
    getBufferSize インタフェース内 ValueVector
    
    戻り値:
    
    the number of bytes that is used by this vector instance.
  - getBufferSizeFor
```
public int getBufferSizeFor(int valueCount)
```
    インタフェースからコピーされた説明: 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.
    
    定義:
    
    getBufferSizeFor インタフェース内 ValueVector
    
    パラメータ:
    
    valueCount - the number of values to assume this vector contains
    
    戻り値:
    
    the buffer size if this vector is holding valueCount values
  - iterator
```
public Iterator<ValueVector> iterator()
```
    定義:
    
    iterator インタフェース内 Iterable<ValueVector>
    
    オーバーライド:
    
    iterator クラス内 BaseValueVector
  - clear
```
public void clear()
```
    インタフェースからコピーされた説明: 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.
    
    定義:
    
    clear インタフェース内 ValueVector
    
    オーバーライド:
    
    clear クラス内 BaseValueVector
  - reset
```
public void reset()
```
    インタフェースからコピーされた説明: 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.
    
    定義:
    
    reset インタフェース内 ValueVector
  - getBuffers
```
public ArrowBuf[] getBuffers(boolean clear)
```
    インタフェースからコピーされた説明: 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).
    
    定義:
    
    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.
  - size
```
public int size()
```
    戻り値:
    
    1 if inner vector is explicitly set via #addOrGetVector else 0
  - addOrGetVector
```
public <T extends ValueVector> AddOrGetResult<T> addOrGetVector(FieldType fieldType)
```
  - replaceDataVector
```
protected void replaceDataVector(FieldVector v)
```
  - getValueCount
```
public int getValueCount()
```
    インタフェースからコピーされた説明: ValueVector
    
    Gets the number of values
    
    定義:
    
    getValueCount インタフェース内 ValueVector
    
    戻り値:
  - getInnerValueCount
```
public int getInnerValueCount()
```
  - getInnerValueCountAt
```
public int getInnerValueCountAt(int index)
```
  - isNull
```
public boolean isNull(int index)
```
    インタフェースからコピーされた説明: ValueVector
    
    Check whether an element in the vector is null
    
    定義:
    
    isNull インタフェース内 ValueVector
    
    戻り値:
  - isEmpty
```
public boolean isEmpty(int index)
```
  - startNewValue
```
public int startNewValue(int index)
```
  - setValueCount
```
public void setValueCount(int valueCount)
```
    インタフェースからコピーされた説明: ValueVector
    
    Set number of values in the vector
    
    定義:
    
    setValueCount インタフェース内 ValueVector

クラス BaseRepeatedValueVector

フィールドのサマリー

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

インタフェースから継承されたフィールド org.apache.arrow.vector.complex.RepeatedValueVector

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

メソッドのサマリー

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

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

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

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

フィールドの詳細

DEFAULT_DATA_VECTOR

DATA_VECTOR_NAME

OFFSET_WIDTH

offsetBuffer

vector

callBack

valueCount

offsetAllocationSizeInBytes

コンストラクタの詳細

BaseRepeatedValueVector

BaseRepeatedValueVector

メソッドの詳細

allocateNewSafe

allocateOffsetBuffer

reAlloc

reallocOffsetBuffer

getOffsetVector

getDataVector

setInitialCapacity

setInitialCapacity

getValueCapacity

getOffsetBufferValueCapacity

getBufferSize

getBufferSizeFor

iterator

clear

reset

getBuffers

size

addOrGetVector

replaceDataVector

getValueCount

getInnerValueCount

getInnerValueCountAt

isNull

isEmpty

startNewValue

setValueCount