Package org.apache.arrow.vector.complex

Class StructVector

java.lang.Object

org.apache.arrow.vector.complex.AbstractContainerVector

org.apache.arrow.vector.complex.AbstractStructVector

org.apache.arrow.vector.complex.NonNullableStructVector

org.apache.arrow.vector.complex.StructVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, DensityAwareVector, FieldVector, ValueIterableVector<Map<String,?>>, ValueVector

public class StructVector
extends NonNullableStructVector
implements FieldVector, ValueIterableVector<Map<String,?>>

A Struct vector consists of nullability/validity buffer and children vectors that make up the struct's fields. The children vectors are handled by the parent class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	StructVector.NullableStructTransferPair	TransferPair for this (nullable) StructVector.

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

NonNullableStructVector.StructTransferPair

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

AbstractStructVector.ConflictPolicy

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrowBuf	validityBuffer

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

field, 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	Description
StructVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack callBack)	Constructs a new instance.
StructVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack callBack, AbstractStructVector.ConflictPolicy conflictPolicy, boolean allowConflictPolicyChanges)	Constructs a new instance.
StructVector(Field field, BufferAllocator allocator, CallBack callBack)	Constructs a new instance.
StructVector(Field field, BufferAllocator allocator, CallBack callBack, AbstractStructVector.ConflictPolicy conflictPolicy, boolean allowConflictPolicyChanges)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	allocateNewSafe()	Allocates new buffers.
void	clear()	Same as close().
void	close()	Close the vector and release the associated buffers.
static StructVector	empty(String name, BufferAllocator allocator)	Construct a new empty instance which replaces an existing field with the new one in case of name conflict.
static StructVector	emptyWithDuplicates(String name, BufferAllocator allocator)	Construct a new empty instance which preserve fields with identical names.
void	get(int index, ComplexHolder holder)
ArrowBuf[]	getBuffers(boolean clear)	Return the underlying buffers associated with this vector.
int	getBufferSize()	Get the size (number of bytes) of underlying buffers used by this vector.
int	getBufferSizeFor(int valueCount)	Get the potential buffer size for a particular number of records.
ArrowBuf	getDataBuffer()	Gets the underlying buffer associated with data vector.
long	getDataBufferAddress()	Gets the starting address of the underlying buffer associated with data vector.
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.
int	getNullCount()	Return the number of null values 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.
long	getOffsetBufferAddress()	Gets the starting address of the underlying buffer associated with offset vector.
NullableStructReaderImpl	getReader()	Get a reader for this vector.
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	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()	Get the current value capacity for the vector.
NullableStructWriter	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.
boolean	isNull(int index)	Returns true if the value at the provided index is null.
int	isSet(int index)	Returns true the value at the given index is set (i.e.
void	loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers)	Loads data in the vectors.
TransferPair	makeTransferPair(ValueVector to)	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 this vector to empty, does not release buffers.
void	setIndexDefined(int index)	Marks the value at index as being set.
void	setInitialCapacity(int numRecords)	Set the initial record capacity.
void	setInitialCapacity(int numRecords, double density)	Set value with density.
void	setNull(int index)	Marks the value at index as null/not set.
void	setValueCount(int valueCount)	Set number of values in the vector.

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

accept, copyFrom, copyFromSafe, fieldNameIterator, getChildrenFromFields, getField, getMinorType, getValueCount, getVectorById, getVectorById, initializeChildrenFromFields, supportsDirectRead

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

add, addOrGet, getChild, getChildByOrdinal, getChildFieldNames, getChildren, getChildVectorWithOrdinal, getConflictPolicy, getPrimitiveVectors, iterator, putChild, putVector, 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.FieldVector

exportBuffer, exportCDataBuffers, getChildrenFromFields, getExportedCDataBufferCount, initializeChildrenFromFields

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

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

getValueIterable, getValueIterator

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

accept, allocateNew, copyFrom, copyFromSafe, getAllocator, getField, getMinorType, getName, getValueCount, validate, validateFull

Field Details

validityBuffer

protected ArrowBuf validityBuffer

Constructor Details

StructVector

public StructVector(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.

callBack - A schema change callback.

StructVector

public StructVector(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 - policy to determine how duplicate names are handled.

allowConflictPolicyChanges - whether duplicate names are allowed at all.

StructVector

public StructVector(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.

StructVector

public StructVector(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 - policy to determine how duplicate names are handled.

allowConflictPolicyChanges - whether duplicate names are allowed at all.

Method Details

empty

public static StructVector empty(String name,
 BufferAllocator allocator)

Construct a new empty instance which replaces an existing field with the new one in case of name conflict.

emptyWithDuplicates

public static StructVector emptyWithDuplicates(String name,
 BufferAllocator allocator)

Construct a new empty instance which preserve fields with identical names.

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

getReader

public NullableStructReaderImpl getReader()

Description copied from interface: ValueVector

Get a reader for this vector.

Specified by:

getReader in interface ValueVector

Overrides:

getReader in class NonNullableStructVector

Returns:

a field reader that supports reading values from this vector.

getWriter

public NullableStructWriter getWriter()

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 NonNullableStructVector

Parameters:

allocator - the target allocator

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.

Specified by:

makeTransferPair in interface ValueVector

Overrides:

makeTransferPair in class NonNullableStructVector

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.

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class NonNullableStructVector

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

Overrides:

getTransferPair in class NonNullableStructVector

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

Overrides:

getTransferPair in class NonNullableStructVector

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

Overrides:

getTransferPair in class NonNullableStructVector

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

Get the current value capacity for the vector.

Specified by:

getValueCapacity in interface ValueVector

Overrides:

getValueCapacity in class NonNullableStructVector

Returns:

number of elements that vector can hold.

getBuffers

public ArrowBuf[] getBuffers(boolean clear)

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

Overrides:

getBuffers in class AbstractStructVector

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.

close

public void close()

Close the vector and release the associated buffers.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface ValueVector

Overrides:

close in class NonNullableStructVector

clear

public void clear()

Same as close().

Specified by:

clear in interface ValueVector

Overrides:

clear in class NonNullableStructVector

reset

public void reset()

Reset this vector to empty, does not release buffers.

Specified by:

reset in interface ValueVector

Overrides:

reset in class NonNullableStructVector

getBufferSize

public int getBufferSize()

Get the size (number of bytes) of underlying buffers used by this vector.

Specified by:

getBufferSize in interface ValueVector

Overrides:

getBufferSize in class NonNullableStructVector

Returns:

size of underlying buffers.

getBufferSizeFor

public int getBufferSizeFor(int valueCount)

Get the potential buffer size for a particular number of records.

Specified by:

getBufferSizeFor in interface ValueVector

Overrides:

getBufferSizeFor in class NonNullableStructVector

Parameters:

valueCount - desired number of elements in the vector

Returns:

estimated size of underlying buffers if the vector holds a given number of elements

setInitialCapacity

public void setInitialCapacity(int numRecords)

Description copied from interface: ValueVector

Set the initial record capacity.

Specified by:

setInitialCapacity in interface ValueVector

Overrides:

setInitialCapacity in class NonNullableStructVector

Parameters:

numRecords - the initial record capacity.

setInitialCapacity

public void setInitialCapacity(int numRecords,
 double density)

Description copied from interface: DensityAwareVector

Set value with density.

Specified by:

setInitialCapacity in interface DensityAwareVector

Overrides:

setInitialCapacity in class NonNullableStructVector

Parameters:

numRecords - the number of values in this vector

density - the density of the vector

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

Overrides:

allocateNewSafe in class AbstractStructVector

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

Overrides:

reAlloc in class AbstractStructVector

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

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

getValidityBuffer

public ArrowBuf getValidityBuffer()

Description copied from interface: ValueVector

Gets the underlying buffer associated with validity vector.

Specified by:

getValidityBuffer in interface ValueVector

Overrides:

getValidityBuffer in class NonNullableStructVector

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

Overrides:

getDataBuffer in class NonNullableStructVector

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

Overrides:

getOffsetBuffer in class NonNullableStructVector

Returns:

buffer

getObject

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

Description copied from interface: ValueVector

Get friendly type object from the vector.

Specified by:

getObject in interface ValueVector

Overrides:

getObject in class NonNullableStructVector

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.

Specified by:

hashCode in interface ValueVector

Overrides:

hashCode in class NonNullableStructVector

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 NonNullableStructVector

get

public void get(int index,
 ComplexHolder holder)

Overrides:

get in class NonNullableStructVector

getNullCount

public int getNullCount()

Return the number of null values in the vector.

Specified by:

getNullCount in interface ValueVector

Overrides:

getNullCount in class NonNullableStructVector

Returns:

number of null elements

isNull

public boolean isNull(int index)

Returns true if the value at the provided index is null.

Specified by:

isNull in interface ValueVector

Overrides:

isNull in class NonNullableStructVector

Parameters:

index - index to check for null

Returns:

true if element is null

isSet

public int isSet(int index)

Returns true the value at the given index is set (i.e. not null).

setIndexDefined

public void setIndexDefined(int index)

Marks the value at index as being set. Reallocates the validity buffer if index is larger than current capacity.

setNull

public void setNull(int index)

Marks the value at index as null/not set.

Specified by:

setNull in interface FieldVector

Parameters:

index - the value to change

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 NonNullableStructVector