org.apache.arrow.vector.complex

Class MapVector

java.lang.Object

org.apache.arrow.vector.complex.AbstractContainerVector

org.apache.arrow.vector.complex.AbstractMapVector

org.apache.arrow.vector.complex.MapVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, ValueVector

Direct Known Subclasses:

NullableMapVector

public class MapVector
extends AbstractMapVector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MapVector.MapTransferPair

Field Summary

Fields

Modifier and Type	Field and Description
protected FieldType	fieldType
int	valueCount

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

allocator, callBack, name

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Release the underlying ArrowBuf and reset the ValueVector to empty.
void	close() Clears out all underlying child vectors.
void	copyFromSafe(int fromIndex, int thisIndex, MapVector from)
static MapVector	empty(String name, BufferAllocator allocator)
Iterator<String>	fieldNameIterator()
void	get(int index, ComplexHolder holder)
int	getBufferSize()
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
Object	getObject(int index) Get friendly type object from the vector
ArrowBuf	getOffsetBuffer() Gets the underlying buffer associated with offset vector
FieldReader	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
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)
void	initializeChildrenFromFields(List<Field> children)
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	setInitialCapacity(int numRecords) Set the initial record capacity
void	setValueCount(int valueCount) Set number of values in the vector
protected boolean	supportsDirectRead()

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

add, addOrGet, allocateNewSafe, getBuffers, getChild, getChildByOrdinal, getChildFieldNames, getChildren, getChildVectorWithOrdinal, getPrimitiveVectors, iterator, putChild, putVector, reAlloc, 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

Field Detail

fieldType

protected final FieldType fieldType

valueCount

public int valueCount

Constructor Detail

MapVector

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

Deprecated.

MapVector

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

Method Detail

empty

public static MapVector empty(String name,
              BufferAllocator allocator)

getReader

public FieldReader getReader()

Returns:

a field reader that supports reading values from this vector.

copyFromSafe

public void copyFromSafe(int fromIndex,
                int thisIndex,
                MapVector from)

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.

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface ValueVector

Overrides:

getBufferSize in class AbstractMapVector

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)

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)

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 Object getObject(int index)

Description copied from interface: ValueVector

Get friendly type object from the vector

Returns:

isNull

public boolean isNull(int index)

Description copied from interface: ValueVector

Check whether an element in the vector is null

Returns:

getNullCount

public int getNullCount()

Description copied from interface: ValueVector

Returns number of null elements in the vector

Returns:

get

public void get(int index,
       ComplexHolder holder)

getValueCount

public int getValueCount()

Description copied from interface: ValueVector

Gets the number of values

Returns:

getVectorById

public ValueVector getVectorById(int id)

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 the underlying ArrowBuf and reset the ValueVector to empty.

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 AbstractMapVector

initializeChildrenFromFields

public void initializeChildrenFromFields(List<Field> children)

getChildrenFromFields

public List<FieldVector> getChildrenFromFields()