org.apache.drill.exec.vector.complex

Class AbstractRepeatedMapVector

java.lang.Object

org.apache.drill.exec.vector.complex.AbstractContainerVector

org.apache.drill.exec.vector.complex.AbstractMapVector

org.apache.drill.exec.vector.complex.AbstractRepeatedMapVector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ValueVector>, ContainerVectorLike, RepeatedValueVector, ValueVector

Direct Known Subclasses:

DictVector, RepeatedMapVector

public abstract class AbstractRepeatedMapVector
extends AbstractMapVector
implements RepeatedValueVector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractRepeatedMapVector.Accessor
class	AbstractRepeatedMapVector.Mutator

Nested classes/interfaces inherited from interface org.apache.drill.exec.vector.complex.RepeatedValueVector

RepeatedValueVector.RepeatedAccessor, RepeatedValueVector.RepeatedMutator

Field Summary

Fields

Modifier and Type	Field and Description
protected EmptyValuePopulator	emptyPopulator
protected UInt4Vector	offsets

Fields inherited from class org.apache.drill.exec.vector.complex.AbstractContainerVector

allocator, callBack, field

Fields inherited from interface org.apache.drill.exec.vector.complex.RepeatedValueVector

DEFAULT_REPEAT_PER_RECORD

Fields inherited from interface org.apache.drill.exec.vector.ValueVector

BITS_VECTOR_NAME, MAX_BUFFER_SIZE, MAX_ROW_COUNT, MIN_ROW_COUNT, OFFSETS_VECTOR_NAME, VALUES_VECTOR_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRepeatedMapVector(MaterializedField field, BufferAllocator allocator, CallBack callBack)
protected	AbstractRepeatedMapVector(MaterializedField field, UInt4Vector offsets, CallBack callBack)

Method Summary

Modifier and Type	Method and Description
<T extends ValueVector> AddOrGetResult<T>	addOrGetVector(VectorDescriptor descriptor) Creates and adds a child vector if none with the same name exists, else returns the vector instance.
void	allocateNew(int groupCount, int innerValueCount)
boolean	allocateNewSafe() Allocates new buffers.
void	allocateOffsetsNew(int groupCount)
void	clear() Release the underlying DrillBuf and reset the ValueVector to empty.
void	close() Clears out all underlying child vectors.
void	collectLedgers(Set<AllocationManager.BufferLedger> ledgers) Add the ledgers underlying the buffers underlying the components of the vector to the set provided.
void	copyEntry(int toIndex, ValueVector from, int fromIndex)
void	copyFromSafe(int fromIndex, int thisIndex, AbstractRepeatedMapVector from)
void	exchange(ValueVector other) Exchange state with another value vector of the same type.
Iterator<String>	fieldNameIterator()
abstract AbstractRepeatedMapVector.Accessor	getAccessor() Returns an accessor that is used to read from this vector instance.
int	getAllocatedSize() Returns the total size of buffers allocated by this vector.
DrillBuf[]	getBuffers(boolean clear) Return the underlying buffers associated with this vector.
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.
ValueVector	getDataVector()
UserBitShared.SerializedField	getMetadata() Get the metadata for this field.
UInt4Vector	getOffsetVector()
int	getPayloadByteCount(int valueCount) Return the number of value bytes consumed by actual data.
List<ValueVector>	getPrimitiveVectors() Returns a list of scalar child vectors recursing the entire vector hierarchy.
TransferPair	getTransferPairToSingleMap(String reference, BufferAllocator allocator)
int	getValueCapacity() Returns the maximum number of values that can be stored in this vector instance.
void	load(UserBitShared.SerializedField metadata, DrillBuf buffer) Load the data provided in the buffer.
void	setInitialCapacity(int numRecords) Set the initial record capacity
void	toNullable(ValueVector nullableVector) Convert a non-nullable vector to nullable by shuffling the data from one to the other.

Methods inherited from class org.apache.drill.exec.vector.complex.AbstractMapVector

addOrGet, getChild, getChildByOrdinal, getChildren, getChildVectorWithOrdinal, iterator, putChild, putVector, size

Methods inherited from class org.apache.drill.exec.vector.complex.AbstractContainerVector

allocateNew, getAllocator, getChild, getChildFieldNames, getField, supportsDirectRead, 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.drill.exec.vector.complex.RepeatedValueVector

getMutator

Methods inherited from interface org.apache.drill.exec.vector.ValueVector

allocateNew, getAllocator, getField, getReader, getTransferPair, getTransferPair, makeTransferPair

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.apache.drill.exec.vector.complex.ContainerVectorLike

size

Field Detail

offsets

protected final UInt4Vector offsets

emptyPopulator

protected final EmptyValuePopulator emptyPopulator

Constructor Detail

AbstractRepeatedMapVector

protected AbstractRepeatedMapVector(MaterializedField field,
                                    BufferAllocator allocator,
                                    CallBack callBack)

AbstractRepeatedMapVector

protected AbstractRepeatedMapVector(MaterializedField field,
                                    UInt4Vector offsets,
                                    CallBack callBack)

Method Detail

getOffsetVector

public UInt4Vector getOffsetVector()

Specified by:

getOffsetVector in interface RepeatedValueVector

Returns:

the underlying offset vector or null if none exists.

getDataVector

public ValueVector getDataVector()

Specified by:

getDataVector in interface RepeatedValueVector

Returns:

the underlying data vector or null if none exists.

addOrGetVector

public <T extends ValueVector> AddOrGetResult<T> addOrGetVector(VectorDescriptor descriptor)

Description copied from interface: ContainerVectorLike

Creates and adds a child vector if none with the same name exists, else returns the vector instance.

Specified by:

addOrGetVector in interface ContainerVectorLike

Parameters:

descriptor - vector descriptor

Returns:

result of operation wrapping vector corresponding to the given descriptor and whether it's newly created

setInitialCapacity

public void setInitialCapacity(int numRecords)

Description copied from interface: ValueVector

Set the initial record capacity

Specified by:

setInitialCapacity in interface ValueVector

allocateNew

public void allocateNew(int groupCount,
                        int innerValueCount)

allocateOffsetsNew

public void allocateOffsetsNew(int groupCount)

fieldNameIterator

public Iterator<String> fieldNameIterator()

getPrimitiveVectors

public List<ValueVector> getPrimitiveVectors()

Description copied from class: AbstractMapVector

Returns a list of scalar child vectors recursing the entire vector hierarchy.

Overrides:

getPrimitiveVectors in class AbstractMapVector

getBufferSize

public int getBufferSize()

Description copied from interface: ValueVector

Returns the number of bytes that is used by this vector instance. This is a bit of a misnomer. Returns the number of bytes used by data in this instance.

Specified by:

getBufferSize in interface ValueVector

Overrides:

getBufferSize in class AbstractMapVector

getAllocatedSize

public int getAllocatedSize()

Description copied from interface: ValueVector

Returns the total size of buffers allocated by this vector. Has meaning only when vectors are directly allocated and each vector has its own buffer. Does not have meaning for vectors deserialized from the network or disk in which multiple vectors share the same vector.

Specified by:

getAllocatedSize in interface ValueVector

Overrides:

getAllocatedSize in class AbstractMapVector

Returns:

allocated buffer size, in bytes

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.

Specified by:

getBufferSizeFor in interface ValueVector

Parameters:

valueCount - the number of values to assume this vector contains

Returns:

the buffer size if this vector is holding valueCount values

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

getTransferPairToSingleMap

public TransferPair getTransferPairToSingleMap(String reference,
                                               BufferAllocator allocator)

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.

copyFromSafe

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

copyEntry

public void copyEntry(int toIndex,
                      ValueVector from,
                      int fromIndex)

Specified by:

copyEntry in interface ValueVector

getValueCapacity

public int getValueCapacity()

Description copied from interface: ValueVector

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

Specified by:

getValueCapacity in interface ValueVector

exchange

public void exchange(ValueVector other)

Description copied from interface: ValueVector

Exchange state with another value vector of the same type. Used to implement look-ahead writers.

Specified by:

exchange in interface ValueVector

Overrides:

exchange in class AbstractMapVector

getBuffers

public DrillBuf[] getBuffers(boolean clear)

Description copied from interface: ValueVector

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.

load

public void load(UserBitShared.SerializedField metadata,
                 DrillBuf buffer)

Description copied from interface: ValueVector

Load the data provided in the buffer. Typically used when deserializing from the wire.

Specified by:

load in interface ValueVector

Parameters:

metadata - Metadata used to decode the incoming buffer.

buffer - The buffer that contains the ValueVector.

getMetadata

public UserBitShared.SerializedField getMetadata()

Description copied from interface: ValueVector

Get the metadata for this field. Used in serialization

Specified by:

getMetadata in interface ValueVector

Returns:

FieldMetadata for this field.

clear

public void clear()

Description copied from interface: ValueVector

Release the underlying DrillBuf and reset the ValueVector to empty.

Specified by:

clear in interface ValueVector

collectLedgers

public void collectLedgers(Set<AllocationManager.BufferLedger> ledgers)

Description copied from interface: ValueVector

Add the ledgers underlying the buffers underlying the components of the vector to the set provided. Used to determine actual memory allocation.

Specified by:

collectLedgers in interface ValueVector

Overrides:

collectLedgers in class AbstractMapVector

Parameters:

ledgers - set of ledgers to which to add ledgers for this vector

toNullable

public void toNullable(ValueVector nullableVector)

Description copied from interface: ValueVector

Convert a non-nullable vector to nullable by shuffling the data from one to the other. Avoids the need to generate copy code just to change mode. If this vector is non-nullable, accepts a nullable dual (same minor type, different mode.) If the vector is non-nullable, or non-scalar, then throws an exception.

Specified by:

toNullable in interface ValueVector

Parameters:

nullableVector - nullable vector of the same minor type as this vector

getPayloadByteCount

public int getPayloadByteCount(int valueCount)

Description copied from interface: ValueVector

Return the number of value bytes consumed by actual data.

Specified by:

getPayloadByteCount in interface ValueVector

Overrides:

getPayloadByteCount in class AbstractMapVector

getAccessor

public abstract AbstractRepeatedMapVector.Accessor getAccessor()

Description copied from interface: ValueVector

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

Specified by:

getAccessor in interface RepeatedValueVector

Specified by:

getAccessor in interface ValueVector