StructVector (Arrow Vectors 0.11.0 API)

java.lang.Object
- org.apache.arrow.vector.complex.AbstractContainerVector
- - org.apache.arrow.vector.complex.AbstractStructVector
  - - org.apache.arrow.vector.complex.NonNullableStructVector
    - - org.apache.arrow.vector.complex.StructVector

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

Closeable, AutoCloseable, Iterable<ValueVector>, DensityAwareVector, FieldVector, ValueVector
```
public class StructVector
extends NonNullableStructVector
implements FieldVector
```

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

protected class StructVector.NullableStructTransferPair
- クラスから継承されたネストされたクラス/インタフェース org.apache.arrow.vector.complex.NonNullableStructVector
  NonNullableStructVector.StructTransferPair

ネストされたクラス
修飾子とタイプ	クラスと説明
`protected class`	`StructVector.NullableStructTransferPair`

フィールドのサマリー

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

protected ArrowBuf validityBuffer
- クラスから継承されたフィールド org.apache.arrow.vector.complex.NonNullableStructVector
  fieldType, valueCount
- クラスから継承されたフィールド org.apache.arrow.vector.complex.AbstractContainerVector
  allocator, callBack, name

フィールド
修飾子とタイプ	フィールドと説明
`protected ArrowBuf`	`validityBuffer`

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

コンストラクタ
コンストラクタと説明
`StructVector(String name, BufferAllocator allocator, CallBack callBack)` 非推奨です。
`StructVector(String name, BufferAllocator allocator, DictionaryEncoding dictionary, CallBack callBack)` 非推奨です。
`StructVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack callBack)`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド非推奨のメソッド
修飾子とタイプ	メソッドと説明
`boolean`	`allocateNewSafe()` Allocates new buffers.
`void`	`clear()` Same as `close()`
`void`	`close()` Close the vector and release the associated buffers.
`static StructVector`	`empty(String name, BufferAllocator allocator)`
`void`	`get(int index, ComplexHolder holder)`
`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 valueCount)` Get the potential buffer size for a particular number of records.
`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()` 非推奨です。
`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
`NullableStructReaderImpl`	`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()` Get the current value capacity for the vector
`NullableStructWriter`	`getWriter()`
`boolean`	`isNull(int index)` Check whether an element in the vector is null
`int`	`isSet(int index)`
`void`	`loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers)` loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
`TransferPair`	`makeTransferPair(ValueVector to)` 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 this vector to empty, does not release buffers
`void`	`setIndexDefined(int index)`
`void`	`setInitialCapacity(int numRecords)` Set the initial record capacity
`void`	`setInitialCapacity(int numRecords, double density)` Set value with density
`void`	`setNull(int index)`
`void`	`setValueCount(int valueCount)` Set number of values in the vector

クラスから継承されたメソッド org.apache.arrow.vector.complex.NonNullableStructVector
copyFromSafe, fieldNameIterator, getChildrenFromFields, getMinorType, getValueCount, getVectorById, initializeChildrenFromFields, supportsDirectRead

クラスから継承されたメソッド org.apache.arrow.vector.complex.AbstractStructVector
add, addOrGet, getChild, getChildByOrdinal, getChildFieldNames, getChildren, getChildVectorWithOrdinal, getPrimitiveVectors, iterator, putChild, putVector, size

クラスから継承されたメソッド org.apache.arrow.vector.complex.AbstractContainerVector
addOrGetList, addOrGetStruct, addOrGetUnion, allocateNew, getAllocator, getChild, typeify

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

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

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

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

- フィールドの詳細
  - validityBuffer
```
protected ArrowBuf validityBuffer
```
- コンストラクタの詳細
  - StructVector
```
@Deprecated
public StructVector(String name,
                                BufferAllocator allocator,
                                CallBack callBack)
```
    非推奨です。
  - StructVector
```
@Deprecated
public StructVector(String name,
                                BufferAllocator allocator,
                                DictionaryEncoding dictionary,
                                CallBack callBack)
```
    非推奨です。
  - StructVector
```
public StructVector(String name,
                    BufferAllocator allocator,
                    FieldType fieldType,
                    CallBack callBack)
```
- メソッドの詳細
  - empty
```
public static StructVector empty(String name,
                                 BufferAllocator allocator)
```
  - getField
```
public Field getField()
```
    インタフェースからコピーされた説明: ValueVector
    
    Get information about how this field is materialized.
    
    定義:
    
    getField インタフェース内 ValueVector
    
    オーバーライド:
    
    getField クラス内 NonNullableStructVector
    
    戻り値:
    
    the field corresponding to this vector
  - 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
```
@Deprecated
public List<BufferBacked> getFieldInnerVectors()
```
    非推奨です。
    
    定義:
    
    getFieldInnerVectors インタフェース内 FieldVector
    
    戻り値:
    
    the inner vectors for this field as defined by the TypeLayout
  - getReader
```
public NullableStructReaderImpl getReader()
```
    定義:
    
    getReader インタフェース内 ValueVector
    
    オーバーライド:
    
    getReader クラス内 NonNullableStructVector
    
    戻り値:
    
    a field reader that supports reading values from this vector.
  - getWriter
```
public NullableStructWriter getWriter()
```
  - getTransferPair
```
public TransferPair getTransferPair(BufferAllocator allocator)
```
    インタフェースからコピーされた説明: ValueVector
    
    to transfer quota responsibility
    
    定義:
    
    getTransferPair インタフェース内 ValueVector
    
    オーバーライド:
    
    getTransferPair クラス内 NonNullableStructVector
    
    パラメータ:
    
    allocator - the target allocator
    
    戻り値:
    
    a transfer pair, creating a new target vector of the same type.
  - makeTransferPair
```
public TransferPair makeTransferPair(ValueVector to)
```
    インタフェースからコピーされた説明: ValueVector
    
    makes a new transfer pair used to transfer underlying buffers
    
    定義:
    
    makeTransferPair インタフェース内 ValueVector
    
    オーバーライド:
    
    makeTransferPair クラス内 NonNullableStructVector
    
    パラメータ:
    
    to - the target for the transfer
    
    戻り値:
    
    a new transfer pair that is used to transfer underlying buffers into the target vector.
  - getTransferPair
```
public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)
```
    定義:
    
    getTransferPair インタフェース内 ValueVector
    
    オーバーライド:
    
    getTransferPair クラス内 NonNullableStructVector
  - getTransferPair
```
public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator,
                                    CallBack callBack)
```
    定義:
    
    getTransferPair インタフェース内 ValueVector
    
    オーバーライド:
    
    getTransferPair クラス内 NonNullableStructVector
  - getValueCapacity
```
public int getValueCapacity()
```
    Get the current value capacity for the vector
    
    定義:
    
    getValueCapacity インタフェース内 ValueVector
    
    オーバーライド:
    
    getValueCapacity クラス内 NonNullableStructVector
    
    戻り値:
    
    number of elements that vector can hold.
  - 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
    
    オーバーライド:
    
    getBuffers クラス内 AbstractStructVector
    
    パラメータ:
    
    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.
  - close
```
public void close()
```
    Close the vector and release the associated buffers.
    
    定義:
    
    close インタフェース内 Closeable
    
    定義:
    
    close インタフェース内 AutoCloseable
    
    定義:
    
    close インタフェース内 ValueVector
    
    オーバーライド:
    
    close クラス内 NonNullableStructVector
  - clear
```
public void clear()
```
    Same as close()
    
    定義:
    
    clear インタフェース内 ValueVector
    
    オーバーライド:
    
    clear クラス内 NonNullableStructVector
  - reset
```
public void reset()
```
    Reset this vector to empty, does not release buffers
    
    定義:
    
    reset インタフェース内 ValueVector
    
    オーバーライド:
    
    reset クラス内 NonNullableStructVector
  - getBufferSize
```
public int getBufferSize()
```
    Get the size (number of bytes) of underlying buffers used by this vector
    
    定義:
    
    getBufferSize インタフェース内 ValueVector
    
    オーバーライド:
    
    getBufferSize クラス内 NonNullableStructVector
    
    戻り値:
    
    size of underlying buffers.
  - getBufferSizeFor
```
public int getBufferSizeFor(int valueCount)
```
    Get the potential buffer size for a particular number of records.
    
    定義:
    
    getBufferSizeFor インタフェース内 ValueVector
    
    オーバーライド:
    
    getBufferSizeFor クラス内 NonNullableStructVector
    
    パラメータ:
    
    valueCount - desired number of elements in the vector
    
    戻り値:
    
    estimated size of underlying buffers if the vector holds a given number of elements
  - setInitialCapacity
```
public void setInitialCapacity(int numRecords)
```
    インタフェースからコピーされた説明: ValueVector
    
    Set the initial record capacity
    
    定義:
    
    setInitialCapacity インタフェース内 ValueVector
    
    オーバーライド:
    
    setInitialCapacity クラス内 NonNullableStructVector
    
    パラメータ:
    
    numRecords - the initial record capacity.
  - setInitialCapacity
```
public void setInitialCapacity(int numRecords,
                               double density)
```
    インタフェースからコピーされた説明: DensityAwareVector
    
    Set value with density
    
    定義:
    
    setInitialCapacity インタフェース内 DensityAwareVector
    
    オーバーライド:
    
    setInitialCapacity クラス内 NonNullableStructVector
  - allocateNewSafe
```
public boolean allocateNewSafe()
```
    インタフェースからコピーされた説明: ValueVector
    
    Allocates new buffers. ValueVector implements logic to determine how much to allocate.
    
    定義:
    
    allocateNewSafe インタフェース内 ValueVector
    
    オーバーライド:
    
    allocateNewSafe クラス内 AbstractStructVector
    
    戻り値:
    
    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
    
    オーバーライド:
    
    reAlloc クラス内 AbstractStructVector
  - 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
    
    オーバーライド:
    
    getValidityBuffer クラス内 NonNullableStructVector
    
    戻り値:
    
    buffer
  - getDataBuffer
```
public ArrowBuf getDataBuffer()
```
    インタフェースからコピーされた説明: ValueVector
    
    Gets the underlying buffer associated with data vector
    
    定義:
    
    getDataBuffer インタフェース内 ValueVector
    
    オーバーライド:
    
    getDataBuffer クラス内 NonNullableStructVector
    
    戻り値:
    
    buffer
  - getOffsetBuffer
```
public ArrowBuf getOffsetBuffer()
```
    インタフェースからコピーされた説明: ValueVector
    
    Gets the underlying buffer associated with offset vector
    
    定義:
    
    getOffsetBuffer インタフェース内 ValueVector
    
    オーバーライド:
    
    getOffsetBuffer クラス内 NonNullableStructVector
    
    戻り値:
    
    buffer
  - getObject
```
public Object getObject(int index)
```
    インタフェースからコピーされた説明: ValueVector
    
    Get friendly type object from the vector
    
    定義:
    
    getObject インタフェース内 ValueVector
    
    オーバーライド:
    
    getObject クラス内 NonNullableStructVector
    
    戻り値:
  - get
```
public void get(int index,
                ComplexHolder holder)
```
    オーバーライド:
    
    get クラス内 NonNullableStructVector
  - getNullCount
```
public int getNullCount()
```
    インタフェースからコピーされた説明: ValueVector
    
    Returns number of null elements in the vector
    
    定義:
    
    getNullCount インタフェース内 ValueVector
    
    オーバーライド:
    
    getNullCount クラス内 NonNullableStructVector
    
    戻り値:
  - isNull
```
public boolean isNull(int index)
```
    インタフェースからコピーされた説明: ValueVector
    
    Check whether an element in the vector is null
    
    定義:
    
    isNull インタフェース内 ValueVector
    
    オーバーライド:
    
    isNull クラス内 NonNullableStructVector
    
    戻り値:
  - isSet
```
public int isSet(int index)
```
  - setIndexDefined
```
public void setIndexDefined(int index)
```
  - setNull
```
public void setNull(int index)
```
  - setValueCount
```
public void setValueCount(int valueCount)
```
    インタフェースからコピーされた説明: ValueVector
    
    Set number of values in the vector
    
    定義:
    
    setValueCount インタフェース内 ValueVector
    
    オーバーライド:
    
    setValueCount クラス内 NonNullableStructVector

クラス StructVector

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.apache.arrow.vector.complex.NonNullableStructVector

フィールドのサマリー

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

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

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

メソッドのサマリー

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

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

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

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

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

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

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

フィールドの詳細

validityBuffer

コンストラクタの詳細

StructVector

StructVector

StructVector

メソッドの詳細

empty

getField

loadFieldBuffers

getFieldBuffers

getFieldInnerVectors

getReader

getWriter

getTransferPair

makeTransferPair

getTransferPair

getTransferPair

getValueCapacity

getBuffers

close

clear

reset

getBufferSize

getBufferSizeFor

setInitialCapacity

setInitialCapacity

allocateNewSafe

reAlloc

getValidityBufferAddress

getDataBufferAddress

getOffsetBufferAddress

getValidityBuffer

getDataBuffer

getOffsetBuffer

getObject

get

getNullCount

isNull

isSet

setIndexDefined

setNull

setValueCount