Package org.apache.arrow.vector

Class DecimalVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseFixedWidthVector

org.apache.arrow.vector.DecimalVector

All Implemented Interfaces:

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

public final 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.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_PRECISION
static final byte	TYPE_WIDTH

Fields inherited from class org.apache.arrow.vector.BaseFixedWidthVector

actualValueCapacity, field, lastValueCapacity, validityBuffer, valueBuffer, valueCount

Fields inherited from class org.apache.arrow.vector.BaseValueVector

allocator, fieldReader, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
DecimalVector(String name, BufferAllocator allocator, int precision, int scale)	Instantiate a DecimalVector.
DecimalVector(String name, FieldType fieldType, BufferAllocator allocator)	Instantiate a DecimalVector.
DecimalVector(Field field, BufferAllocator allocator)	Instantiate a DecimalVector.

Method Summary

Modifier and Type	Method	Description
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).
BigDecimal	getObjectNotNull(int index)	Same as getObject(int) but does not check for null.
int	getPrecision()	Return precision for the decimal value.
protected FieldReader	getReaderImpl()	Each vector has a different reader that implements the FieldReader interface.
int	getScale()	Return scale for the decimal value.
TransferPair	getTransferPair(String ref, BufferAllocator allocator)	Construct a TransferPair comprising this and a target vector of the same type.
TransferPair	getTransferPair(Field field, BufferAllocator allocator)	Construct a TransferPair comprising this 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, int isSet, long start, ArrowBuf buffer)	Store the given value at a particular position in the vector.
void	set(int index, long value)	Set the element at the given index to the given value.
void	set(int index, long start, 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, ArrowBuf buffer)	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, 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	setBigEndianSafe(int index, long start, ArrowBuf buffer, int length)	Sets the element at given index using the buffer whose size maybe <= 16 bytes.
void	setSafe(int index, int isSet, long start, ArrowBuf buffer)	Same as set(int, int, long, 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, long value)	Same as set(int, long) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, long start, ArrowBuf buffer)	Same as set(int, long, ArrowBuf) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, long start, ArrowBuf buffer, int length)	Sets the element at given index using the buffer whose size maybe <= 16 bytes.
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, 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, 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, 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().
void	validateScalars()	Validate the scalar values held by this vector.

Methods inherited from class org.apache.arrow.vector.BaseFixedWidthVector

accept, allocateNew, allocateNew, allocateNewSafe, clear, close, copyFrom, copyFromSafe, decrementAllocationMonitor, getBuffers, getBufferSize, getBufferSizeFor, getChildrenFromFields, getDataBuffer, getDataBufferAddress, getDataPointer, getDataPointer, getField, getFieldBuffers, getFieldInnerVectors, getName, getNullCount, getOffsetBuffer, getOffsetBufferAddress, getTransferPair, getTransferPair, getTransferPair, getTypeWidth, getValidityBuffer, getValidityBufferAddress, getValidityBufferValueCapacity, getValueBufferValueCapacity, getValueCapacity, getValueCount, handleSafe, hashCode, hashCode, incrementAllocationMonitor, initializeChildrenFromFields, isNull, isSafe, isSet, loadFieldBuffers, reAlloc, refreshValueCapacity, reset, set, set, setIndexDefined, setInitialCapacity, setNull, setSafe, setSafe, setValueCount, splitAndTransferTo, transferTo, zeroVector

Methods inherited from class org.apache.arrow.vector.BaseValueVector

checkBufRefs, getAllocator, getReader, getValidityBufferSizeFromCount, iterator, releaseBuffer, toString, transferBuffer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.arrow.vector.FieldVector

exportBuffer, exportCDataBuffers

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.apache.arrow.vector.ValueVector

getAllocator, getReader, validate, validateFull

Field Details

MAX_PRECISION

public static final int MAX_PRECISION

See Also:

• Constant Field Values

TYPE_WIDTH

public static final byte TYPE_WIDTH

See Also:

• Constant Field Values

Constructor Details

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.

Parameters:

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.

Parameters:

name - name of the vector

fieldType - type of Field materialized by this vector

allocator - allocator for memory management.

DecimalVector

public DecimalVector(Field field,
 BufferAllocator allocator)

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

Parameters:

field - field materialized by this vector

allocator - allocator for memory management.

Method Details

getReaderImpl

protected FieldReader getReaderImpl()

Description copied from class: BaseValueVector

Each vector has a different reader that implements the FieldReader interface. Overridden methods must make sure to return the correct concrete reader implementation.

Specified by:

getReaderImpl in class BaseValueVector

Returns:

Returns a lambda that initializes a reader when called.

getMinorType

public Types.MinorType getMinorType()

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

Returns:

Types.MinorType

get

public ArrowBuf get(int index)
             throws IllegalStateException

Get the element at the given index from the vector.

Parameters:

index - position of element

Returns:

element at given index

Throws:

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.

Parameters:

index - position of element

getObject

public BigDecimal getObject(int index)

Same as get(int).

Parameters:

index - position of element

Returns:

element at given index

getObjectNotNull

public BigDecimal getObjectNotNull(int index)

Same as getObject(int) but does not check for null.

Parameters:

index - position of element

Returns:

element at given index

getPrecision

public int getPrecision()

Return precision for the decimal value.

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.

Parameters:

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 Native 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 than 16 (length of decimal type).

Parameters:

index - position of element

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

set

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

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

Parameters:

index - position of element

start - start index of data in the buffer

buffer - ArrowBuf containing decimal value.

setSafe

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

Sets the element at given index using the buffer whose size maybe <= 16 bytes.

Parameters:

index - index to write the decimal to

start - start of value in the buffer

buffer - contains the decimal in native endian bytes

length - length of the value in the buffer

setBigEndianSafe

public void setBigEndianSafe(int index,
 long start,
 ArrowBuf buffer,
 int length)

Sets the element at given index using the buffer whose size maybe <= 16 bytes.

Parameters:

index - index to write the decimal to

start - start of value in the buffer

buffer - contains the decimal in big endian bytes

length - length of the value in the buffer

set

public void set(int index,
 BigDecimal value)

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

Parameters:

index - position of element

value - BigDecimal containing decimal value.

set

public void set(int index,
 long value)

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

Parameters:

index - position of element

value - long 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.

Parameters:

index - position of element

holder - nullable data holder for value of element

Throws:

IllegalArgumentException

set

public void set(int index,
 DecimalHolder holder)

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

Parameters:

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().

Parameters:

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,
 long start,
 ArrowBuf buffer)

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

Parameters:

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().

Parameters:

index - position of element

value - BigDecimal containing decimal value.

setSafe

public void setSafe(int index,
 long value)

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

Parameters:

index - position of element

value - long 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().

Parameters:

index - position of element

holder - nullable data holder for value of element

Throws:

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().

Parameters:

index - position of element

holder - data holder for value of element

set

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

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

Parameters:

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,
 long start,
 ArrowBuf buffer)

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

Parameters:

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

validateScalars

public void validateScalars()

Description copied from class: BaseFixedWidthVector

Validate the scalar values held by this vector.

Overrides:

validateScalars in class BaseFixedWidthVector

getTransferPair

public TransferPair getTransferPair(String ref,
 BufferAllocator allocator)

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

Specified by:

getTransferPair in interface ValueVector

Specified by:

getTransferPair in class BaseFixedWidthVector

Parameters:

ref - name of the target vector

allocator - allocator for the target vector

Returns:

TransferPair

getTransferPair

public TransferPair getTransferPair(Field field,
 BufferAllocator allocator)

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

Specified by:

getTransferPair in interface ValueVector

Specified by:

getTransferPair in class BaseFixedWidthVector

Parameters:

field - Field object used by the target vector

allocator - allocator for the target vector

Returns:

TransferPair

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

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

Parameters:

to - target vector

Returns:

TransferPair