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
class	MapVector.Accessor
protected static class	MapVector.MapTransferPair
class	MapVector.Mutator

Field Summary

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)

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)
Iterator<String>	fieldNameIterator()
MapVector.Accessor	getAccessor() Returns an accessor that is used to read from this vector instance.
int	getBufferSize() Returns the number of bytes that is used by this vector instance.
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()
Field	getField() Get information about how this field is materialized.
Types.MinorType	getMinorType()
MapVector.Mutator	getMutator() Returns an mutator that is used to write to this vector instance.
FieldReader	getReader() Returns a field reader that supports reading values from this vector.
TransferPair	getTransferPair(BufferAllocator allocator) Returns a transfer pair, creating a new target vector of the same type.
TransferPair	getTransferPair(String ref, BufferAllocator allocator)
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
ValueVector	getVectorById(int id)
void	initializeChildrenFromFields(List<Field> children)
TransferPair	makeTransferPair(ValueVector to) Returns a new transfer pair that is used to transfer underlying buffers into the target vector.
void	setInitialCapacity(int numRecords) Set the initial record capacity
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, size

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

allocateNew, getAllocator, getChild, typeify

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapVector

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

Method Detail

getReader

public FieldReader getReader()

Description copied from interface: ValueVector

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

Description copied from interface: ValueVector

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

Specified by:

getBufferSize in interface ValueVector

Overrides:

getBufferSize in class AbstractMapVector

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

getTransferPair

public TransferPair getTransferPair(BufferAllocator allocator)

Description copied from interface: ValueVector

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

makeTransferPair

public TransferPair makeTransferPair(ValueVector to)

Description copied from interface: ValueVector

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.

getAccessor

public MapVector.Accessor getAccessor()

Description copied from interface: ValueVector

Returns an accessor that is used to read from this vector instance.

getMutator

public MapVector.Mutator getMutator()

Description copied from interface: ValueVector

Returns an mutator that is used to write to this vector instance.

getVectorById

public ValueVector getVectorById(int id)

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.

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