ZeroVector (Arrow Vectors 0.11.0 API)

java.lang.Object
- org.apache.arrow.vector.ZeroVector

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

Closeable, AutoCloseable, Iterable<ValueVector>, FieldVector, ValueVector
```
public class ZeroVector
extends Object
implements FieldVector
```

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static ZeroVector INSTANCE

フィールド
修飾子とタイプ	フィールドと説明
`static ZeroVector`	`INSTANCE`

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

コンストラクタ
コンストラクタと説明

ZeroVector()

コンストラクタ
コンストラクタと説明
`ZeroVector()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`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`	`close()` Alternative to clear().
`BufferAllocator`	`getAllocator()`
`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
`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()`
`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
`FieldReader`	`getReader()`
`TransferPair`	`getTransferPair(BufferAllocator allocator)` to transfer quota responsibility
`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
`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
`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`	`setValueCount(int valueCount)` Set number of values in the vector

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

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

- フィールドの詳細
  - INSTANCE
```
public static final ZeroVector INSTANCE
```
- コンストラクタの詳細
  - ZeroVector
```
public ZeroVector()
```
- メソッドの詳細
  - close
```
public void close()
```
    インタフェースからコピーされた説明: ValueVector
    
    Alternative to clear(). Allows use as an AutoCloseable in try-with-resources.
    
    定義:
    
    close インタフェース内 Closeable
    
    定義:
    
    close インタフェース内 AutoCloseable
    
    定義:
    
    close インタフェース内 ValueVector
  - 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
  - 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
  - getField
```
public Field getField()
```
    インタフェースからコピーされた説明: ValueVector
    
    Get information about how this field is materialized.
    
    定義:
    
    getField インタフェース内 ValueVector
    
    戻り値:
    
    the field corresponding to this vector
  - getMinorType
```
public Types.MinorType getMinorType()
```
    定義:
    
    getMinorType インタフェース内 ValueVector
  - getTransferPair
```
public TransferPair getTransferPair(BufferAllocator allocator)
```
    インタフェースからコピーされた説明: ValueVector
    
    to transfer quota responsibility
    
    定義:
    
    getTransferPair インタフェース内 ValueVector
    
    パラメータ:
    
    allocator - the target allocator
    
    戻り値:
    
    a transfer pair, creating a new target vector of the same type.
  - iterator
```
public Iterator<ValueVector> iterator()
```
    定義:
    
    iterator インタフェース内 Iterable<ValueVector>
  - 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
  - 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.
  - allocateNew
```
public void allocateNew()
                 throws OutOfMemoryException
```
    インタフェースからコピーされた説明: ValueVector
    
    Allocate new buffers. ValueVector implements logic to determine how much to allocate.
    
    定義:
    
    allocateNew インタフェース内 ValueVector
    
    例外:
    
    OutOfMemoryException - Thrown if no memory can be allocated.
  - 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.
  - 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
  - getAllocator
```
public BufferAllocator getAllocator()
```
    定義:
    
    getAllocator インタフェース内 ValueVector
  - setInitialCapacity
```
public void setInitialCapacity(int numRecords)
```
    インタフェースからコピーされた説明: ValueVector
    
    Set the initial record capacity
    
    定義:
    
    setInitialCapacity インタフェース内 ValueVector
    
    パラメータ:
    
    numRecords - the initial record capacity.
  - 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.
  - getTransferPair
```
public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)
```
    定義:
    
    getTransferPair インタフェース内 ValueVector
  - getTransferPair
```
public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator,
                                    CallBack callBack)
```
    定義:
    
    getTransferPair インタフェース内 ValueVector
  - makeTransferPair
```
public TransferPair makeTransferPair(ValueVector target)
```
    インタフェースからコピーされた説明: ValueVector
    
    makes a new transfer pair used to transfer underlying buffers
    
    定義:
    
    makeTransferPair インタフェース内 ValueVector
    
    パラメータ:
    
    target - the target for the transfer
    
    戻り値:
    
    a new transfer pair that is used to transfer underlying buffers into the target vector.
  - getReader
```
public FieldReader getReader()
```
    定義:
    
    getReader インタフェース内 ValueVector
    
    戻り値:
    
    a field reader that supports reading values from this vector.
  - initializeChildrenFromFields
```
public void initializeChildrenFromFields(List<Field> children)
```
    インタフェースからコピーされた説明: FieldVector
    
    Initializes the child vectors to be later loaded with loadBuffers
    
    定義:
    
    initializeChildrenFromFields インタフェース内 FieldVector
    
    パラメータ:
    
    children - the schema
  - getChildrenFromFields
```
public List<FieldVector> getChildrenFromFields()
```
    インタフェースからコピーされた説明: FieldVector
    
    the returned list is the same size as the list passed to initializeChildrenFromFields
    
    定義:
    
    getChildrenFromFields インタフェース内 FieldVector
    
    戻り値:
    
    the children according to schema (empty for primitive types)
  - loadFieldBuffers
```
public void loadFieldBuffers(ArrowFieldNode fieldNode,
                             List<ArrowBuf> ownBuffers)
```
    インタフェースからコピーされた説明: FieldVector
    
    loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
    
    定義:
    
    loadFieldBuffers インタフェース内 FieldVector
    
    パラメータ:
    
    fieldNode - the fieldNode
    
    ownBuffers - the buffers for this Field (own buffers only, children not included)
  - getFieldBuffers
```
public List<ArrowBuf> getFieldBuffers()
```
    インタフェースからコピーされた説明: FieldVector
    
    (same size as getFieldVectors() since it is their content)
    
    定義:
    
    getFieldBuffers インタフェース内 FieldVector
    
    戻り値:
    
    the buffers containing the data for this vector (ready for reading)
  - getFieldInnerVectors
```
public List<BufferBacked> getFieldInnerVectors()
```
    定義:
    
    getFieldInnerVectors インタフェース内 FieldVector
    
    戻り値:
    
    the inner vectors for this field as defined by the TypeLayout
  - getValidityBufferAddress
```
public long getValidityBufferAddress()
```
    インタフェースからコピーされた説明: FieldVector
    
    Gets the starting address of the underlying buffer associated with validity vector
    
    定義:
    
    getValidityBufferAddress インタフェース内 FieldVector
    
    戻り値:
    
    buffer address
  - getDataBufferAddress
```
public long getDataBufferAddress()
```
    インタフェースからコピーされた説明: FieldVector
    
    Gets the starting address of the underlying buffer associated with data vector
    
    定義:
    
    getDataBufferAddress インタフェース内 FieldVector
    
    戻り値:
    
    buffer address
  - getOffsetBufferAddress
```
public long getOffsetBufferAddress()
```
    インタフェースからコピーされた説明: FieldVector
    
    Gets the starting address of the underlying buffer associated with offset vector
    
    定義:
    
    getOffsetBufferAddress インタフェース内 FieldVector
    
    戻り値:
    
    buffer address
  - getValidityBuffer
```
public ArrowBuf getValidityBuffer()
```
    インタフェースからコピーされた説明: ValueVector
    
    Gets the underlying buffer associated with validity vector
    
    定義:
    
    getValidityBuffer インタフェース内 ValueVector
    
    戻り値:
    
    buffer
  - getDataBuffer
```
public ArrowBuf getDataBuffer()
```
    インタフェースからコピーされた説明: ValueVector
    
    Gets the underlying buffer associated with data vector
    
    定義:
    
    getDataBuffer インタフェース内 ValueVector
    
    戻り値:
    
    buffer
  - getOffsetBuffer
```
public ArrowBuf getOffsetBuffer()
```
    インタフェースからコピーされた説明: ValueVector
    
    Gets the underlying buffer associated with offset vector
    
    定義:
    
    getOffsetBuffer インタフェース内 ValueVector
    
    戻り値:
    
    buffer
  - getValueCount
```
public int getValueCount()
```
    インタフェースからコピーされた説明: ValueVector
    
    Gets the number of values
    
    定義:
    
    getValueCount インタフェース内 ValueVector
    
    戻り値:
  - setValueCount
```
public void setValueCount(int valueCount)
```
    インタフェースからコピーされた説明: ValueVector
    
    Set number of values in the vector
    
    定義:
    
    setValueCount インタフェース内 ValueVector
  - getObject
```
public Object getObject(int index)
```
    インタフェースからコピーされた説明: ValueVector
    
    Get friendly type object from the vector
    
    定義:
    
    getObject インタフェース内 ValueVector
    
    戻り値:
  - getNullCount
```
public int getNullCount()
```
    インタフェースからコピーされた説明: ValueVector
    
    Returns number of null elements in the vector
    
    定義:
    
    getNullCount インタフェース内 ValueVector
    
    戻り値:
  - isNull
```
public boolean isNull(int index)
```
    インタフェースからコピーされた説明: ValueVector
    
    Check whether an element in the vector is null
    
    定義:
    
    isNull インタフェース内 ValueVector
    
    戻り値:

クラス ZeroVector

フィールドのサマリー

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

メソッドのサマリー

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

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

フィールドの詳細

INSTANCE

コンストラクタの詳細

ZeroVector

メソッドの詳細

close

clear

reset

getField

getMinorType

getTransferPair

iterator

getBufferSize

getBufferSizeFor

getBuffers

allocateNew

allocateNewSafe

reAlloc

getAllocator

setInitialCapacity

getValueCapacity

getTransferPair

getTransferPair

makeTransferPair

getReader

initializeChildrenFromFields

getChildrenFromFields

loadFieldBuffers

getFieldBuffers

getFieldInnerVectors

getValidityBufferAddress

getDataBufferAddress

getOffsetBufferAddress

getValidityBuffer

getDataBuffer

getOffsetBuffer

getValueCount

setValueCount

getObject

getNullCount

isNull