org.apache.arrow.vector

Class VarBinaryVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseDataValueVector

org.apache.arrow.vector.VarBinaryVector

All Implemented Interfaces:

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

public final class VarBinaryVector
extends BaseDataValueVector
implements VariableWidthVector

VarBinaryVector implements a vector of variable width values. Elements in the vector are accessed by position from the logical start of the vector. A fixed width offsetVector is used to convert an element's position to it's offset from the start of the (0-based) ArrowBuf. Size is inferred by adjacent elements. The width of each element is 4 byte(s) The equivalent Java primitive is 'int' NB: this class is automatically generated from VariableLengthVectors.java and ValueVectorTypes.tdd using FreeMarker.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	VarBinaryVector.Accessor
class	VarBinaryVector.Mutator MutableVarBinary implements a vector of variable width values.

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

BaseValueVector.BaseAccessor, BaseValueVector.BaseMutator

Nested classes/interfaces inherited from interface org.apache.arrow.vector.VariableWidthVector

VariableWidthVector.VariableWidthAccessor, VariableWidthVector.VariableWidthMutator

Field Summary

Fields

Modifier and Type	Field and Description
static String	OFFSETS_VECTOR_NAME

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

Method Summary

Methods

Modifier and Type	Method and Description
void	allocateNew() Allocate new buffers.
void	allocateNew(int totalBytes, 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.
protected void	copyFrom(int fromIndex, int thisIndex, VarBinaryVector from)
boolean	copyFromSafe(int fromIndex, int thisIndex, VarBinaryVector from)
void	decrementAllocationMonitor()
VarBinaryVector.Accessor	getAccessor() Returns an accessor that is used to read from this vector instance.
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.
int	getByteCapacity() Provide the maximum amount of variable width bytes that can be stored in this vector.
int	getCurrentSizeInBytes()
Field	getField() Get information about how this field is materialized.
Types.MinorType	getMinorType()
VarBinaryVector.Mutator	getMutator() Returns an mutator that is used to write to this vector instance.
long	getOffsetAddr()
UInt4Vector	getOffsetVector()
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.
int	getVarByteLength() Return the number of bytes contained in the current var len byte vector.
TransferPair	makeTransferPair(ValueVector to) Returns a new transfer pair that is used to transfer underlying buffers into the target vector.
void	reAlloc()
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, VarBinaryVector target)
void	transferTo(VarBinaryVector target)

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

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

close, getAllocator

Methods inherited from interface java.lang.Iterable

iterator

Field Detail

OFFSETS_VECTOR_NAME

public static final String OFFSETS_VECTOR_NAME

See Also:

Constant Field Values

Constructor Detail

VarBinaryVector

public VarBinaryVector(String name,
               BufferAllocator allocator)

Method Detail

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

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

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

getByteCapacity

public int getByteCapacity()

Description copied from interface: VariableWidthVector

Provide the maximum amount of variable width bytes that can be stored in this vector.

Specified by:

getByteCapacity in interface VariableWidthVector

Returns:

getCurrentSizeInBytes

public int getCurrentSizeInBytes()

Specified by:

getCurrentSizeInBytes in interface VariableWidthVector

getVarByteLength

public int getVarByteLength()

Return the number of bytes contained in the current var len byte vector.

Returns:

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

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.

getOffsetAddr

public long getOffsetAddr()

getOffsetVector

public UInt4Vector getOffsetVector()

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

splitAndTransferTo

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

copyFrom

protected void copyFrom(int fromIndex,
            int thisIndex,
            VarBinaryVector from)

copyFromSafe

public boolean copyFromSafe(int fromIndex,
                   int thisIndex,
                   VarBinaryVector from)

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 totalBytes,
               int valueCount)

Description copied from interface: VariableWidthVector

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

Specified by:

allocateNew in interface VariableWidthVector

Parameters:

totalBytes - Desired size of the underlying data buffer.

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

reAlloc

public void reAlloc()

decrementAllocationMonitor

public void decrementAllocationMonitor()

getAccessor

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

Specified by:

getAccessor in interface VariableWidthVector

getMutator

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

Specified by:

getMutator in interface VariableWidthVector