org.apache.drill.exec.vector

Class SmallIntVector

java.lang.Object

org.apache.drill.exec.vector.BaseValueVector

org.apache.drill.exec.vector.BaseDataValueVector

org.apache.drill.exec.vector.SmallIntVector

All Implemented Interfaces:

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

public final class SmallIntVector
extends BaseDataValueVector
implements FixedWidthVector

SmallInt implements a vector of fixed width values. Elements in the vector are accessed by position, starting from the logical start of the vector. Values should be pushed onto the vector sequentially, but may be accessed randomly.

• The width of each element is VALUE_WIDTH (= 2) bytes.
• The equivalent Java primitive is 'short'.

NB: this class is automatically generated from FixedValueVectors.java and ValueVectorTypes.tdd using FreeMarker.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SmallIntVector.Accessor
class	SmallIntVector.Mutator SmallInt.Mutator implements a mutable vector of fixed width values.

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

BaseValueVector.BaseAccessor, BaseValueVector.BaseMutator

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SCALAR_COUNT Maximum number of values that this fixed-width vector can hold and stay below the maximum vector size limit and/or stay below the maximum row count.
static int	MAX_VALUE_COUNT Maximum number of values that this fixed-width vector can hold and stay below the maximum vector size limit.
static int	NET_MAX_SCALAR_SIZE Actual maximum vector size, in bytes, given the number of fixed-width values that either fit in the maximum overall vector size, or that is no larger than the maximum vector item count.
static int	VALUE_WIDTH Width of each fixed-width value.

Fields inherited from class org.apache.drill.exec.vector.BaseDataValueVector

data, emptyByteArray

Fields inherited from class org.apache.drill.exec.vector.BaseValueVector

allocator, field, INITIAL_VALUE_ALLOCATION, MAX_ALLOCATION_SIZE

Fields inherited from interface org.apache.drill.exec.vector.ValueVector

BITS_VECTOR_NAME, MAX_BUFFER_SIZE, MAX_ROW_COUNT, MIN_ROW_COUNT, OFFSETS_VECTOR_NAME, VALUES_VECTOR_NAME

Constructor Summary

Constructors

Constructor and Description
SmallIntVector(MaterializedField field, BufferAllocator allocator)

Method Summary

Modifier and Type	Method and Description
void	allocateNew() Allocate new buffers.
void	allocateNew(int valueCount) Allocate a new buffer that supports setting at least the provided number of values.
boolean	allocateNewSafe() Allocates new buffers.
void	copyEntry(int toIndex, ValueVector from, int fromIndex)
void	copyFrom(int fromIndex, int thisIndex, SmallIntVector from)
void	copyFromSafe(int fromIndex, int thisIndex, SmallIntVector from)
void	decrementAllocationMonitor()
SmallIntVector.Accessor	getAccessor() Returns an accessor that is used to read from 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.
SmallIntVector.Mutator	getMutator() Returns an mutator that is used to write to this vector instance.
int	getPayloadByteCount(int valueCount) Return the number of value bytes consumed by actual data.
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	getValueWidth() The width of a record in bytes.
void	load(UserBitShared.SerializedField metadata, DrillBuf buffer) Load the data provided in the buffer.
TransferPair	makeTransferPair(ValueVector to) Returns a new transfer pair that is used to transfer underlying buffers into the target vector.
void	reAlloc() Allocate new buffer with double capacity, and copy data into the new buffer.
DrillBuf	reallocRaw(int newAllocationSize) Core of vector allocation.
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, SmallIntVector target)
void	toNullable(ValueVector nullableVector) Convert a non-nullable vector to nullable by shuffling the data from one to the other.
void	transferTo(SmallIntVector target)
void	zeroVector() Zero out the underlying buffer backing this vector.

Methods inherited from class org.apache.drill.exec.vector.BaseDataValueVector

clear, close, collectLedgers, exchange, getAllocatedSize, getBuffer, getBuffers, getBufferSize

Methods inherited from class org.apache.drill.exec.vector.BaseValueVector

checkBufRefs, fillBitsVector, getAllocator, getField, getField, getMetadata, getMetadataBuilder, 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.drill.exec.vector.ValueVector

clear, close, collectLedgers, exchange, getAllocatedSize, getAllocator, getBuffers, getBufferSize, getField, getMetadata

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Field Detail

VALUE_WIDTH

public static final int VALUE_WIDTH

Width of each fixed-width value.

See Also:

Constant Field Values

MAX_VALUE_COUNT

public static final int MAX_VALUE_COUNT

Maximum number of values that this fixed-width vector can hold and stay below the maximum vector size limit. This is the limit enforced when the vector is used to hold values in a repeated vector.

MAX_SCALAR_COUNT

public static final int MAX_SCALAR_COUNT

Maximum number of values that this fixed-width vector can hold and stay below the maximum vector size limit and/or stay below the maximum row count. This is the limit enforced when the vector is used to hold scalar (required or nullable) values.

Note: MAX_ROW_COUNT is defined in the parent ValueVector class as the maximum number of rows in a record batch (64K). Use this in place of the Character.MAX_SIZE value previously used.

NET_MAX_SCALAR_SIZE

public static final int NET_MAX_SCALAR_SIZE

Actual maximum vector size, in bytes, given the number of fixed-width values that either fit in the maximum overall vector size, or that is no larger than the maximum vector item count.

Constructor Detail

SmallIntVector

public SmallIntVector(MaterializedField field,
                      BufferAllocator allocator)

Method Detail

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

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

getAccessor

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

setInitialCapacity

public void setInitialCapacity(int valueCount)

Description copied from interface: ValueVector

Set the initial record capacity

Specified by:

setInitialCapacity in interface ValueVector

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)

Allocate a new buffer that supports setting at least the provided number of values. May actually be sized bigger depending on underlying buffer rounding size. Must be called prior to using the ValueVector. Note that the maximum number of values a vector can allocate is Integer.MAX_VALUE / value width.

Specified by:

allocateNew in interface FixedWidthVector

Parameters:

valueCount -

Throws:

OutOfMemoryException - if it can't allocate the new buffer

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

Allocate new buffer with double capacity, and copy data into the new buffer. Replace vector's buffer with new buffer, and release old one

Throws:

org.apache.drill.exec.memory.OutOfMemoryException - if it can't allocate the new buffer

reallocRaw

public DrillBuf reallocRaw(int newAllocationSize)

Description copied from class: BaseDataValueVector

Core of vector allocation. Given a new size (which must be a power of two), allocate the new buffer, copy the current values, and leave the unused parts garbage-filled.

Specified by:

reallocRaw in class BaseDataValueVector

Parameters:

newAllocationSize - new buffer size as a power of two

Returns:

the new buffer

zeroVector

public void zeroVector()

Zero out the underlying buffer backing this vector.

Specified by:

zeroVector in interface FixedWidthVector

load

public void load(UserBitShared.SerializedField metadata,
                 DrillBuf buffer)

Description copied from interface: ValueVector

Load the data provided in the buffer. Typically used when deserializing from the wire.

Specified by:

load in interface ValueVector

Parameters:

metadata - Metadata used to decode the incoming buffer.

buffer - The buffer that contains the ValueVector.

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

splitAndTransferTo

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

getPayloadByteCount

public int getPayloadByteCount(int valueCount)

Description copied from interface: ValueVector

Return the number of value bytes consumed by actual data.

Specified by:

getPayloadByteCount in interface ValueVector

getValueWidth

public int getValueWidth()

Description copied from interface: FixedWidthVector

The width of a record in bytes.

Specified by:

getValueWidth in interface FixedWidthVector

Returns:

The width of a record in bytes.

copyFrom

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

copyFromSafe

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

copyEntry

public void copyEntry(int toIndex,
                      ValueVector from,
                      int fromIndex)

Specified by:

copyEntry in interface ValueVector

decrementAllocationMonitor

public void decrementAllocationMonitor()

toNullable

public void toNullable(ValueVector nullableVector)

Description copied from interface: ValueVector

Convert a non-nullable vector to nullable by shuffling the data from one to the other. Avoids the need to generate copy code just to change mode. If this vector is non-nullable, accepts a nullable dual (same minor type, different mode.) If the vector is non-nullable, or non-scalar, then throws an exception.

Specified by:

toNullable in interface ValueVector

Overrides:

toNullable in class BaseValueVector

Parameters:

nullableVector - nullable vector of the same minor type as this vector