org.apache.arrow.vector

Class BitVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseDataValueVector

org.apache.arrow.vector.BitVector

All Implemented Interfaces:

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

public final class BitVector
extends BaseDataValueVector
implements FixedWidthVector

Bit implements a vector of bit-width values. Elements in the vector are accessed by position from the logical start of the vector. The width of each element is 1 bit. The equivalent Java primitive is an int containing the value '0' or '1'.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BitVector.Accessor
class	BitVector.Mutator MutableBit implements a vector of bit-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

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
BitVector(String name, BufferAllocator allocator)

Method Summary

Modifier and Type	Method and Description
void	allocateNew() Allocate new buffers.
void	allocateNew(int valueCount) Allocate a new memory space for this vector.
boolean	allocateNewSafe() Allocates new buffers.
void	clear() Release the underlying ArrowBuf and reset the ValueVector to empty.
void	copyFrom(int inIndex, int outIndex, BitVector from)
void	copyFromSafe(int inIndex, int outIndex, BitVector from)
BitVector.Accessor	getAccessor()
int	getBufferSize()
int	getBufferSizeFor(int valueCount) Returns the number of bytes that is used by this vector if it holds the given number of values.
ArrowBuf	getDataBuffer() Gets the underlying buffer associated with data vector
Field	getField() Get information about how this field is materialized.
Types.MinorType	getMinorType()
BitVector.Mutator	getMutator()
ArrowBuf	getOffsetBuffer() Gets the underlying buffer associated with offset vector
FieldReader	getReader()
TransferPair	getTransferPair(BufferAllocator allocator) to transfer quota responsibility
TransferPair	getTransferPair(String ref, BufferAllocator allocator)
ArrowBuf	getValidityBuffer() Gets the underlying buffer associated with validity vector
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
void	load(ArrowFieldNode fieldNode, ArrowBuf data)
TransferPair	makeTransferPair(ValueVector to) makes a new transfer pair used to transfer underlying buffers
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, BitVector target)
void	transferTo(BitVector target)
void	zeroVector() Zero out the underlying buffer backing this vector.

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

getBuffer, getBuffers, getTransferPair, load, truncateBufferBasedOnSize, unLoad, unload

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

checkBufRefs, close, 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

close, getAllocator, getBuffers, getTransferPair

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

BitVector

public BitVector(String name,
                 BufferAllocator allocator)

Method Detail

load

public void load(ArrowFieldNode fieldNode,
                 ArrowBuf data)

Specified by:

load in interface BufferBacked

Overrides:

load in class BaseDataValueVector

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Specified by:

getField in interface ValueVector

Returns:

the field corresponding to this vector

getMinorType

public Types.MinorType getMinorType()

Specified by:

getMinorType in interface ValueVector

getReader

public FieldReader getReader()

Specified by:

getReader in interface ValueVector

Returns:

a field reader that supports reading values from this vector.

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ValueVector

Overrides:

getBufferSize in class BaseDataValueVector

Returns:

the number of bytes that is used by this vector instance.

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

getValidityBuffer

public ArrowBuf getValidityBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with validity vector

Specified by:

getValidityBuffer in interface ValueVector

Returns:

buffer

getDataBuffer

public ArrowBuf getDataBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with data vector

Specified by:

getDataBuffer in interface ValueVector

Returns:

buffer

getOffsetBuffer

public ArrowBuf getOffsetBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with offset vector

Specified by:

getOffsetBuffer in interface ValueVector

Returns:

buffer

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

Returns:

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

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.

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

allocateNew

public void allocateNew(int valueCount)

Allocate a new memory space for this vector. Must be called prior to using the ValueVector.

Specified by:

allocateNew in interface FixedWidthVector

Parameters:

valueCount - The number of values which can be contained within this vector.

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

Specified by:

reAlloc in interface ValueVector

zeroVector

public void zeroVector()

Zero out the underlying buffer backing this vector.

Specified by:

zeroVector in interface FixedWidthVector

copyFrom

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

copyFromSafe

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

getMutator

public BitVector.Mutator getMutator()

Specified by:

getMutator in interface ValueVector

Returns:

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

getAccessor

public BitVector.Accessor getAccessor()

Specified by:

getAccessor in interface ValueVector

Returns:

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

getTransferPair

public TransferPair getTransferPair(BufferAllocator allocator)

Description copied from interface: ValueVector

to transfer quota responsibility

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class BaseValueVector

Parameters:

allocator - the target allocator

Returns:

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

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

makes a new transfer pair used to transfer underlying buffers

Specified by:

makeTransferPair in interface ValueVector

Parameters:

to - the target for the transfer

Returns:

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

transferTo

public void transferTo(BitVector target)

splitAndTransferTo

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

clear

public void clear()

Description copied from interface: ValueVector

Release the underlying ArrowBuf and reset the ValueVector to empty.

Specified by:

clear in interface ValueVector

Overrides:

clear in class BaseDataValueVector