org.apache.arrow.vector

クラス DecimalVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseFixedWidthVector

org.apache.arrow.vector.DecimalVector

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

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

public class DecimalVector
extends BaseFixedWidthVector

DecimalVector implements a fixed width vector (16 bytes) of decimal values which could be null. A validity buffer (bit vector) is maintained to track which elements in the vector are null.

フィールドのサマリー

フィールド

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

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

field, validityAllocationSizeInBytes, validityBuffer, valueAllocationSizeInBytes, valueBuffer, valueCount

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

allocator, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY, name

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

コンストラクタ

コンストラクタと説明
DecimalVector(String name, BufferAllocator allocator, int precision, int scale) Instantiate a DecimalVector.
DecimalVector(String name, FieldType fieldType, BufferAllocator allocator) Instantiate a DecimalVector.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	copyFrom(int fromIndex, int thisIndex, DecimalVector from) Copy a cell value from a particular index in source vector to a particular position in this vector
void	copyFromSafe(int fromIndex, int thisIndex, DecimalVector from) Same as copyFrom(int, int, DecimalVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.
ArrowBuf	get(int index) Get the element at the given index from the vector.
void	get(int index, NullableDecimalHolder holder) Get the element at the given index from the vector and sets the state in holder.
Types.MinorType	getMinorType() Get minor type for this vector.
BigDecimal	getObject(int index) Same as get(int).
FieldReader	getReader() Get a reader that supports reading values from this vector
int	getScale() Return scale for the decimal value
TransferPair	getTransferPair(String ref, BufferAllocator allocator) Construct a TransferPair comprising of this and and a target vector of the same type.
TransferPair	makeTransferPair(ValueVector to) Construct a TransferPair with a desired target vector of the same type.
void	set(int index, ArrowBuf buffer) Set the element at the given index to the given value.
void	set(int index, BigDecimal value) Set the element at the given index to the given value.
void	set(int index, DecimalHolder holder) Set the element at the given index to the value set in data holder.
void	set(int index, int start, ArrowBuf buffer) Set the element at the given index to the given value.
void	set(int index, int isSet, int start, ArrowBuf buffer) Store the given value at a particular position in the vector. isSet indicates whether the value is NULL or not.
void	set(int index, NullableDecimalHolder holder) Set the element at the given index to the value set in data holder.
void	setBigEndian(int index, byte[] value) Set the decimal element at given index to the provided array of bytes.
void	setBigEndianSafe(int index, byte[] value) Same as setBigEndian(int, byte[]) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setNull(int index) Set the element at the given index to null.
void	setSafe(int index, ArrowBuf buffer) Same as set(int, ArrowBuf) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, BigDecimal value) Same as set(int, BigDecimal) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, DecimalHolder holder) Same as set(int, DecimalHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, int start, ArrowBuf buffer) Same as set(int, int, ArrowBuf) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, int isSet, int start, ArrowBuf buffer) Same as setSafe(int, int, int, ArrowBuf) except that it handles the case when the position of new value is beyond the current value capacity of the vector.
void	setSafe(int index, NullableDecimalHolder holder) Same as set(int, NullableDecimalHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

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

allocateNew, allocateNew, allocateNewSafe, clear, close, decrementAllocationMonitor, getBuffers, getBufferSize, getBufferSizeFor, getChildrenFromFields, getDataBuffer, getDataBufferAddress, getField, getFieldBuffers, getFieldInnerVectors, getNullCount, getOffsetBuffer, getOffsetBufferAddress, getTransferPair, getTransferPair, getValidityBuffer, getValidityBufferAddress, getValueCapacity, getValueCount, handleSafe, incrementAllocationMonitor, initializeChildrenFromFields, isNull, isSafe, isSet, loadFieldBuffers, reAlloc, reset, set, set, setIndexDefined, setInitialCapacity, setSafe, setSafe, setValueCount, splitAndTransferTo, transferTo, zeroVector

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

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

forEach, iterator, spliterator

フィールドの詳細

TYPE_WIDTH

public static final byte TYPE_WIDTH

関連項目:

定数フィールド値

コンストラクタの詳細

DecimalVector

public DecimalVector(String name,
                     BufferAllocator allocator,
                     int precision,
                     int scale)

Instantiate a DecimalVector. This doesn't allocate any memory for the data in vector.

パラメータ:

name - name of the vector

allocator - allocator for memory management.

DecimalVector

public DecimalVector(String name,
                     FieldType fieldType,
                     BufferAllocator allocator)

Instantiate a DecimalVector. This doesn't allocate any memory for the data in vector.

パラメータ:

name - name of the vector

fieldType - type of Field materialized by this vector

allocator - allocator for memory management.

メソッドの詳細

getReader

public FieldReader getReader()

Get a reader that supports reading values from this vector

戻り値:

Field Reader for this vector

getMinorType

public Types.MinorType getMinorType()

Get minor type for this vector. The vector holds values belonging to a particular type.

戻り値:

Types.MinorType

get

public ArrowBuf get(int index)
             throws IllegalStateException

Get the element at the given index from the vector.

パラメータ:

index - position of element

戻り値:

element at given index

例外:

IllegalStateException

get

public void get(int index,
                NullableDecimalHolder holder)

Get the element at the given index from the vector and sets the state in holder. If element at given index is null, holder.isSet will be zero.

パラメータ:

index - position of element

getObject

public BigDecimal getObject(int index)

Same as get(int).

パラメータ:

index - position of element

戻り値:

element at given index

copyFrom

public void copyFrom(int fromIndex,
                     int thisIndex,
                     DecimalVector from)

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

パラメータ:

fromIndex - position to copy from in source vector

thisIndex - position to copy to in this vector

from - source vector

copyFromSafe

public void copyFromSafe(int fromIndex,
                         int thisIndex,
                         DecimalVector from)

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

パラメータ:

fromIndex - position to copy from in source vector

thisIndex - position to copy to in this vector

from - source vector

getScale

public int getScale()

Return scale for the decimal value

set

public void set(int index,
                ArrowBuf buffer)

Set the element at the given index to the given value.

パラメータ:

index - position of element

buffer - ArrowBuf containing decimal value.

setBigEndian

public void setBigEndian(int index,
                         byte[] value)

Set the decimal element at given index to the provided array of bytes. Decimal is now implemented as Little Endian. This API allows the user to pass a decimal value in the form of byte array in BE byte order. Consumers of Arrow code can use this API instead of first swapping the source bytes (doing a write and read) and then finally writing to ArrowBuf of decimal vector. This method takes care of adding the necessary padding if the length of byte array is less then 16 (length of decimal type).

パラメータ:

index - position of element

value - array of bytes containing decimal in big endian byte order.

set

public void set(int index,
                int start,
                ArrowBuf buffer)

Set the element at the given index to the given value.

パラメータ:

index - position of element

start - start index of data in the buffer

buffer - ArrowBuf containing decimal value.

set

public void set(int index,
                BigDecimal value)

Set the element at the given index to the given value.

パラメータ:

index - position of element

value - BigDecimal containing decimal value.

set

public void set(int index,
                NullableDecimalHolder holder)
         throws IllegalArgumentException

Set the element at the given index to the value set in data holder. If the value in holder is not indicated as set, element in the at the given index will be null.

パラメータ:

index - position of element

holder - nullable data holder for value of element

例外:

IllegalArgumentException

set

public void set(int index,
                DecimalHolder holder)

Set the element at the given index to the value set in data holder.

パラメータ:

index - position of element

holder - data holder for value of element

setSafe

public void setSafe(int index,
                    ArrowBuf buffer)

Same as set(int, ArrowBuf) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

パラメータ:

index - position of element

buffer - ArrowBuf containing decimal value.

setBigEndianSafe

public void setBigEndianSafe(int index,
                             byte[] value)

Same as setBigEndian(int, byte[]) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

setSafe

public void setSafe(int index,
                    int start,
                    ArrowBuf buffer)

Same as set(int, int, ArrowBuf) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

パラメータ:

index - position of element

start - start index of data in the buffer

buffer - ArrowBuf containing decimal value.

setSafe

public void setSafe(int index,
                    BigDecimal value)

Same as set(int, BigDecimal) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

パラメータ:

index - position of element

value - BigDecimal containing decimal value.

setSafe

public void setSafe(int index,
                    NullableDecimalHolder holder)
             throws IllegalArgumentException

Same as set(int, NullableDecimalHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

パラメータ:

index - position of element

holder - nullable data holder for value of element

例外:

IllegalArgumentException

setSafe

public void setSafe(int index,
                    DecimalHolder holder)

Same as set(int, DecimalHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

パラメータ:

index - position of element

holder - data holder for value of element

setNull

public void setNull(int index)

Set the element at the given index to null.

パラメータ:

index - position of element

set

public void set(int index,
                int isSet,
                int start,
                ArrowBuf buffer)

Store the given value at a particular position in the vector. isSet indicates whether the value is NULL or not.

パラメータ:

index - position of the new value

isSet - 0 for NULL value, 1 otherwise

start - start position of the value in the buffer

buffer - buffer containing the value to be stored in the vector

setSafe

public void setSafe(int index,
                    int isSet,
                    int start,
                    ArrowBuf buffer)

Same as setSafe(int, int, int, ArrowBuf) except that it handles the case when the position of new value is beyond the current value capacity of the vector.

パラメータ:

index - position of the new value

isSet - 0 for NULL value, 1 otherwise

start - start position of the value in the buffer

buffer - buffer containing the value to be stored in the vector

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)

Construct a TransferPair comprising of this and and a target vector of the same type.

定義:

getTransferPair インタフェース内 ValueVector

定義:

getTransferPair クラス内 BaseFixedWidthVector

パラメータ:

ref - name of the target vector

allocator - allocator for the target vector

戻り値:

TransferPair

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

Construct a TransferPair with a desired target vector of the same type.

パラメータ:

to - target vector

戻り値:

TransferPair