org.apache.arrow.vector.complex

クラス ListVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.complex.BaseRepeatedValueVector

org.apache.arrow.vector.complex.ListVector

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

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

public class ListVector
extends BaseRepeatedValueVector
implements FieldVector, PromotableVector

フィールドのサマリー

フィールド

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

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

DATA_VECTOR_NAME, DEFAULT_DATA_VECTOR, OFFSET_WIDTH, offsetAllocationSizeInBytes, offsetBuffer, valueCount, 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

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
<T extends ValueVector> AddOrGetResult<T>	addOrGetVector(FieldType fieldType)
void	allocateNew() Same as allocateNewSafe().
boolean	allocateNewSafe() Allocate memory for the vector.
void	clear() Release any owned ArrowBuf and reset the ValueVector to the initial state.
void	copyFrom(int inIndex, int outIndex, ListVector 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, ListVector from) Same as copyFrom(int, int, ListVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.
static ListVector	empty(String name, BufferAllocator allocator)
void	endValue(int index, int size) End the current value
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
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() Get the inner data vector for this list vector
double	getDensity() Get the density of this ListVector
Field	getField() Get information about how this field is materialized.
List<ArrowBuf>	getFieldBuffers() Get the buffers belonging to this vector
List<BufferBacked>	getFieldInnerVectors() 非推奨です。
int	getLastSet()
Types.MinorType	getMinorType()
int	getNullCount() Get the number of elements that are null in the vector
Object	getObject(int index) Get the element in the list vector at a particular index
ArrowBuf	getOffsetBuffer() Gets the underlying buffer associated with offset vector
long	getOffsetBufferAddress() Gets the starting address of the underlying buffer associated with offset vector
UnionListReader	getReader()
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
UnionListWriter	getWriter()
void	initializeChildrenFromFields(List<Field> children) Initializes the child vectors to be later loaded with loadBuffers
boolean	isNull(int index) Check if element at given index is null.
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.
TransferPair	makeTransferPair(ValueVector target) makes a new transfer pair used to transfer underlying buffers
UnionVector	promoteToUnion()
void	reAlloc() Resize the vector to increase the capacity.
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	setLastSet(int value)
void	setNotNull(int index)
void	setValueCount(int valueCount) Sets the value count for the vector
int	startNewValue(int index) Start a new value in the list vector

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

allocateOffsetBuffer, getBufferSizeFor, getInnerValueCount, getInnerValueCountAt, getOffsetBufferValueCapacity, getOffsetVector, getValueCount, isEmpty, iterator, reallocOffsetBuffer, replaceDataVector, size

クラスから継承されたメソッド 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

close, getAllocator, getBufferSizeFor, getTransferPair, getValueCount

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

forEach, iterator, spliterator

フィールドの詳細

validityBuffer

protected ArrowBuf validityBuffer

コンストラクタの詳細

ListVector

@Deprecated
public ListVector(String name,
                              BufferAllocator allocator,
                              CallBack callBack)

非推奨です。

ListVector

@Deprecated
public ListVector(String name,
                              BufferAllocator allocator,
                              DictionaryEncoding dictionary,
                              CallBack callBack)

非推奨です。

ListVector

public ListVector(String name,
                  BufferAllocator allocator,
                  FieldType fieldType,
                  CallBack callBack)

メソッドの詳細

empty

public static ListVector empty(String name,
                               BufferAllocator allocator)

initializeChildrenFromFields

public void initializeChildrenFromFields(List<Field> children)

インタフェースからコピーされた説明: FieldVector

Initializes the child vectors to be later loaded with loadBuffers

定義:

initializeChildrenFromFields インタフェース内 FieldVector

パラメータ:

children - the schema

setInitialCapacity

public void setInitialCapacity(int numRecords)

インタフェースからコピーされた説明: ValueVector

Set the initial record capacity

定義:

setInitialCapacity インタフェース内 ValueVector

オーバーライド:

setInitialCapacity クラス内 BaseRepeatedValueVector

パラメータ:

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

オーバーライド:

setInitialCapacity クラス内 BaseRepeatedValueVector

パラメータ:

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.

getDensity

public double getDensity()

Get the density of this ListVector

戻り値:

density

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)

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.

getFieldInnerVectors

@Deprecated
public List<BufferBacked> getFieldInnerVectors()

非推奨です。

定義:

getFieldInnerVectors インタフェース内 FieldVector

戻り値:

the inner vectors for this field as defined by the TypeLayout

getWriter

public UnionListWriter getWriter()

allocateNew

public void allocateNew()
                 throws OutOfMemoryException

Same as allocateNewSafe().

定義:

allocateNew インタフェース内 ValueVector

例外:

OutOfMemoryException - Thrown if no memory can be allocated.

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.

定義:

allocateNewSafe インタフェース内 ValueVector

オーバーライド:

allocateNewSafe クラス内 BaseRepeatedValueVector

戻り値:

false if memory allocation fails, true otherwise.

reAlloc

public void reAlloc()

Resize the vector to increase the capacity. The internal behavior is to double the current value capacity.

定義:

reAlloc インタフェース内 ValueVector

オーバーライド:

reAlloc クラス内 BaseRepeatedValueVector

copyFromSafe

public void copyFromSafe(int inIndex,
                         int outIndex,
                         ListVector from)

Same as copyFrom(int, int, ListVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.

パラメータ:

inIndex - position to copy from in source vector

outIndex - position to copy to in this vector

from - source vector

copyFrom

public void copyFrom(int inIndex,
                     int outIndex,
                     ListVector from)

Copy a cell value from a particular index in source vector to a particular position in this vector

パラメータ:

inIndex - position to copy from in source vector

outIndex - position to copy to in this vector

from - source vector

getDataVector

public FieldVector getDataVector()

Get the inner data vector for this list vector

定義:

getDataVector インタフェース内 RepeatedValueVector

オーバーライド:

getDataVector クラス内 BaseRepeatedValueVector

戻り値:

data vector

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.

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

getReader

public UnionListReader getReader()

定義:

getReader インタフェース内 ValueVector

戻り値:

a field reader that supports reading values from this vector.

addOrGetVector

public <T extends ValueVector> AddOrGetResult<T> addOrGetVector(FieldType fieldType)

定義:

addOrGetVector インタフェース内 PromotableVector

オーバーライド:

addOrGetVector クラス内 BaseRepeatedValueVector

getBufferSize

public int getBufferSize()

Get the size (number of bytes) of underlying buffers used by this vector

定義:

getBufferSize インタフェース内 ValueVector

オーバーライド:

getBufferSize クラス内 BaseRepeatedValueVector

戻り値:

size of underlying buffers.

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

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 クラス内 BaseRepeatedValueVector

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

オーバーライド:

reset クラス内 BaseRepeatedValueVector

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 クラス内 BaseRepeatedValueVector

パラメータ:

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.

promoteToUnion

public UnionVector promoteToUnion()

定義:

promoteToUnion インタフェース内 PromotableVector

getObject

public Object getObject(int index)

Get the element in the list vector at a particular index

定義:

getObject インタフェース内 ValueVector

パラメータ:

index - position of the element

戻り値:

Object at given position

isNull

public boolean isNull(int index)

Check if element at given index is null.

定義:

isNull インタフェース内 ValueVector

オーバーライド:

isNull クラス内 BaseRepeatedValueVector

パラメータ:

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

getNullCount

public int getNullCount()

Get the number of elements that are null in the vector

定義:

getNullCount インタフェース内 ValueVector

戻り値:

the number of null elements.

getValueCapacity

public int getValueCapacity()

Get the current value capacity for the vector

定義:

getValueCapacity インタフェース内 ValueVector

オーバーライド:

getValueCapacity クラス内 BaseRepeatedValueVector

戻り値:

number of elements that vector can hold.

setNotNull

public void setNotNull(int index)

startNewValue

public int startNewValue(int index)

Start a new value in the list vector

オーバーライド:

startNewValue クラス内 BaseRepeatedValueVector

パラメータ:

index - index of the value to start

endValue

public void endValue(int index,
                     int size)

End the current value

パラメータ:

index - index of the value to end

size - number of elements in the list that was written

setValueCount

public void setValueCount(int valueCount)

Sets the value count for the vector

定義:

setValueCount インタフェース内 ValueVector

オーバーライド:

setValueCount クラス内 BaseRepeatedValueVector

パラメータ:

valueCount - value count

setLastSet

public void setLastSet(int value)

getLastSet

public int getLastSet()