org.apache.arrow.vector

Class SmallIntVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseFixedWidthVector

org.apache.arrow.vector.SmallIntVector

All Implemented Interfaces:

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

public final class SmallIntVector
extends BaseFixedWidthVector
implements BaseIntVector

SmallIntVector implements a fixed width (2 bytes) vector of short values which could be null. A validity buffer (bit vector) is maintained to track which elements in the vector are null.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE_WIDTH

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

actualValueCapacity, field, lastValueCapacity, validityBuffer, valueBuffer, valueCount

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

allocator, fieldReader, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE, MAX_ALLOCATION_SIZE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SmallIntVector(Field field, BufferAllocator allocator) Instantiate a SmallIntVector.
SmallIntVector(String name, BufferAllocator allocator) Instantiate a SmallIntVector.
SmallIntVector(String name, FieldType fieldType, BufferAllocator allocator) Instantiate a SmallIntVector.

Method Summary

Modifier and Type	Method and Description
static short	get(ArrowBuf buffer, int index) Given a data buffer, get the value stored at a particular position in the vector.
short	get(int index) Get the element at the given index from the vector.
void	get(int index, NullableSmallIntHolder holder) Get the element at the given index from the vector and sets the state in holder.
Types.MinorType	getMinorType() Get minor type for this vector.
Short	getObject(int index) Same as get(int).
protected FieldReader	getReaderImpl() Each vector has a different reader that implements the FieldReader interface.
TransferPair	getTransferPair(Field field, BufferAllocator allocator) Construct a TransferPair comprising this and a target vector of the same type.
TransferPair	getTransferPair(String ref, BufferAllocator allocator) Construct a TransferPair comprising this and a target vector of the same type.
long	getValueAsLong(int index) Gets the value at index.
TransferPair	makeTransferPair(ValueVector to) Construct a TransferPair with a desired target vector of the same type.
void	set(int index, int value) Set the element at the given index to the given value.
void	set(int index, int isSet, short value) Store the given value at a particular position in the vector.
void	set(int index, NullableSmallIntHolder holder) Set the element at the given index to the value set in data holder.
void	set(int index, short value) Set the element at the given index to the given value.
void	set(int index, SmallIntHolder holder) Set the element at the given index to the value set in data holder.
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, short value) Same as set(int, int, short) except that it handles the case when index is greater than or equal to current value capacity of the vector.
void	setSafe(int index, NullableSmallIntHolder holder) Same as set(int, NullableSmallIntHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, short value) Same as set(int, short) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, SmallIntHolder holder) Same as set(int, SmallIntHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setUnsafeWithPossibleTruncate(int index, long value) Sets the value at index, note this value may need to be truncated.
void	setWithPossibleTruncate(int index, long value) Sets the value at index, note this value may need to be truncated.

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

accept, allocateNew, allocateNew, allocateNewSafe, clear, close, copyFrom, copyFromSafe, decrementAllocationMonitor, getBuffers, getBufferSize, getBufferSizeFor, getChildrenFromFields, getDataBuffer, getDataBufferAddress, getDataPointer, getDataPointer, getField, getFieldBuffers, getFieldInnerVectors, getName, getNullCount, getOffsetBuffer, getOffsetBufferAddress, getTransferPair, getTransferPair, getTransferPair, getTypeWidth, getValidityBuffer, getValidityBufferAddress, getValidityBufferValueCapacity, getValueBufferValueCapacity, getValueCapacity, getValueCount, handleSafe, hashCode, hashCode, incrementAllocationMonitor, initializeChildrenFromFields, isNull, isSafe, isSet, loadFieldBuffers, reAlloc, refreshValueCapacity, reset, set, set, setIndexDefined, setInitialCapacity, setNull, setSafe, setSafe, setValueCount, splitAndTransferTo, transferTo, validateScalars, zeroVector

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

checkBufRefs, getAllocator, getReader, getValidityBufferSizeFromCount, iterator, releaseBuffer, toString, transferBuffer

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.FieldVector

exportBuffer, exportCDataBuffers, getChildrenFromFields, getDataBufferAddress, getFieldBuffers, getFieldInnerVectors, getOffsetBufferAddress, getValidityBufferAddress, initializeChildrenFromFields, loadFieldBuffers, setNull

Methods inherited from interface org.apache.arrow.vector.ValueVector

accept, allocateNew, allocateNewSafe, clear, close, copyFrom, copyFromSafe, getAllocator, getBuffers, getBufferSize, getBufferSizeFor, getDataBuffer, getField, getName, getNullCount, getOffsetBuffer, getReader, getTransferPair, getTransferPair, getTransferPair, getValidityBuffer, getValueCapacity, getValueCount, hashCode, hashCode, isNull, reAlloc, reset, setInitialCapacity, setValueCount, validate, validateFull

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

TYPE_WIDTH

public static final byte TYPE_WIDTH

See Also:

Constant Field Values

Constructor Detail

SmallIntVector

public SmallIntVector(String name,
                      BufferAllocator allocator)

Instantiate a SmallIntVector. This doesn't allocate any memory for the data in vector.

Parameters:

name - name of the vector

allocator - allocator for memory management.

SmallIntVector

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

Instantiate a SmallIntVector. This doesn't allocate any memory for the data in vector.

Parameters:

name - name of the vector

fieldType - type of Field materialized by this vector

allocator - allocator for memory management.

SmallIntVector

public SmallIntVector(Field field,
                      BufferAllocator allocator)

Instantiate a SmallIntVector. This doesn't allocate any memory for the data in vector.

Parameters:

field - field materialized by this vector

allocator - allocator for memory management.

Method Detail

getReaderImpl

protected FieldReader getReaderImpl()

Description copied from class: BaseValueVector

Each vector has a different reader that implements the FieldReader interface. Overridden methods must make sure to return the correct concrete reader implementation.

Specified by:

getReaderImpl in class BaseValueVector

Returns:

Returns a lambda that initializes a reader when called.

getMinorType

public Types.MinorType getMinorType()

Get minor type for this vector. The vector holds values belonging to a particular type.

Specified by:

getMinorType in interface ValueVector

Returns:

Types.MinorType

get

public short 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,
                NullableSmallIntHolder 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 Short getObject(int index)

Same as get(int).

Specified by:

getObject in interface ValueVector

Parameters:

index - position of element

Returns:

element at given index

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,
                short 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,
                NullableSmallIntHolder 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,
                SmallIntHolder 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,
                    short value)

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

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

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

set

public void set(int index,
                int isSet,
                short value)

Store the given value at a particular position in the vector. isSet indicates whether the value is NULL or not.

Parameters:

index - position of the new value

isSet - 0 for NULL value, 1 otherwise

value - element value

setSafe

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

Same as set(int, int, short) except that it handles the case when index is greater than or equal to current value capacity of the vector.

Parameters:

index - position of the new value

isSet - 0 for NULL value, 1 otherwise

value - element value

get

public static short get(ArrowBuf buffer,
                        int index)

Given a data buffer, get the value stored at a particular position in the vector.

This method should not be used externally.

Parameters:

buffer - data buffer

index - position of the element.

Returns:

value stored at the index.

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)

Construct a TransferPair comprising this and a target vector of the same type.

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

getTransferPair

public TransferPair getTransferPair(Field field,
                                    BufferAllocator allocator)

Construct a TransferPair comprising this and a target vector of the same type.

Specified by:

getTransferPair in interface ValueVector

Specified by:

getTransferPair in class BaseFixedWidthVector

Parameters:

field - Field object used by the target vector

allocator - allocator for the target vector

Returns:

TransferPair

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

Construct a TransferPair with a desired target vector of the same type.

Specified by:

makeTransferPair in interface ValueVector

Parameters:

to - target vector

Returns:

TransferPair

setWithPossibleTruncate

public void setWithPossibleTruncate(int index,
                                    long value)

Description copied from interface: BaseIntVector

Sets the value at index, note this value may need to be truncated. Note this is safe version (i.e. call setSafe(int, ...) method in vector)

Specified by:

setWithPossibleTruncate in interface BaseIntVector

setUnsafeWithPossibleTruncate

public void setUnsafeWithPossibleTruncate(int index,
                                          long value)

Description copied from interface: BaseIntVector

Sets the value at index, note this value may need to be truncated. Note this is unsafe version (i.e. call set(int, ...) method in vector)

Specified by:

setUnsafeWithPossibleTruncate in interface BaseIntVector

getValueAsLong

public long getValueAsLong(int index)

Description copied from interface: BaseIntVector

Gets the value at index. This value may have been extended to long and will throw NullPointerException if the value is null. Note null check could be turned off via NullCheckingForGet.

Specified by:

getValueAsLong in interface BaseIntVector