org.apache.arrow.vector

Class BigIntVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseDataValueVector

org.apache.arrow.vector.BigIntVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, BufferBacked, FixedWidthVector, ValueVector

public final class BigIntVector
extends BaseDataValueVector
implements FixedWidthVector

BigInt implements a vector of fixed width values. Elements in the vector are accessed by position, starting from the logical start of the vector. Values should be pushed onto the vector sequentially, but may be randomly accessed. The width of each element is 8 byte(s) The equivalent Java primitive is 'long' NB: this class is automatically generated from FixedValueVectors.java and ValueVectorTypes.tdd using FreeMarker.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BigIntVector.Accessor
class	BigIntVector.Mutator BigInt.Mutator implements a mutable vector of fixed width values.

Nested classes/interfaces inherited from class org.apache.arrow.vector.BaseValueVector

BaseValueVector.BaseAccessor, BaseValueVector.BaseMutator

Field Summary

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

data, emptyByteArray

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)

Method Summary

Methods

Modifier and Type	Method and Description
void	allocateNew() Allocate new buffers.
void	allocateNew(int valueCount) Allocate a new buffer that supports setting at least the provided number of values.
boolean	allocateNewSafe() Allocates new buffers.
void	copyFrom(int fromIndex, int thisIndex, BigIntVector from)
void	copyFromSafe(int fromIndex, int thisIndex, BigIntVector from)
void	decrementAllocationMonitor()
BigIntVector.Accessor	getAccessor() Returns an accessor that is used to read from this vector instance.
int	getBufferSizeFor(int valueCount) Returns the number of bytes that is used by this vector if it holds the given number of values.
Field	getField() Get information about how this field is materialized.
Types.MinorType	getMinorType()
BigIntVector.Mutator	getMutator() Returns an mutator that is used to write to this vector instance.
FieldReader	getReader() Returns a field reader that supports reading values from this vector.
TransferPair	getTransferPair(BufferAllocator allocator) Returns a transfer pair, creating a new target vector of the same type.
TransferPair	getTransferPair(String ref, BufferAllocator allocator)
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
TransferPair	makeTransferPair(ValueVector to) Returns a new transfer pair that is used to transfer underlying buffers into the target vector.
void	reAlloc() Allocate new buffer with double capacity, and copy data into the new buffer.
void	reset() This method has a similar effect of allocateNew() without actually clearing and reallocating the value vector.
void	setInitialCapacity(int valueCount) Set the initial record capacity
void	splitAndTransferTo(int startIndex, int length, BigIntVector target)
void	transferTo(BigIntVector target)
void	zeroVector() Zero out the underlying buffer backing this vector.

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

clear, close, getBuffer, getBuffers, getBufferSize, load, load, unLoad, unload

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

checkBufRefs, getAllocator, iterator, 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

clear, close, getAllocator, getBuffers, getBufferSize

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

BigIntVector

public BigIntVector(String name,
            BufferAllocator allocator)

Method Detail

getMinorType

public Types.MinorType getMinorType()

Specified by:

getMinorType in interface ValueVector

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Specified by:

getField in interface ValueVector

getReader

public FieldReader getReader()

Description copied from interface: ValueVector

Returns a field reader that supports reading values from this vector.

Specified by:

getReader in interface ValueVector

getBufferSizeFor

public int getBufferSizeFor(int valueCount)

Description copied from interface: ValueVector

Returns the number of bytes that is used by this vector if it holds the given number of values. The result will be the same as if Mutator.setValueCount() were called, followed by calling getBufferSize(), but without any of the closing side-effects that setValueCount() implies wrt finishing off the population of a vector. Some operations might wish to use this to determine how much memory has been used by a vector so far, even though it is not finished being populated.

Specified by:

getBufferSizeFor in interface ValueVector

Parameters:

valueCount - the number of values to assume this vector contains

Returns:

the buffer size if this vector is holding valueCount values

getValueCapacity

public int getValueCapacity()

Description copied from interface: ValueVector

Returns the maximum number of values that can be stored in this vector instance.

Specified by:

getValueCapacity in interface ValueVector

getAccessor

public BigIntVector.Accessor getAccessor()

Description copied from interface: ValueVector

Returns an accessor that is used to read from this vector instance.

Specified by:

getAccessor in interface ValueVector

getMutator

public BigIntVector.Mutator getMutator()

Description copied from interface: ValueVector

Returns an mutator that is used to write to this vector instance.

Specified by:

getMutator in interface ValueVector

setInitialCapacity

public void setInitialCapacity(int valueCount)

Description copied from interface: ValueVector

Set the initial record capacity

Specified by:

setInitialCapacity in interface ValueVector

Parameters:

valueCount - the initial record capacity.

allocateNew

public void allocateNew()

Description copied from interface: ValueVector

Allocate new buffers. ValueVector implements logic to determine how much to allocate.

Specified by:

allocateNew in interface ValueVector

allocateNewSafe

public boolean allocateNewSafe()

Description copied from interface: ValueVector

Allocates new buffers. ValueVector implements logic to determine how much to allocate.

Specified by:

allocateNewSafe in interface ValueVector

Returns:

Returns true if allocation was successful.

allocateNew

public void allocateNew(int valueCount)

Allocate a new buffer that supports setting at least the provided number of values. May actually be sized bigger depending on underlying buffer rounding size. Must be called prior to using the ValueVector. Note that the maximum number of values a vector can allocate is Integer.MAX_VALUE / value width.

Specified by:

allocateNew in interface FixedWidthVector

Parameters:

valueCount -

Throws:

OutOfMemoryException - if it can't allocate the new buffer

reset

public void reset()

Description copied from class: BaseDataValueVector

This method has a similar effect of allocateNew() without actually clearing and reallocating the value vector. The purpose is to move the value vector to a "mutate" state

Overrides:

reset in class BaseDataValueVector

reAlloc

public void reAlloc()

Allocate new buffer with double capacity, and copy data into the new buffer. Replace vector's buffer with new buffer, and release old one

Throws:

OutOfMemoryException - if it can't allocate the new buffer

zeroVector

public void zeroVector()

Zero out the underlying buffer backing this vector.

Specified by:

zeroVector in interface FixedWidthVector

getTransferPair

public TransferPair getTransferPair(BufferAllocator allocator)

Description copied from interface: ValueVector

Returns a transfer pair, creating a new target vector of the same type.

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class BaseValueVector

getTransferPair

public TransferPair getTransferPair(String ref,
                           BufferAllocator allocator)

Specified by:

getTransferPair in interface ValueVector

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

Description copied from interface: ValueVector

Returns a new transfer pair that is used to transfer underlying buffers into the target vector.

Specified by:

makeTransferPair in interface ValueVector

transferTo

public void transferTo(BigIntVector target)

splitAndTransferTo

public void splitAndTransferTo(int startIndex,
                      int length,
                      BigIntVector target)

copyFrom

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

copyFromSafe

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

decrementAllocationMonitor

public void decrementAllocationMonitor()