org.apache.arrow.vector.complex

Class NullableMapVector

java.lang.Object

org.apache.arrow.vector.complex.AbstractContainerVector

org.apache.arrow.vector.complex.AbstractMapVector

org.apache.arrow.vector.complex.MapVector

org.apache.arrow.vector.complex.NullableMapVector

All Implemented Interfaces:

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

public class NullableMapVector
extends MapVector
implements FieldVector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	NullableMapVector.NullableMapTransferPair

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

MapVector.MapTransferPair

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrowBuf	validityBuffer

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

fieldType, valueCount

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

allocator, callBack, name

Constructor Summary

Constructors

Constructor and Description
NullableMapVector(String name, BufferAllocator allocator, CallBack callBack) Deprecated.
NullableMapVector(String name, BufferAllocator allocator, DictionaryEncoding dictionary, CallBack callBack) Deprecated.
NullableMapVector(String name, BufferAllocator allocator, FieldType fieldType, CallBack callBack)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allocateNewSafe() Allocates new buffers.
void	clear() Same as close()
void	close() Close the vector and release the associated buffers.
static NullableMapVector	empty(String name, BufferAllocator allocator)
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
Field	getField() Get information about how this field is materialized.
List<ArrowBuf>	getFieldBuffers() (same size as getFieldVectors() since it is their content)
List<BufferBacked>	getFieldInnerVectors() Deprecated.
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
NullableMapReaderImpl	getReader()
TransferPair	getTransferPair(BufferAllocator allocator) to transfer quota responsibility
TransferPair	getTransferPair(String ref, BufferAllocator allocator)
TransferPair	getTransferPair(String ref, BufferAllocator allocator, CallBack callBack)
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
NullableMapWriter	getWriter()
boolean	isNull(int index) Check whether an element in the vector is null
int	isSet(int index)
void	loadFieldBuffers(ArrowFieldNode fieldNode, List<ArrowBuf> ownBuffers) loads data in the vectors (ownBuffers must be the same size as getFieldVectors())
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()
void	setIndexDefined(int index)
void	setInitialCapacity(int numRecords) Set the initial record capacity
void	setNull(int index)
void	setValueCount(int valueCount) Set number of values in the vector

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

copyFromSafe, fieldNameIterator, getChildrenFromFields, getMinorType, getValueCount, getVectorById, initializeChildrenFromFields, supportsDirectRead

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

add, addOrGet, getChild, getChildByOrdinal, getChildFieldNames, getChildren, getChildVectorWithOrdinal, getPrimitiveVectors, iterator, putChild, putVector, size

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

addOrGetList, addOrGetMap, addOrGetUnion, allocateNew, getAllocator, getChild, typeify

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

getChildrenFromFields, initializeChildrenFromFields

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

allocateNew, getAllocator, getMinorType, getValueCount

Methods inherited from interface java.lang.Iterable

iterator

Field Detail

validityBuffer

protected ArrowBuf validityBuffer

Constructor Detail

NullableMapVector

@Deprecated
public NullableMapVector(String name,
                            BufferAllocator allocator,
                            CallBack callBack)

Deprecated.

NullableMapVector

@Deprecated
public NullableMapVector(String name,
                            BufferAllocator allocator,
                            DictionaryEncoding dictionary,
                            CallBack callBack)

Deprecated.

NullableMapVector

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

Method Detail

empty

public static NullableMapVector empty(String name,
                      BufferAllocator allocator)

getField

public Field getField()

Description copied from interface: ValueVector

Get information about how this field is materialized.

Specified by:

getField in interface ValueVector

Overrides:

getField in class MapVector

Returns:

the field corresponding to this vector

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

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

Specified by:

getFieldInnerVectors in interface FieldVector

Returns:

the inner vectors for this field as defined by the TypeLayout

getReader

public NullableMapReaderImpl getReader()

Specified by:

getReader in interface ValueVector

Overrides:

getReader in class MapVector

Returns:

a field reader that supports reading values from this vector.

getWriter

public NullableMapWriter 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 MapVector

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 MapVector

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)

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class MapVector

getTransferPair

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

Specified by:

getTransferPair in interface ValueVector

Overrides:

getTransferPair in class MapVector

getValueCapacity

public int getValueCapacity()

Get the current value capacity for the vector

Specified by:

getValueCapacity in interface ValueVector

Overrides:

getValueCapacity in class MapVector

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 AbstractMapVector

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 Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ValueVector

Overrides:

close in class MapVector

clear

public void clear()

Same as close()

Specified by:

clear in interface ValueVector

Overrides:

clear in class MapVector

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 MapVector

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 MapVector

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 MapVector

Parameters:

numRecords - the initial record capacity.

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 AbstractMapVector

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 AbstractMapVector

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 MapVector

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 MapVector

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 MapVector

Returns:

buffer

getObject

public Object 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 MapVector

Returns:

get

public void get(int index,
       ComplexHolder holder)

Overrides:

get in class MapVector

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 MapVector

Returns:

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 MapVector

Returns:

isSet

public int isSet(int index)

setIndexDefined

public void setIndexDefined(int index)

setNull

public void setNull(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

Overrides:

setValueCount in class MapVector

reset

public void reset()