org.apache.arrow.vector

Class ZeroVector

java.lang.Object

org.apache.arrow.vector.NullVector

org.apache.arrow.vector.ZeroVector

All Implemented Interfaces:

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

public final class ZeroVector
extends NullVector

A zero length vector of any type.

Field Summary

Fields

Modifier and Type	Field and Description
static ZeroVector	INSTANCE

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

field

Constructor Summary

Constructors

Constructor and Description
ZeroVector() Deprecated.
ZeroVector(Field field) Instantiate a ZeroVector.
ZeroVector(String name) Instantiate a ZeroVector.
ZeroVector(String name, FieldType fieldType) Instantiate a ZeroVector.

Method Summary

Modifier and Type	Method and Description
int	getNullCount() Returns number of null elements in the vector.
TransferPair	getTransferPair(BufferAllocator allocator) To transfer quota responsibility.
TransferPair	getTransferPair(String ref, BufferAllocator allocator)
TransferPair	getTransferPair(String ref, BufferAllocator allocator, CallBack callBack)
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
int	getValueCount() Gets the number of values.
int	hashCode(int index) Returns hashCode of element in index with the default hasher.
int	hashCode(int index, ArrowBufHasher hasher) Returns hashCode of element in index with the given hasher.
boolean	isNull(int index) Check whether an element in the vector is null.
TransferPair	makeTransferPair(ValueVector target) Makes a new transfer pair used to transfer underlying buffers.
void	setValueCount(int valueCount) Set number of values in the vector.

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

accept, allocateNew, allocateNewSafe, clear, close, copyFrom, copyFromSafe, getAllocator, getBuffers, getBufferSize, getBufferSizeFor, getChildrenFromFields, getDataBuffer, getDataBufferAddress, getField, getFieldBuffers, getFieldInnerVectors, getMinorType, getName, getObject, getOffsetBuffer, getOffsetBufferAddress, getReader, getValidityBuffer, getValidityBufferAddress, initializeChildrenFromFields, iterator, loadFieldBuffers, reAlloc, reset, setInitialCapacity, setNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

validate, validateFull

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

INSTANCE

public static final ZeroVector INSTANCE

Constructor Detail

ZeroVector

public ZeroVector(String name)

Instantiate a ZeroVector.

Parameters:

name - name of the vector

ZeroVector

public ZeroVector(String name,
                  FieldType fieldType)

Instantiate a ZeroVector.

Parameters:

name - name of the vector

fieldType - type of Field materialized by this vector.

ZeroVector

public ZeroVector(Field field)

Instantiate a ZeroVector.

Parameters:

field - field materialized by this vector.

ZeroVector

@Deprecated
public ZeroVector()

Deprecated.

Method Detail

getValueCount

public int getValueCount()

Description copied from interface: ValueVector

Gets the number of values.

Specified by:

getValueCount in interface ValueVector

Overrides:

getValueCount in class NullVector

Returns:

number of values in the vector

setValueCount

public void setValueCount(int valueCount)

Description copied from interface: ValueVector

Set number of values in the vector.

Specified by:

setValueCount in interface ValueVector

Overrides:

setValueCount in class NullVector

getNullCount

public int getNullCount()

Description copied from interface: ValueVector

Returns number of null elements in the vector.

Specified by:

getNullCount in interface ValueVector

Overrides:

getNullCount in class NullVector

Returns:

number of null elements

isNull

public boolean isNull(int index)

Description copied from interface: ValueVector

Check whether an element in the vector is null.

Specified by:

isNull in interface ValueVector

Overrides:

isNull in class NullVector

Parameters:

index - index to check for null

Returns:

true if element is null

hashCode

public int hashCode(int index)

Description copied from interface: ValueVector

Returns hashCode of element in index with the default hasher.

Specified by:

hashCode in interface ValueVector

Overrides:

hashCode in class NullVector

hashCode

public int hashCode(int index,
                    ArrowBufHasher hasher)

Description copied from interface: ValueVector

Returns hashCode of element in index with the given hasher.

Specified by:

hashCode in interface ValueVector

Overrides:

hashCode in class NullVector

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

Overrides:

getValueCapacity in class NullVector

Returns:

the maximum number of values that can be stored in this vector instance.

getTransferPair

public TransferPair getTransferPair(BufferAllocator allocator)

Description copied from interface: ValueVector

To transfer quota responsibility.

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class NullVector

Parameters:

allocator - the target allocator

Returns:

a transfer pair, creating a new target vector of the same type.

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class NullVector

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator,
                                    CallBack callBack)

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class NullVector

makeTransferPair

public TransferPair makeTransferPair(ValueVector target)

Description copied from interface: ValueVector

Makes a new transfer pair used to transfer underlying buffers.

Specified by:

makeTransferPair in interface ValueVector

Overrides:

makeTransferPair in class NullVector

Parameters:

target - the target for the transfer

Returns:

a new transfer pair that is used to transfer underlying buffers into the target vector.