org.apache.arrow.vector

Class NullableUInt4Vector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseDataValueVector

org.apache.arrow.vector.NullableUInt4Vector

All Implemented Interfaces:

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

public final class NullableUInt4Vector
extends BaseDataValueVector
implements FixedWidthVector, NullableVector, FieldVector

NullableUInt4 implements a vector of values which could be null. Elements in the vector are first checked against a fixed length vector of boolean values. Then the element is retrieved from the base class (if not null). NB: this class is automatically generated from NullableValueVectors.java and ValueVectorTypes.tdd using FreeMarker.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NullableUInt4Vector.Accessor
class	NullableUInt4Vector.Mutator

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
NullableUInt4Vector(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 memory space for this vector.
boolean	allocateNewSafe() Allocates new buffers.
void	clear() Release the underlying ArrowBuf and reset the ValueVector to empty.
void	close() Alternative to clear().
void	copyFrom(int fromIndex, int thisIndex, NullableUInt4Vector from)
void	copyFromSafe(int fromIndex, int thisIndex, NullableUInt4Vector from)
void	copyFromSafe(int fromIndex, int thisIndex, UInt4Vector from)
NullableUInt4Vector.Accessor	getAccessor() Returns an accessor that is used to read from this vector instance.
ArrowBuf	getBuffer()
ArrowBuf[]	getBuffers(boolean clear) Return the underlying buffers associated with this vector.
int	getBufferSize() Returns the number of bytes that is used by 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.
List<FieldVector>	getChildrenFromFields() the returned list is the same size as the list passed to initializeChildrenFromFields
Field	getField() Get information about how this field is materialized.
List<ArrowBuf>	getFieldBuffers() (same size as getFieldVectors() since it is their content)
List<BufferBacked>	getFieldInnerVectors()
Types.MinorType	getMinorType()
NullableUInt4Vector.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.
UInt4Vector	getValuesVector()
void	initializeChildrenFromFields(List<Field> children) Initializes the child vectors to be later loaded with loadBuffers
void	loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers) loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
TransferPair	makeTransferPair(ValueVector to) Returns a new transfer pair that is used to transfer underlying buffers into the target vector.
void	reset() This method has a similar effect of allocateNew() without actually clearing and reallocating the value vector.
void	setInitialCapacity(int numRecords) Set the initial record capacity
void	splitAndTransferTo(int startIndex, int length, NullableUInt4Vector target)
void	transferTo(NullableUInt4Vector target)
void	zeroVector() Zero out the underlying buffer backing this vector.

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

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

getAllocator

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

NullableUInt4Vector

public NullableUInt4Vector(String name,
                   BufferAllocator allocator)

Method Detail

getFieldInnerVectors

public List<BufferBacked> getFieldInnerVectors()

Specified by:

getFieldInnerVectors in interface FieldVector

Returns:

the inner vectors for this field as defined by the TypeLayout

initializeChildrenFromFields

public void initializeChildrenFromFields(List<Field> children)

Description copied from interface: FieldVector

Initializes the child vectors to be later loaded with loadBuffers

Specified by:

initializeChildrenFromFields in interface FieldVector

Parameters:

children - the schema

getChildrenFromFields

public List<FieldVector> getChildrenFromFields()

Description copied from interface: FieldVector

the returned list is the same size as the list passed to initializeChildrenFromFields

Specified by:

getChildrenFromFields in interface FieldVector

Returns:

the children according to schema (empty for primitive types)

loadFieldBuffers

public void loadFieldBuffers(ArrowFieldNode fieldNode,
                    List<ArrowBuf> ownBuffers)

Description copied from interface: FieldVector

loads data in the vectors (ownBuffers must be the same size as getFieldVectors())

Specified by:

loadFieldBuffers in interface FieldVector

Parameters:

fieldNode - the fieldNode

ownBuffers - the buffers for this Field (own buffers only, children not included)

getFieldBuffers

public List<ArrowBuf> getFieldBuffers()

Description copied from interface: FieldVector

(same size as getFieldVectors() since it is their content)

Specified by:

getFieldBuffers in interface FieldVector

Returns:

the buffers containing the data for this vector (ready for reading)

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Specified by:

getField in interface ValueVector

getMinorType

public Types.MinorType getMinorType()

Specified by:

getMinorType 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

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

getBuffers

public ArrowBuf[] getBuffers(boolean clear)

Description copied from interface: ValueVector

Return the underlying buffers associated with this vector. Note that this doesn't impact the reference counts for this buffer so it only should be used for in-context access. Also note that this buffer changes regularly thus external classes shouldn't hold a reference to it (unless they change it).

Specified by:

getBuffers in interface ValueVector

Overrides:

getBuffers in class BaseDataValueVector

Parameters:

clear - Whether to clear vector before returning; the buffers will still be refcounted; but the returned array will be the only reference to them

Returns:

The underlying buffers that is used by this vector instance.

close

public void close()

Description copied from interface: ValueVector

Alternative to clear(). Allows use as an AutoCloseable in try-with-resources.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ValueVector

Overrides:

close in class BaseDataValueVector

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

getBufferSize

public int getBufferSize()

Description copied from interface: ValueVector

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

Specified by:

getBufferSize in interface ValueVector

Overrides:

getBufferSize in class BaseDataValueVector

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

getBuffer

public ArrowBuf getBuffer()

Overrides:

getBuffer in class BaseDataValueVector

getValuesVector

public UInt4Vector getValuesVector()

Specified by:

getValuesVector in interface NullableVector

setInitialCapacity

public void setInitialCapacity(int numRecords)

Description copied from interface: ValueVector

Set the initial record capacity

Specified by:

setInitialCapacity in interface ValueVector

Parameters:

numRecords - 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)

Description copied from interface: FixedWidthVector

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

Specified by:

allocateNew in interface FixedWidthVector

Parameters:

valueCount - Number of values in the vector.

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

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(NullableUInt4Vector target)

splitAndTransferTo

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

getAccessor

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

copyFrom

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

copyFromSafe

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

copyFromSafe

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