org.apache.arrow.vector

Class UInt1Vector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseFixedWidthVector

org.apache.arrow.vector.UInt1Vector

All Implemented Interfaces:

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

public class UInt1Vector
extends BaseFixedWidthVector

UInt1Vector implements a fixed width (1 bytes) vector 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 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
UInt1Vector(String name, BufferAllocator allocator)
UInt1Vector(String name, FieldType fieldType, BufferAllocator allocator)

Method Summary

Modifier and Type	Method and Description
void	copyFrom(int fromIndex, int thisIndex, UInt1Vector from)
void	copyFromSafe(int fromIndex, int thisIndex, UInt1Vector from)
byte	get(int index) Get the element at the given index from the vector.
void	get(int index, NullableUInt1Holder holder) Get the element at the given index from the vector and sets the state in holder.
Types.MinorType	getMinorType()
Byte	getObject(int index) Same as get(int).
FieldReader	getReader()
TransferPair	getTransferPair(String ref, BufferAllocator allocator) * vector transfer * *
TransferPair	makeTransferPair(ValueVector to) makes a new transfer pair used to transfer underlying buffers
void	set(int index, byte value) Set the element at the given index to the given value.
void	set(int index, int value) Set the element at the given index to the given value.
void	set(int index, int isSet, byte value)
void	set(int index, NullableUInt1Holder holder) Set the element at the given index to the value set in data holder.
void	set(int index, UInt1Holder 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, byte value) Same as set(int, byte) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, int value) Same as set(int, int) 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, byte value)
void	setSafe(int index, NullableUInt1Holder holder) Same as set(int, NullableUInt1Holder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, UInt1Holder holder) Same as set(int, UInt1Holder) 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

Constructor Detail

UInt1Vector

public UInt1Vector(String name,
                   BufferAllocator allocator)

UInt1Vector

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

Method Detail

getReader

public FieldReader getReader()

Returns:

a field reader that supports reading values from this vector.

getMinorType

public Types.MinorType getMinorType()

get

public byte 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,
                NullableUInt1Holder 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 Byte 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,
                     UInt1Vector from)

copyFromSafe

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

set

public void set(int index,
                int 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,
                byte 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,
                NullableUInt1Holder 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,
                UInt1Holder 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,
                    int value)

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

Same as set(int, byte) 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,
                    NullableUInt1Holder holder)
             throws IllegalArgumentException

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

Same as set(int, UInt1Holder) 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,
                byte value)

setSafe

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

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)

* vector transfer * *

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)

Description copied from interface: ValueVector

makes a new transfer pair used to transfer underlying buffers

Parameters:

to - the target for the transfer

Returns:

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