Package org.apache.arrow.vector.complex

Class UnionVector

java.lang.Object

org.apache.arrow.vector.complex.AbstractContainerVector

org.apache.arrow.vector.complex.UnionVector

All Implemented Interfaces:

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

public class UnionVector
extends AbstractContainerVector
implements FieldVector

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	TYPE_WIDTH
protected ArrowBuf	typeBuffer

Fields inherited from class org.apache.arrow.vector.complex.AbstractContainerVector

allocator, callBack, name

Constructor Summary

Constructors

Constructor	Description
UnionVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack callBack)

Method Summary

Modifier and Type	Method	Description
<OUT, IN> OUT	accept(VectorVisitor<OUT,IN> visitor, IN value)	Accept a generic VectorVisitor and return the result.
<T extends FieldVector> T	addOrGet(String name, FieldType fieldType, Class<T> clazz)
FieldVector	addVector(FieldVector v)
void	allocateNew()	Allocate new buffers.
boolean	allocateNewSafe()	Allocates new buffers.
void	clear()	Release any owned ArrowBuf and reset the ValueVector to the initial state.
void	close()	Clears out all underlying child vectors.
void	copyFrom(int inIndex, int outIndex, ValueVector from)	Copy a cell value from a particular index in source vector to a particular position in this vector.
void	copyFromSafe(int inIndex, int outIndex, ValueVector from)	Same as ValueVector.copyFrom(int, int, ValueVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.
void	directAddVector(FieldVector v)	Directly put a vector to internalStruct without creating a new one with same type.
static UnionVector	empty(String name, BufferAllocator allocator)
byte[]	get(int index)
void	get(int index, ComplexHolder holder)
void	get(int index, UnionHolder holder)
BufferAllocator	getAllocator()
BigIntVector	getBigIntVector()
BigIntVector	getBigIntVector(String name)
BitVector	getBitVector()
BitVector	getBitVector(String name)
ArrowBuf[]	getBuffers(boolean clear)	Return the underlying buffers associated with this vector.
int	getBufferSize()	Get the number of bytes used by this vector.
int	getBufferSizeFor(int valueCount)	Returns the number of bytes that is used by this vector if it holds the given number of values.
<T extends FieldVector> T	getChild(String name, Class<T> clazz)
List<FieldVector>	getChildrenFromFields()	The returned list is the same size as the list passed to initializeChildrenFromFields.
VectorWithOrdinal	getChildVectorWithOrdinal(String name)
ArrowBuf	getDataBuffer()	Gets the underlying buffer associated with data vector.
long	getDataBufferAddress()	Gets the starting address of the underlying buffer associated with data vector.
DateDayVector	getDateDayVector()
DateDayVector	getDateDayVector(String name)
DateMilliVector	getDateMilliVector()
DateMilliVector	getDateMilliVector(String name)
Decimal256Vector	getDecimal256Vector()
Decimal256Vector	getDecimal256Vector(String name, ArrowType arrowType)
Decimal256Vector	getDecimal256Vector(ArrowType arrowType)
DecimalVector	getDecimalVector()
DecimalVector	getDecimalVector(String name, ArrowType arrowType)
DecimalVector	getDecimalVector(ArrowType arrowType)
DurationVector	getDurationVector()
DurationVector	getDurationVector(String name, ArrowType arrowType)
DurationVector	getDurationVector(ArrowType arrowType)
Field	getField()	Get information about how this field is materialized.
List<ArrowBuf>	getFieldBuffers()	Get the buffers of the fields, (same size as getFieldVectors() since it is their content).
List<BufferBacked>	getFieldInnerVectors()	Deprecated. This API will be removed as the current implementations no longer support inner vectors.
FixedSizeBinaryVector	getFixedSizeBinaryVector()
FixedSizeBinaryVector	getFixedSizeBinaryVector(String name, ArrowType arrowType)
FixedSizeBinaryVector	getFixedSizeBinaryVector(ArrowType arrowType)
Float2Vector	getFloat2Vector()
Float2Vector	getFloat2Vector(String name)
Float4Vector	getFloat4Vector()
Float4Vector	getFloat4Vector(String name)
Float8Vector	getFloat8Vector()
Float8Vector	getFloat8Vector(String name)
IntervalDayVector	getIntervalDayVector()
IntervalDayVector	getIntervalDayVector(String name)
IntervalMonthDayNanoVector	getIntervalMonthDayNanoVector()
IntervalMonthDayNanoVector	getIntervalMonthDayNanoVector(String name)
IntervalYearVector	getIntervalYearVector()
IntervalYearVector	getIntervalYearVector(String name)
IntVector	getIntVector()
IntVector	getIntVector(String name)
LargeVarBinaryVector	getLargeVarBinaryVector()
LargeVarBinaryVector	getLargeVarBinaryVector(String name)
LargeVarCharVector	getLargeVarCharVector()
LargeVarCharVector	getLargeVarCharVector(String name)
ListVector	getList()
MapVector	getMap()
MapVector	getMap(String name, ArrowType arrowType)
MapVector	getMap(ArrowType arrowType)
Types.MinorType	getMinorType()
String	getName()	Gets the name of the vector.
int	getNullCount()	Returns number of null elements in the vector.
Object	getObject(int index)	Get friendly type object from the vector.
ArrowBuf	getOffsetBuffer()	Gets the underlying buffer associated with offset vector.
long	getOffsetBufferAddress()	Gets the starting address of the underlying buffer associated with offset vector.
FieldReader	getReader()	Get a reader for this vector.
SmallIntVector	getSmallIntVector()
SmallIntVector	getSmallIntVector(String name)
StructVector	getStruct()
TimeMicroVector	getTimeMicroVector()
TimeMicroVector	getTimeMicroVector(String name)
TimeMilliVector	getTimeMilliVector()
TimeMilliVector	getTimeMilliVector(String name)
TimeNanoVector	getTimeNanoVector()
TimeNanoVector	getTimeNanoVector(String name)
TimeSecVector	getTimeSecVector()
TimeSecVector	getTimeSecVector(String name)
TimeStampMicroTZVector	getTimeStampMicroTZVector()
TimeStampMicroTZVector	getTimeStampMicroTZVector(String name, ArrowType arrowType)
TimeStampMicroTZVector	getTimeStampMicroTZVector(ArrowType arrowType)
TimeStampMicroVector	getTimeStampMicroVector()
TimeStampMicroVector	getTimeStampMicroVector(String name)
TimeStampMilliTZVector	getTimeStampMilliTZVector()
TimeStampMilliTZVector	getTimeStampMilliTZVector(String name, ArrowType arrowType)
TimeStampMilliTZVector	getTimeStampMilliTZVector(ArrowType arrowType)
TimeStampMilliVector	getTimeStampMilliVector()
TimeStampMilliVector	getTimeStampMilliVector(String name)
TimeStampNanoTZVector	getTimeStampNanoTZVector()
TimeStampNanoTZVector	getTimeStampNanoTZVector(String name, ArrowType arrowType)
TimeStampNanoTZVector	getTimeStampNanoTZVector(ArrowType arrowType)
TimeStampNanoVector	getTimeStampNanoVector()
TimeStampNanoVector	getTimeStampNanoVector(String name)
TimeStampSecTZVector	getTimeStampSecTZVector()
TimeStampSecTZVector	getTimeStampSecTZVector(String name, ArrowType arrowType)
TimeStampSecTZVector	getTimeStampSecTZVector(ArrowType arrowType)
TimeStampSecVector	getTimeStampSecVector()
TimeStampSecVector	getTimeStampSecVector(String name)
TinyIntVector	getTinyIntVector()
TinyIntVector	getTinyIntVector(String name)
TransferPair	getTransferPair(String ref, BufferAllocator allocator)	To transfer quota responsibility.
TransferPair	getTransferPair(String ref, BufferAllocator allocator, CallBack callBack)	To transfer quota responsibility.
TransferPair	getTransferPair(BufferAllocator allocator)	To transfer quota responsibility.
TransferPair	getTransferPair(Field field, BufferAllocator allocator)	To transfer quota responsibility.
TransferPair	getTransferPair(Field field, BufferAllocator allocator, CallBack callBack)	To transfer quota responsibility.
ArrowBuf	getTypeBuffer()
long	getTypeBufferAddress()
int	getTypeValue(int index)
UInt1Vector	getUInt1Vector()
UInt1Vector	getUInt1Vector(String name)
UInt2Vector	getUInt2Vector()
UInt2Vector	getUInt2Vector(String name)
UInt4Vector	getUInt4Vector()
UInt4Vector	getUInt4Vector(String name)
UInt8Vector	getUInt8Vector()
UInt8Vector	getUInt8Vector(String name)
ArrowBuf	getValidityBuffer()	Gets the underlying buffer associated with validity vector.
long	getValidityBufferAddress()	Gets the starting address of the underlying buffer associated with validity vector.
int	getValueCapacity()	Returns the maximum number of values that can be stored in this vector instance.
int	getValueCount()	Gets the number of values.
VarBinaryVector	getVarBinaryVector()
VarBinaryVector	getVarBinaryVector(String name)
VarCharVector	getVarCharVector()
VarCharVector	getVarCharVector(String name)
ValueVector	getVector(int index)
ValueVector	getVector(int index, ArrowType arrowType)
ValueVector	getVectorByType(int typeId)
ValueVector	getVectorByType(int typeId, ArrowType arrowType)
ViewVarBinaryVector	getViewVarBinaryVector()
ViewVarBinaryVector	getViewVarBinaryVector(String name)
ViewVarCharVector	getViewVarCharVector()
ViewVarCharVector	getViewVarCharVector(String name)
FieldWriter	getWriter()
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.
void	initializeChildrenFromFields(List<Field> children)	Initializes the child vectors to be later loaded with loadBuffers.
boolean	isNull(int index)	IMPORTANT: Union types always return non null as there is no validity buffer.
int	isSet(int index)
Iterator<ValueVector>	iterator()
void	loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers)	Loads data in the vectors.
TransferPair	makeTransferPair(ValueVector target)	Makes a new transfer pair used to transfer underlying buffers.
void	reAlloc()	Allocate new buffer with double capacity, and copy data into the new buffer.
void	reset()	Reset the ValueVector to the initial state without releasing any owned ArrowBuf.
void	setInitialCapacity(int numRecords)	Set the initial record capacity.
void	setInitialCapacity(int valueCount, double density)	Set value with density.
void	setNull(int index)	Set the element at the given index to null.
void	setSafe(int index, NullableBigIntHolder holder)
void	setSafe(int index, NullableBitHolder holder)
void	setSafe(int index, NullableDateDayHolder holder)
void	setSafe(int index, NullableDateMilliHolder holder)
void	setSafe(int index, NullableDecimal256Holder holder, ArrowType arrowType)
void	setSafe(int index, NullableDecimalHolder holder, ArrowType arrowType)
void	setSafe(int index, NullableDurationHolder holder, ArrowType arrowType)
void	setSafe(int index, NullableFixedSizeBinaryHolder holder, ArrowType arrowType)
void	setSafe(int index, NullableFloat2Holder holder)
void	setSafe(int index, NullableFloat4Holder holder)
void	setSafe(int index, NullableFloat8Holder holder)
void	setSafe(int index, NullableIntervalDayHolder holder)
void	setSafe(int index, NullableIntervalMonthDayNanoHolder holder)
void	setSafe(int index, NullableIntervalYearHolder holder)
void	setSafe(int index, NullableIntHolder holder)
void	setSafe(int index, NullableLargeVarBinaryHolder holder)
void	setSafe(int index, NullableLargeVarCharHolder holder)
void	setSafe(int index, NullableSmallIntHolder holder)
void	setSafe(int index, NullableTimeMicroHolder holder)
void	setSafe(int index, NullableTimeMilliHolder holder)
void	setSafe(int index, NullableTimeNanoHolder holder)
void	setSafe(int index, NullableTimeSecHolder holder)
void	setSafe(int index, NullableTimeStampMicroHolder holder)
void	setSafe(int index, NullableTimeStampMicroTZHolder holder, ArrowType arrowType)
void	setSafe(int index, NullableTimeStampMilliHolder holder)
void	setSafe(int index, NullableTimeStampMilliTZHolder holder, ArrowType arrowType)
void	setSafe(int index, NullableTimeStampNanoHolder holder)
void	setSafe(int index, NullableTimeStampNanoTZHolder holder, ArrowType arrowType)
void	setSafe(int index, NullableTimeStampSecHolder holder)
void	setSafe(int index, NullableTimeStampSecTZHolder holder, ArrowType arrowType)
void	setSafe(int index, NullableTinyIntHolder holder)
void	setSafe(int index, NullableUInt1Holder holder)
void	setSafe(int index, NullableUInt2Holder holder)
void	setSafe(int index, NullableUInt4Holder holder)
void	setSafe(int index, NullableUInt8Holder holder)
void	setSafe(int index, NullableVarBinaryHolder holder)
void	setSafe(int index, NullableVarCharHolder holder)
void	setSafe(int index, NullableViewVarBinaryHolder holder)
void	setSafe(int index, NullableViewVarCharHolder holder)
void	setSafe(int index, UnionHolder holder)
void	setSafe(int index, UnionHolder holder, ArrowType arrowType)
void	setType(int index, Types.MinorType type)
void	setValueCount(int valueCount)	Set number of values in the vector.
int	size()
String	toString()	Representation of vector suitable for debugging.

Methods inherited from class org.apache.arrow.vector.complex.AbstractContainerVector

addOrGetFixedSizeList, addOrGetList, addOrGetMap, addOrGetStruct, addOrGetUnion, getChild, supportsDirectRead, typeify

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, getExportedCDataBufferCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

validate, validateFull

Field Details

typeBuffer

protected ArrowBuf typeBuffer

TYPE_WIDTH

public static final byte TYPE_WIDTH

See Also:

• Constant Field Values

Constructor Details

UnionVector

public UnionVector(String name,
 BufferAllocator allocator,
 FieldType fieldType,
 CallBack callBack)

Method Details

empty

public static UnionVector empty(String name,
 BufferAllocator allocator)

getAllocator

public BufferAllocator getAllocator()

Specified by:

getAllocator in interface ValueVector

Overrides:

getAllocator in class AbstractContainerVector

getMinorType

public Types.MinorType getMinorType()

Specified by:

getMinorType in interface ValueVector

initializeChildrenFromFields

public void initializeChildrenFromFields(List<Field> children)

Description copied from interface: FieldVector

Initializes the child vectors to be later loaded with loadBuffers.

Specified by:

initializeChildrenFromFields in interface FieldVector

Parameters:

children - the schema

getChildrenFromFields

public List<FieldVector> getChildrenFromFields()

Description copied from interface: FieldVector

The returned list is the same size as the list passed to initializeChildrenFromFields.

Specified by:

getChildrenFromFields in interface FieldVector

Returns:

the children according to schema (empty for primitive types)

loadFieldBuffers

public void loadFieldBuffers(ArrowFieldNode fieldNode,
 List<ArrowBuf> ownBuffers)

Description copied from interface: FieldVector

Loads data in the vectors. (ownBuffers must be the same size as getFieldVectors())

Specified by:

loadFieldBuffers in interface FieldVector

Parameters:

fieldNode - the fieldNode

ownBuffers - the buffers for this Field (own buffers only, children not included)

getFieldBuffers

public List<ArrowBuf> getFieldBuffers()

Description copied from interface: FieldVector

Get the buffers of the fields, (same size as getFieldVectors() since it is their content).

Specified by:

getFieldBuffers in interface FieldVector

Returns:

the buffers containing the data for this vector (ready for reading)

getFieldInnerVectors

@Deprecated
public List<BufferBacked> getFieldInnerVectors()

Deprecated.

This API will be removed as the current implementations no longer support inner vectors.

Get the inner vectors.

Specified by:

getFieldInnerVectors in interface FieldVector

Returns:

the inner vectors for this field as defined by the TypeLayout

getValidityBufferAddress

public long getValidityBufferAddress()

Description copied from interface: FieldVector

Gets the starting address of the underlying buffer associated with validity vector.

Specified by:

getValidityBufferAddress in interface FieldVector

Returns:

buffer address

getTypeBufferAddress

public long getTypeBufferAddress()

getDataBufferAddress

public long getDataBufferAddress()

Description copied from interface: FieldVector

Gets the starting address of the underlying buffer associated with data vector.

Specified by:

getDataBufferAddress in interface FieldVector

Returns:

buffer address

getOffsetBufferAddress

public long getOffsetBufferAddress()

Description copied from interface: FieldVector

Gets the starting address of the underlying buffer associated with offset vector.

Specified by:

getOffsetBufferAddress in interface FieldVector

Returns:

buffer address

getTypeBuffer

public ArrowBuf getTypeBuffer()

getValidityBuffer

public ArrowBuf getValidityBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with validity vector.

Specified by:

getValidityBuffer in interface ValueVector

Returns:

buffer

getDataBuffer

public ArrowBuf getDataBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with data vector.

Specified by:

getDataBuffer in interface ValueVector

Returns:

buffer

getOffsetBuffer

public ArrowBuf getOffsetBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with offset vector.

Specified by:

getOffsetBuffer in interface ValueVector

Returns:

buffer

getStruct

public StructVector getStruct()

getTinyIntVector

public TinyIntVector getTinyIntVector()

getTinyIntVector

public TinyIntVector getTinyIntVector(String name)

getUInt1Vector

public UInt1Vector getUInt1Vector()

getUInt1Vector

public UInt1Vector getUInt1Vector(String name)

getUInt2Vector

public UInt2Vector getUInt2Vector()

getUInt2Vector

public UInt2Vector getUInt2Vector(String name)

getSmallIntVector

public SmallIntVector getSmallIntVector()

getSmallIntVector

public SmallIntVector getSmallIntVector(String name)

getFloat2Vector

public Float2Vector getFloat2Vector()

getFloat2Vector

public Float2Vector getFloat2Vector(String name)

getIntVector

public IntVector getIntVector()

getIntVector

public IntVector getIntVector(String name)

getUInt4Vector

public UInt4Vector getUInt4Vector()

getUInt4Vector

public UInt4Vector getUInt4Vector(String name)

getFloat4Vector

public Float4Vector getFloat4Vector()

getFloat4Vector

public Float4Vector getFloat4Vector(String name)

getDateDayVector

public DateDayVector getDateDayVector()

getDateDayVector

public DateDayVector getDateDayVector(String name)

getIntervalYearVector

public IntervalYearVector getIntervalYearVector()

getIntervalYearVector

public IntervalYearVector getIntervalYearVector(String name)

getTimeSecVector

public TimeSecVector getTimeSecVector()

getTimeSecVector

public TimeSecVector getTimeSecVector(String name)

getTimeMilliVector

public TimeMilliVector getTimeMilliVector()

getTimeMilliVector

public TimeMilliVector getTimeMilliVector(String name)

getBigIntVector

public BigIntVector getBigIntVector()

getBigIntVector

public BigIntVector getBigIntVector(String name)

getUInt8Vector

public UInt8Vector getUInt8Vector()

getUInt8Vector

public UInt8Vector getUInt8Vector(String name)

getFloat8Vector

public Float8Vector getFloat8Vector()

getFloat8Vector

public Float8Vector getFloat8Vector(String name)

getDateMilliVector

public DateMilliVector getDateMilliVector()

getDateMilliVector

public DateMilliVector getDateMilliVector(String name)

getDurationVector

public DurationVector getDurationVector()

getDurationVector

public DurationVector getDurationVector(ArrowType arrowType)

getDurationVector

public DurationVector getDurationVector(String name,
 ArrowType arrowType)

getTimeStampSecVector

public TimeStampSecVector getTimeStampSecVector()

getTimeStampSecVector

public TimeStampSecVector getTimeStampSecVector(String name)

getTimeStampMilliVector

public TimeStampMilliVector getTimeStampMilliVector()

getTimeStampMilliVector

public TimeStampMilliVector getTimeStampMilliVector(String name)

getTimeStampMicroVector

public TimeStampMicroVector getTimeStampMicroVector()

getTimeStampMicroVector

public TimeStampMicroVector getTimeStampMicroVector(String name)

getTimeStampNanoVector

public TimeStampNanoVector getTimeStampNanoVector()

getTimeStampNanoVector

public TimeStampNanoVector getTimeStampNanoVector(String name)

getTimeStampSecTZVector

public TimeStampSecTZVector getTimeStampSecTZVector()

getTimeStampSecTZVector

public TimeStampSecTZVector getTimeStampSecTZVector(ArrowType arrowType)

getTimeStampSecTZVector

public TimeStampSecTZVector getTimeStampSecTZVector(String name,
 ArrowType arrowType)

getTimeStampMilliTZVector

public TimeStampMilliTZVector getTimeStampMilliTZVector()

getTimeStampMilliTZVector

public TimeStampMilliTZVector getTimeStampMilliTZVector(ArrowType arrowType)

getTimeStampMilliTZVector

public TimeStampMilliTZVector getTimeStampMilliTZVector(String name,
 ArrowType arrowType)

getTimeStampMicroTZVector

public TimeStampMicroTZVector getTimeStampMicroTZVector()

getTimeStampMicroTZVector

public TimeStampMicroTZVector getTimeStampMicroTZVector(ArrowType arrowType)

getTimeStampMicroTZVector

public TimeStampMicroTZVector getTimeStampMicroTZVector(String name,
 ArrowType arrowType)

getTimeStampNanoTZVector

public TimeStampNanoTZVector getTimeStampNanoTZVector()

getTimeStampNanoTZVector

public TimeStampNanoTZVector getTimeStampNanoTZVector(ArrowType arrowType)

getTimeStampNanoTZVector

public TimeStampNanoTZVector getTimeStampNanoTZVector(String name,
 ArrowType arrowType)

getTimeMicroVector

public TimeMicroVector getTimeMicroVector()

getTimeMicroVector

public TimeMicroVector getTimeMicroVector(String name)

getTimeNanoVector

public TimeNanoVector getTimeNanoVector()

getTimeNanoVector

public TimeNanoVector getTimeNanoVector(String name)

getIntervalDayVector

public IntervalDayVector getIntervalDayVector()

getIntervalDayVector

public IntervalDayVector getIntervalDayVector(String name)

getIntervalMonthDayNanoVector

public IntervalMonthDayNanoVector getIntervalMonthDayNanoVector()

getIntervalMonthDayNanoVector

public IntervalMonthDayNanoVector getIntervalMonthDayNanoVector(String name)

getDecimal256Vector

public Decimal256Vector getDecimal256Vector()

getDecimal256Vector

public Decimal256Vector getDecimal256Vector(ArrowType arrowType)

getDecimal256Vector

public Decimal256Vector getDecimal256Vector(String name,
 ArrowType arrowType)

getDecimalVector

public DecimalVector getDecimalVector()

getDecimalVector

public DecimalVector getDecimalVector(ArrowType arrowType)

getDecimalVector

public DecimalVector getDecimalVector(String name,
 ArrowType arrowType)

getFixedSizeBinaryVector

public FixedSizeBinaryVector getFixedSizeBinaryVector()

getFixedSizeBinaryVector

public FixedSizeBinaryVector getFixedSizeBinaryVector(ArrowType arrowType)

getFixedSizeBinaryVector

public FixedSizeBinaryVector getFixedSizeBinaryVector(String name,
 ArrowType arrowType)

getVarBinaryVector

public VarBinaryVector getVarBinaryVector()

getVarBinaryVector

public VarBinaryVector getVarBinaryVector(String name)

getVarCharVector

public VarCharVector getVarCharVector()

getVarCharVector

public VarCharVector getVarCharVector(String name)

getViewVarBinaryVector

public ViewVarBinaryVector getViewVarBinaryVector()

getViewVarBinaryVector

public ViewVarBinaryVector getViewVarBinaryVector(String name)

getViewVarCharVector

public ViewVarCharVector getViewVarCharVector()

getViewVarCharVector

public ViewVarCharVector getViewVarCharVector(String name)

getLargeVarCharVector

public LargeVarCharVector getLargeVarCharVector()

getLargeVarCharVector

public LargeVarCharVector getLargeVarCharVector(String name)

getLargeVarBinaryVector

public LargeVarBinaryVector getLargeVarBinaryVector()

getLargeVarBinaryVector

public LargeVarBinaryVector getLargeVarBinaryVector(String name)

getBitVector

public BitVector getBitVector()

getBitVector

public BitVector getBitVector(String name)

getList

public ListVector getList()

getMap

public MapVector getMap()

getMap

public MapVector getMap(ArrowType arrowType)

getMap

public MapVector getMap(String name,
 ArrowType arrowType)

getTypeValue

public int getTypeValue(int index)

allocateNew

public void allocateNew()
                 throws OutOfMemoryException

Description copied from interface: ValueVector

Allocate new buffers. ValueVector implements logic to determine how much to allocate.

Specified by:

allocateNew in interface ValueVector

Overrides:

allocateNew in class AbstractContainerVector

Throws:

OutOfMemoryException - Thrown if no memory can be allocated.

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.

reAlloc

public void reAlloc()

Description copied from interface: ValueVector

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

Specified by:

reAlloc in interface ValueVector

setInitialCapacity

public void setInitialCapacity(int numRecords)

Description copied from interface: ValueVector

Set the initial record capacity.

Specified by:

setInitialCapacity in interface ValueVector

Parameters:

numRecords - the initial record capacity.

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

Returns:

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

close

public void close()

Description copied from class: AbstractContainerVector

Clears out all underlying child vectors.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ValueVector

Overrides:

close in class AbstractContainerVector

clear

public void clear()

Description copied from interface: ValueVector

Release any owned ArrowBuf and reset the ValueVector to the initial state. If the vector has any child vectors, they will also be cleared.

Specified by:

clear in interface ValueVector

reset

public void reset()

Description copied from interface: ValueVector

Reset the ValueVector to the initial state without releasing any owned ArrowBuf. Buffer capacities will remain unchanged and any previous data will be zeroed out. This includes buffers for data, validity, offset, etc. If the vector has any child vectors, they will also be reset.

Specified by:

reset in interface ValueVector

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Specified by:

getField in interface ValueVector

Returns:

the field corresponding to this vector

getTransferPair

public TransferPair getTransferPair(BufferAllocator allocator)

Description copied from interface: ValueVector

To transfer quota responsibility.

Specified by:

getTransferPair in interface ValueVector

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)

Description copied from interface: ValueVector

To transfer quota responsibility.

Specified by:

getTransferPair in interface ValueVector

Parameters:

ref - the name of the vector

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,
 CallBack callBack)

Description copied from interface: ValueVector

To transfer quota responsibility.

Specified by:

getTransferPair in interface ValueVector

Parameters:

ref - the name of the vector

allocator - the target allocator

callBack - A schema change callback.

Returns:

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

getTransferPair

public TransferPair getTransferPair(Field field,
 BufferAllocator allocator)

Description copied from interface: ValueVector

To transfer quota responsibility.

Specified by:

getTransferPair in interface ValueVector

Parameters:

field - the Field object used by the target vector

allocator - the target allocator

Returns:

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

getTransferPair

public TransferPair getTransferPair(Field field,
 BufferAllocator allocator,
 CallBack callBack)

Description copied from interface: ValueVector

To transfer quota responsibility.

Specified by:

getTransferPair in interface ValueVector

Parameters:

field - the Field object used by the target vector

allocator - the target allocator

callBack - A schema change callback.

Returns:

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

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

Parameters:

target - the target for the transfer

Returns:

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

copyFrom

public void copyFrom(int inIndex,
 int outIndex,
 ValueVector from)

Description copied from interface: ValueVector

Copy a cell value from a particular index in source vector to a particular position in this vector.

Specified by:

copyFrom in interface ValueVector

Overrides:

copyFrom in class AbstractContainerVector

Parameters:

inIndex - position to copy from in source vector

outIndex - position to copy to in this vector

from - source vector

copyFromSafe

public void copyFromSafe(int inIndex,
 int outIndex,
 ValueVector from)

Description copied from interface: ValueVector

Same as ValueVector.copyFrom(int, int, ValueVector) except that it handles the case when the capacity of the vector needs to be expanded before copy.

Specified by:

copyFromSafe in interface ValueVector

Overrides:

copyFromSafe in class AbstractContainerVector

Parameters:

inIndex - position to copy from in source vector

outIndex - position to copy to in this vector

from - source vector

addVector

public FieldVector addVector(FieldVector v)

directAddVector

public void directAddVector(FieldVector v)

Directly put a vector to internalStruct without creating a new one with same type.

getReader

public FieldReader getReader()

Description copied from interface: ValueVector

Get a reader for this vector.

Specified by:

getReader in interface ValueVector

Returns:

a field reader that supports reading values from this vector.

getWriter

public FieldWriter getWriter()

getBufferSize

public int getBufferSize()

Description copied from interface: ValueVector

Get the number of bytes used by this vector.

Specified by:

getBufferSize in interface ValueVector

Returns:

the number of bytes that is used by this vector instance.

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

getBuffers

public ArrowBuf[] getBuffers(boolean clear)

Description copied from interface: ValueVector

Return the underlying buffers associated with this vector. Note that this doesn't impact the reference counts for this buffer so it only should be used for in-context access. Also note that this buffer changes regularly thus external classes shouldn't hold a reference to it (unless they change it).

Specified by:

getBuffers in interface ValueVector

Parameters:

clear - Whether to clear vector before returning; the buffers will still be refcounted; but the returned array will be the only reference to them

Returns:

The underlying buffers that is used by this vector instance.

iterator

public Iterator<ValueVector> iterator()

Specified by:

iterator in interface Iterable<ValueVector>

getVector

public ValueVector getVector(int index)

getVector

public ValueVector getVector(int index,
 ArrowType arrowType)

getVectorByType

public ValueVector getVectorByType(int typeId)

getVectorByType

public ValueVector getVectorByType(int typeId,
 ArrowType arrowType)

getObject

public Object getObject(int index)

Description copied from interface: ValueVector

Get friendly type object from the vector.

Specified by:

getObject in interface ValueVector

Parameters:

index - index of object to get

Returns:

friendly type object

get

public byte[] get(int index)

get

public void get(int index,
 ComplexHolder holder)

get

public void get(int index,
 UnionHolder holder)

getValueCount

public int getValueCount()

Description copied from interface: ValueVector

Gets the number of values.

Specified by:

getValueCount in interface ValueVector

Returns:

number of values in the vector

isNull

public boolean isNull(int index)

IMPORTANT: Union types always return non null as there is no validity buffer. To check validity correctly you must check the underlying vector.

Specified by:

isNull in interface ValueVector

Parameters:

index - index to check for null

Returns:

true if element is null

getNullCount

public int getNullCount()

Description copied from interface: ValueVector

Returns number of null elements in the vector.

Specified by:

getNullCount in interface ValueVector

Returns:

number of null elements

isSet

public int isSet(int index)

setValueCount

public void setValueCount(int valueCount)

Description copied from interface: ValueVector

Set number of values in the vector.

Specified by:

setValueCount in interface ValueVector

setSafe

public void setSafe(int index,
 UnionHolder holder)

setSafe

public void setSafe(int index,
 UnionHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableTinyIntHolder holder)

setSafe

public void setSafe(int index,
 NullableUInt1Holder holder)

setSafe

public void setSafe(int index,
 NullableUInt2Holder holder)

setSafe

public void setSafe(int index,
 NullableSmallIntHolder holder)

setSafe

public void setSafe(int index,
 NullableFloat2Holder holder)

setSafe

public void setSafe(int index,
 NullableIntHolder holder)

setSafe

public void setSafe(int index,
 NullableUInt4Holder holder)

setSafe

public void setSafe(int index,
 NullableFloat4Holder holder)

setSafe

public void setSafe(int index,
 NullableDateDayHolder holder)

setSafe

public void setSafe(int index,
 NullableIntervalYearHolder holder)

setSafe

public void setSafe(int index,
 NullableTimeSecHolder holder)

setSafe

public void setSafe(int index,
 NullableTimeMilliHolder holder)

setSafe

public void setSafe(int index,
 NullableBigIntHolder holder)

setSafe

public void setSafe(int index,
 NullableUInt8Holder holder)

setSafe

public void setSafe(int index,
 NullableFloat8Holder holder)

setSafe

public void setSafe(int index,
 NullableDateMilliHolder holder)

setSafe

public void setSafe(int index,
 NullableDurationHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableTimeStampSecHolder holder)

setSafe

public void setSafe(int index,
 NullableTimeStampMilliHolder holder)

setSafe

public void setSafe(int index,
 NullableTimeStampMicroHolder holder)

setSafe

public void setSafe(int index,
 NullableTimeStampNanoHolder holder)

setSafe

public void setSafe(int index,
 NullableTimeStampSecTZHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableTimeStampMilliTZHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableTimeStampMicroTZHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableTimeStampNanoTZHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableTimeMicroHolder holder)

setSafe

public void setSafe(int index,
 NullableTimeNanoHolder holder)

setSafe

public void setSafe(int index,
 NullableIntervalDayHolder holder)

setSafe

public void setSafe(int index,
 NullableIntervalMonthDayNanoHolder holder)

setSafe

public void setSafe(int index,
 NullableDecimal256Holder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableDecimalHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableFixedSizeBinaryHolder holder,
 ArrowType arrowType)

setSafe

public void setSafe(int index,
 NullableVarBinaryHolder holder)

setSafe

public void setSafe(int index,
 NullableVarCharHolder holder)

setSafe

public void setSafe(int index,
 NullableViewVarBinaryHolder holder)

setSafe

public void setSafe(int index,
 NullableViewVarCharHolder holder)

setSafe

public void setSafe(int index,
 NullableLargeVarCharHolder holder)

setSafe

public void setSafe(int index,
 NullableLargeVarBinaryHolder holder)

setSafe

public void setSafe(int index,
 NullableBitHolder holder)

setType

public void setType(int index,
 Types.MinorType type)

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

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

accept

public <OUT,
IN> OUT accept(VectorVisitor<OUT,IN> visitor,
 IN value)

Description copied from interface: ValueVector

Accept a generic VectorVisitor and return the result.

Specified by:

accept in interface ValueVector

Type Parameters:

OUT - the output result type.

IN - the input data together with visitor.

getName

public String getName()

Description copied from interface: ValueVector

Gets the name of the vector.

Specified by:

getName in interface ValueVector

Overrides:

getName in class AbstractContainerVector

Returns:

the name of the vector.

toString

public String toString()

Description copied from class: AbstractContainerVector

Representation of vector suitable for debugging.

Overrides:

toString in class AbstractContainerVector

addOrGet

public <T extends FieldVector> T addOrGet(String name,
 FieldType fieldType,
 Class<T> clazz)

Specified by:

addOrGet in class AbstractContainerVector

getChild

public <T extends FieldVector> T getChild(String name,
 Class<T> clazz)

Specified by:

getChild in class AbstractContainerVector

getChildVectorWithOrdinal

public VectorWithOrdinal getChildVectorWithOrdinal(String name)

Specified by:

getChildVectorWithOrdinal in class AbstractContainerVector

size

public int size()

Specified by:

size in class AbstractContainerVector

setInitialCapacity

public void setInitialCapacity(int valueCount,
 double density)

Description copied from interface: DensityAwareVector

Set value with density.

Specified by:

setInitialCapacity in interface DensityAwareVector

Parameters:

valueCount - the number of values in this vector

density - the density of the vector

setNull

public void setNull(int index)

Set the element at the given index to null. For UnionVector, it throws an UnsupportedOperationException as nulls are not supported at the top level and isNull() always returns false.

Specified by:

setNull in interface FieldVector

Parameters:

index - position of element

Throws:

UnsupportedOperationException - whenever invoked