org.apache.arrow.vector

Class BigIntVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseFixedWidthVector

org.apache.arrow.vector.BigIntVector

All Implemented Interfaces:

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

public class BigIntVector
extends BaseFixedWidthVector

BigIntVector implements a fixed width vector (8 bytes) of integer 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 and Description
static byte	TYPE_WIDTH

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

field, validityAllocationSizeInBytes, validityBuffer, valueAllocationSizeInBytes, valueBuffer, valueCount

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

allocator, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY, name

Constructor Summary

Constructors

Constructor and Description
BigIntVector(String name, BufferAllocator allocator) Instantiate a BigIntVector.
BigIntVector(String name, FieldType fieldType, BufferAllocator allocator) Instantiate a BigIntVector.

Method Summary

Modifier and Type	Method and Description
void	copyFrom(int fromIndex, int thisIndex, BigIntVector 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, BigIntVector from) Same as copyFrom(int, int, BigIntVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.
static long	get(ArrowBuf buffer, int index) Given a data buffer, get the value stored at a particular position in the vector.
long	get(int index) Get the element at the given index from the vector.
void	get(int index, NullableBigIntHolder 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.
Long	getObject(int index) Same as get(int).
FieldReader	getReader() Get a reader that supports reading values from this vector
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, BigIntHolder holder) Set the element at the given index to the value set in data holder.
void	set(int index, int isSet, long value) 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, NullableBigIntHolder holder) Set the element at the given index to the value set in data holder.
void	setNull(int index) Set the element at the given index to null.
void	setSafe(int index, BigIntHolder holder) Same as set(int, BigIntHolder) 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, long value) Same as set(int, int, long) except that it handles the case when index is greater than or equal to 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, NullableBigIntHolder holder) Same as set(int, NullableBigIntHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().

Methods inherited from class 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

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

checkBufRefs, compareTypes, getAllocator, getValidityBufferSizeFromCount, iterator, releaseBuffer, toString

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.ValueVector

getAllocator

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

TYPE_WIDTH

public static final byte TYPE_WIDTH

See Also:

Constant Field Values

Constructor Detail

BigIntVector

public BigIntVector(String name,
                    BufferAllocator allocator)

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

Parameters:

name - name of the vector

allocator - allocator for memory management.

BigIntVector

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

Instantiate a BigIntVector. 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.

Method Detail

getReader

public FieldReader getReader()

Get a reader that supports reading values from this vector

Returns:

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.

Returns:

Types.MinorType

get

public long 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,
                NullableBigIntHolder 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 Long getObject(int index)

Same as get(int).

Parameters:

index - position of element

Returns:

element at given index

copyFrom

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

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

Parameters:

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,
                         BigIntVector from)

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

Parameters:

fromIndex - position to copy from in source vector

thisIndex - position to copy to in this vector

from - source vector

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 - value of element

set

public void set(int index,
                NullableBigIntHolder 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,
                BigIntHolder 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,
                    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 - value of element

setSafe

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

Same as set(int, NullableBigIntHolder) 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,
                    BigIntHolder holder)

Same as set(int, BigIntHolder) 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

setNull

public void setNull(int index)

Set the element at the given index to null.

Parameters:

index - position of element

set

public void set(int index,
                int isSet,
                long value)

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

value - element value

setSafe

public void setSafe(int index,
                    int isSet,
                    long value)

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

Parameters:

index - position of the new value

isSet - 0 for NULL value, 1 otherwise

value - element value

get

public static long get(ArrowBuf buffer,
                       int index)

Given a data buffer, get the value stored at a particular position in the vector. This method should not be used externally.

Parameters:

buffer - data buffer

index - position of the element.

Returns:

value stored at the index.

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)

Construct a TransferPair comprising of this and 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

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

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

Parameters:

to - target vector

Returns:

TransferPair