org.apache.arrow.vector.complex

Class NonNullableStructVector

java.lang.Object

org.apache.arrow.vector.complex.AbstractContainerVector

org.apache.arrow.vector.complex.AbstractStructVector

org.apache.arrow.vector.complex.NonNullableStructVector

All Implemented Interfaces:

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

Direct Known Subclasses:

StructVector

public class NonNullableStructVector
extends AbstractStructVector

A struct vector that has no null values (and no validity buffer). Child Vectors are handled in AbstractStructVector.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	NonNullableStructVector.StructTransferPair TransferPair for this this class.

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

AbstractStructVector.ConflictPolicy

Field Summary

Fields

Modifier and Type	Field and Description
protected Field	field
int	valueCount

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

allowConflictPolicyChanges

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

allocator, callBack, name

Constructor Summary

Constructors

Constructor and Description
NonNullableStructVector(Field field, BufferAllocator allocator, CallBack callBack) Constructs a new instance.
NonNullableStructVector(Field field, BufferAllocator allocator, CallBack callBack, AbstractStructVector.ConflictPolicy conflictPolicy, boolean allowConflictPolicyChanges) Constructs a new instance.
NonNullableStructVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack callBack) Constructs a new instance.
NonNullableStructVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack callBack, AbstractStructVector.ConflictPolicy conflictPolicy, boolean allowConflictPolicyChanges) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
<OUT,IN> OUT	accept(VectorVisitor<OUT,IN> visitor, IN value) Accept a generic VectorVisitor and return the result.
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 fromIndex, int thisIndex, ValueVector from) Copies the element at fromIndex in the provided vector to thisIndex.
void	copyFromSafe(int fromIndex, int thisIndex, 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.
static NonNullableStructVector	empty(String name, BufferAllocator allocator)
static NonNullableStructVector	emptyWithDuplicates(String name, BufferAllocator allocator)
Iterator<String>	fieldNameIterator()
void	get(int index, ComplexHolder holder)
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.
List<FieldVector>	getChildrenFromFields()
ArrowBuf	getDataBuffer() Gets the underlying buffer associated with data vector.
Field	getField() Get information about how this field is materialized.
Types.MinorType	getMinorType()
int	getNullCount() Returns number of null elements in the vector.
Map<String,?>	getObject(int index) Get friendly type object from the vector.
ArrowBuf	getOffsetBuffer() Gets the underlying buffer associated with offset vector.
FieldReader	getReader() Get a reader for this vector.
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.
TransferPair	getTransferPair(String ref, BufferAllocator allocator) To transfer quota responsibility.
TransferPair	getTransferPair(String ref, BufferAllocator allocator, CallBack callBack) To transfer quota responsibility.
ArrowBuf	getValidityBuffer() Gets 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.
ValueVector	getVectorById(int id)
<V extends ValueVector> V	getVectorById(int id, Class<V> clazz) Gets a child vector by ordinal position and casts to the specified class.
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 struct's members from the given Fields.
boolean	isNull(int index) Check whether an element in the vector is null.
TransferPair	makeTransferPair(ValueVector to) Makes a new transfer pair used to transfer underlying buffers.
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	setValueCount(int valueCount) Set number of values in the vector.
protected boolean	supportsDirectRead()

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

add, addOrGet, allocateNewSafe, getBuffers, getChild, getChildByOrdinal, getChildFieldNames, getChildren, getChildVectorWithOrdinal, getConflictPolicy, getPrimitiveVectors, iterator, putChild, putVector, reAlloc, setConflictPolicy, size, toString

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

addOrGetFixedSizeList, addOrGetList, addOrGetMap, addOrGetStruct, addOrGetUnion, allocateNew, getAllocator, getChild, getName, 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.ValueVector

validate, validateFull

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

field

protected Field field

valueCount

public int valueCount

Constructor Detail

NonNullableStructVector

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

Constructs a new instance.

Parameters:

name - The name of the instance.

allocator - The allocator to use to allocating/reallocating buffers.

fieldType - The type of this list.

NonNullableStructVector

public NonNullableStructVector(Field field,
                               BufferAllocator allocator,
                               CallBack callBack)

Constructs a new instance.

Parameters:

field - The field materialized by this vector.

allocator - The allocator to use to allocating/reallocating buffers.

callBack - A schema change callback.

NonNullableStructVector

public NonNullableStructVector(String name,
                               BufferAllocator allocator,
                               FieldType fieldType,
                               CallBack callBack,
                               AbstractStructVector.ConflictPolicy conflictPolicy,
                               boolean allowConflictPolicyChanges)

Constructs a new instance.

Parameters:

name - The name of the instance.

allocator - The allocator to use to allocating/reallocating buffers.

fieldType - The type of this list.

callBack - A schema change callback.

conflictPolicy - How to handle duplicate field names in the struct.

NonNullableStructVector

public NonNullableStructVector(Field field,
                               BufferAllocator allocator,
                               CallBack callBack,
                               AbstractStructVector.ConflictPolicy conflictPolicy,
                               boolean allowConflictPolicyChanges)

Constructs a new instance.

Parameters:

field - The field materialized by this vector.

allocator - The allocator to use to allocating/reallocating buffers.

callBack - A schema change callback.

conflictPolicy - How to handle duplicate field names in the struct.

Method Detail

empty

public static NonNullableStructVector empty(String name,
                                            BufferAllocator allocator)

emptyWithDuplicates

public static NonNullableStructVector emptyWithDuplicates(String name,
                                                          BufferAllocator allocator)

getReader

public FieldReader getReader()

Description copied from interface: ValueVector

Get a reader for this vector.

Returns:

a field reader that supports reading values from this vector.

copyFrom

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

Copies the element at fromIndex in the provided vector to thisIndex. Reallocates buffers if thisIndex is larger then current capacity.

Specified by:

copyFrom in interface ValueVector

Overrides:

copyFrom in class AbstractContainerVector

Parameters:

fromIndex - position to copy from in source vector

thisIndex - position to copy to in this vector

from - source vector

copyFromSafe

public void copyFromSafe(int fromIndex,
                         int thisIndex,
                         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:

fromIndex - position to copy from in source vector

thisIndex - position to copy to in this vector

from - source vector

supportsDirectRead

protected boolean supportsDirectRead()

Overrides:

supportsDirectRead in class AbstractContainerVector

fieldNameIterator

public Iterator<String> fieldNameIterator()

setInitialCapacity

public void setInitialCapacity(int numRecords)

Description copied from interface: ValueVector

Set the initial record capacity.

Parameters:

numRecords - the initial record capacity.

setInitialCapacity

public void setInitialCapacity(int valueCount,
                               double density)

Description copied from interface: DensityAwareVector

Set value with density.

Parameters:

valueCount - the number of values in this vector

density - the density of the vector

getBufferSize

public int getBufferSize()

Description copied from interface: ValueVector

Get the number of bytes used by this vector.

Specified by:

getBufferSize in interface ValueVector

Overrides:

getBufferSize in class AbstractStructVector

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.

Parameters:

valueCount - the number of values to assume this vector contains

Returns:

the buffer size if this vector is holding valueCount values

getValidityBuffer

public ArrowBuf getValidityBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with validity vector.

Returns:

buffer

getDataBuffer

public ArrowBuf getDataBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with data vector.

Returns:

buffer

getOffsetBuffer

public ArrowBuf getOffsetBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with offset vector.

Returns:

buffer

getTransferPair

public TransferPair getTransferPair(BufferAllocator allocator)

Description copied from interface: ValueVector

To transfer quota responsibility.

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

Description copied from interface: ValueVector

To transfer quota responsibility.

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.

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

Description copied from interface: ValueVector

Makes a new transfer pair used to transfer underlying buffers.

Parameters:

to - the target for the transfer

Returns:

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

getTransferPair

public TransferPair getTransferPair(String ref,
                                    BufferAllocator allocator)

Description copied from interface: ValueVector

To transfer quota responsibility.

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(Field field,
                                    BufferAllocator allocator)

Description copied from interface: ValueVector

To transfer quota responsibility.

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.

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.

getValueCapacity

public int getValueCapacity()

Description copied from interface: ValueVector

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

Returns:

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

getObject

public Map<String,?> getObject(int index)

Description copied from interface: ValueVector

Get friendly type object from the vector.

Parameters:

index - index of object to get

Returns:

friendly type object

hashCode

public int hashCode(int index)

Description copied from interface: ValueVector

Returns hashCode of element in index with the default hasher.

hashCode

public int hashCode(int index,
                    ArrowBufHasher hasher)

Description copied from interface: ValueVector

Returns hashCode of element in index with the given hasher.

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.

Type Parameters:

OUT - the output result type.

IN - the input data together with visitor.

isNull

public boolean isNull(int index)

Description copied from interface: ValueVector

Check whether an element in the vector is null.

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.

Returns:

number of null elements

get

public void get(int index,
                ComplexHolder holder)

getValueCount

public int getValueCount()

Description copied from interface: ValueVector

Gets the number of values.

Returns:

number of values in the vector

getVectorById

public ValueVector getVectorById(int id)

getVectorById

public <V extends ValueVector> V getVectorById(int id,
                                               Class<V> clazz)

Gets a child vector by ordinal position and casts to the specified class.

setValueCount

public void setValueCount(int valueCount)

Description copied from interface: ValueVector

Set number of values in the vector.

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.

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.

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Returns:

the field corresponding to this vector

getMinorType

public Types.MinorType getMinorType()

close

public void close()

Description copied from class: AbstractContainerVector

Clears out all underlying child vectors.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ValueVector

Overrides:

close in class AbstractStructVector

initializeChildrenFromFields

public void initializeChildrenFromFields(List<Field> children)

Initializes the struct's members from the given Fields.

getChildrenFromFields

public List<FieldVector> getChildrenFromFields()