Package org.apache.arrow.vector

Class DurationVector

java.lang.Object

org.apache.arrow.vector.BaseValueVector

org.apache.arrow.vector.BaseFixedWidthVector

org.apache.arrow.vector.DurationVector

All Implemented Interfaces:

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

public final class DurationVector
extends BaseFixedWidthVector

DurationVector implements a fixed width vector (8 bytes) of a configurable TimeUnit granularity duration 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	Description
static final 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	Description
DurationVector(String name, FieldType fieldType, BufferAllocator allocator)	Instantiate a DurationVector.
DurationVector(Field field, BufferAllocator allocator)	Instantiate a DurationVector.

Method Summary

Modifier and Type	Method	Description
ArrowBuf	get(int index)	Get the element at the given index from the vector.
void	get(int index, NullableDurationHolder holder)	Get the element at the given index from the vector and sets the state in holder.
static long	get(ArrowBuf buffer, int index)	Given a data buffer, get the value stored at a particular position in the vector.
StringBuilder	getAsStringBuilder(int index)	Get the Interval value at a given index as a StringBuilder object.
Types.MinorType	getMinorType()	Get minor type for this vector.
Duration	getObject(int index)	Same as get(int).
Duration	getObjectNotNull(int index)	Same as getObject(int) but does not check for null.
protected FieldReader	getReaderImpl()	Each vector has a different reader that implements the FieldReader interface.
TransferPair	getTransferPair(String ref, BufferAllocator allocator)	Construct a TransferPair comprising of this and a target vector of the same type.
TransferPair	getTransferPair(Field field, BufferAllocator allocator)	Construct a TransferPair comprising this and a target vector of the same type.
TimeUnit	getUnit()	Gets the time unit of the duration.
TransferPair	makeTransferPair(ValueVector to)	Construct a TransferPair with a desired target vector of the same type.
void	set(int index, int isSet, long value)	Store the given value at a particular position in the vector.
void	set(int index, long value)	Set the element at the given index to the given value.
void	set(int index, ArrowBuf value)	Set the element at the given index to the given value.
void	set(int index, DurationHolder holder)	Set the element at the given index to the value set in data holder.
void	set(int index, NullableDurationHolder holder)	Set the element at the given index to the value set in data holder.
void	setSafe(int index, int isSet, long value)	Same as set(int, int, long) except that it handles the case when index is greater than or equal to current value capacity of the vector.
void	setSafe(int index, long value)	Same as set(int, long) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, ArrowBuf value)	Same as set(int, ArrowBuf) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, DurationHolder holder)	Same as set(int, DurationHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
void	setSafe(int index, NullableDurationHolder holder)	Same as set(int, NullableDurationHolder) except that it handles the case when index is greater than or equal to existing value capacity BaseFixedWidthVector.getValueCapacity().
static Duration	toDuration(long value, TimeUnit unit)	Converts the given value and unit to the appropriate Duration.

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

getAllocator, getReader, validate, validateFull

Field Details

TYPE_WIDTH

public static final byte TYPE_WIDTH

See Also:

• Constant Field Values

Constructor Details

DurationVector

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

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

DurationVector

public DurationVector(Field field,
 BufferAllocator allocator)

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

Parameters:

field - field materialized by this vector

allocator - allocator for memory management.

Method Details

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.

Returns:

Types.MinorType

get

public static long 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.

get

public ArrowBuf 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,
 NullableDurationHolder 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 Duration getObject(int index)

Same as get(int).

Parameters:

index - position of element

Returns:

element at given index

getObjectNotNull

public Duration getObjectNotNull(int index)

Same as getObject(int) but does not check for null.

Parameters:

index - position of element

Returns:

element at given index

toDuration

public static Duration toDuration(long value,
 TimeUnit unit)

Converts the given value and unit to the appropriate Duration.

getAsStringBuilder

public StringBuilder getAsStringBuilder(int index)

Get the Interval value at a given index as a StringBuilder object.

Parameters:

index - position of the element

Returns:

String Builder object with Interval in java.time.Duration format.

getUnit

public TimeUnit getUnit()

Gets the time unit of the duration.

set

public void set(int index,
 ArrowBuf 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,
 long value)

Set the element at the given index to the given value.

Parameters:

index - position of element

value - The duration value (in the timeunit associated with this vector)

set

public void set(int index,
 NullableDurationHolder 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,
 DurationHolder 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,
 ArrowBuf value)

Same as set(int, ArrowBuf) 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,
 long value)

Same as set(int, long) 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 - duration in the time unit this vector was constructed with

setSafe

public void setSafe(int index,
 NullableDurationHolder holder)
             throws IllegalArgumentException

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

Same as set(int, DurationHolder) 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,
 long 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 - The duration value (in the TimeUnit associated with this vector).

setSafe

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

Same as set(int, int, long) 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 - The duration value (in the timeunit associated with this vector)

getTransferPair

public TransferPair getTransferPair(String ref,
 BufferAllocator allocator)

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

Parameters:

to - target vector

Returns:

TransferPair