org.apache.arrow.vector

Class TimeStampMilliTZVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseFixedWidthVector

org.apache.arrow.vector.TimeStampVector

org.apache.arrow.vector.TimeStampMilliTZVector

All Implemented Interfaces:

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

public class TimeStampMilliTZVector
extends TimeStampVector

TimeStampMilliTZVector implements a fixed width vector (8 bytes) of timestamp (millisecond resolution) values which could be null. A validity buffer (bit vector) is maintained to track which elements in the vector are null.

Nested Class Summary

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

TimeStampVector.TransferImpl

Field Summary

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

TYPE_WIDTH

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
TimeStampMilliTZVector(String name, BufferAllocator allocator, String timeZone) Instantiate a TimeStampMilliTZVector.
TimeStampMilliTZVector(String name, FieldType fieldType, BufferAllocator allocator) Instantiate a TimeStampMilliTZVector.

Method Summary

Methods

Modifier and Type	Method and Description
void	get(int index, NullableTimeStampMilliTZHolder 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.
Long	getObject(int index) Same as TimeStampVector.get(int).
FieldReader	getReader() Get a reader that supports reading values from this vector
TransferPair	getTransferPair(String ref, BufferAllocator allocator) Construct a TransferPair comprising of this and and a target vector of the same type.
TransferPair	makeTransferPair(ValueVector to) Construct a TransferPair with a desired target vector of the same type.
void	set(int index, NullableTimeStampMilliTZHolder holder) Set the element at the given index to the value set in data holder.
void	set(int index, TimeStampMilliTZHolder holder) Set the element at the given index to the value set in data holder.
void	setSafe(int index, NullableTimeStampMilliTZHolder holder) Same as set(int, NullableTimeStampMilliTZHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, TimeStampMilliTZHolder holder) Same as set(int, TimeStampMilliTZHolder) 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.TimeStampVector

copyFrom, copyFromSafe, get, get, set, set, setNull, setSafe, setSafe, setValue

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

iterator

Constructor Detail

TimeStampMilliTZVector

public TimeStampMilliTZVector(String name,
                      BufferAllocator allocator,
                      String timeZone)

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

Parameters:

name - name of the vector

allocator - allocator for memory management.

TimeStampMilliTZVector

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

Instantiate a TimeStampMilliTZVector. 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.

Method Detail

getReader

public FieldReader getReader()

Get a reader that supports reading values from this vector

Returns:

Field Reader for this vector

getMinorType

public Types.MinorType getMinorType()

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

Returns:

Types.MinorType

get

public void get(int index,
       NullableTimeStampMilliTZHolder 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 Long getObject(int index)

Same as TimeStampVector.get(int).

Parameters:

index - position of element

Returns:

element at given index

set

public void set(int index,
       NullableTimeStampMilliTZHolder 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,
       TimeStampMilliTZHolder 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,
           NullableTimeStampMilliTZHolder holder)
             throws IllegalArgumentException

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

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

getTransferPair

public TransferPair getTransferPair(String ref,
                           BufferAllocator allocator)

Construct a TransferPair comprising of this and 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

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

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

Parameters:

to - target vector

Returns:

TransferPair