org.apache.drill.exec.record

Class VectorContainer

java.lang.Object

org.apache.drill.exec.record.VectorContainer

All Implemented Interfaces:

Iterable<VectorWrapper<?>>, VectorAccessible

Direct Known Subclasses:

ExpandableHyperContainer

public class VectorContainer
extends Object
implements VectorAccessible

Field Summary

Fields

Modifier and Type	Field and Description
protected List<VectorWrapper<?>>	wrappers

Constructor Summary

Constructors

Constructor and Description
VectorContainer()
VectorContainer(BufferAllocator allocator)
VectorContainer(BufferAllocator allocator, BatchSchema schema) Create a new vector container given a pre-defined schema.
VectorContainer(OperatorContext oContext)

Method Summary

Methods

Modifier and Type	Method and Description
TypedFieldId	add(ValueVector vv)
void	add(ValueVector[] hyperVector)
void	add(ValueVector[] hyperVector, boolean releasable)
void	addCollection(Iterable<ValueVector> vectors)
void	addHyperList(List<ValueVector> vectors)
void	addHyperList(List<ValueVector> vectors, boolean releasable)
<T extends ValueVector> T	addOrGet(MaterializedField field)
<T extends ValueVector> T	addOrGet(MaterializedField field, SchemaChangeCallBack callBack)
<T extends ValueVector> T	addOrGet(String name, TypeProtos.MajorType type, Class<T> clazz)
void	allocateNew()
boolean	allocateNewSafe()
void	buildSchema(BatchSchema.SelectionVectorMode mode)
void	clear()
BufferAllocator	getAllocator()
int	getNumberOfColumns()
int	getRecordCount() Get the number of records.
BatchSchema	getSchema() Get the schema of the current RecordBatch.
SelectionVector2	getSelectionVector2()
SelectionVector4	getSelectionVector4()
static VectorContainer	getTransferClone(VectorAccessible incoming, BufferAllocator allocator)
static VectorContainer	getTransferClone(VectorAccessible incoming, OperatorContext oContext) Get a set of transferred clones of this container.
static VectorContainer	getTransferClone(VectorAccessible incoming, VectorWrapper<?>[] ignoreWrappers, OperatorContext oContext)
VectorWrapper<?>	getValueAccessorById(Class<?> clazz, int... fieldIds)
VectorWrapper<?>	getValueVector(int index)
TypedFieldId	getValueVectorId(SchemaPath path) Get the value vector type and id for the given schema path.
boolean	hasRecordCount()
boolean	hasSchema()
boolean	isSchemaChanged()
Iterator<VectorWrapper<?>>	iterator()
VectorContainer	merge(VectorContainer otherContainer) Merge two batches to create a single, combined, batch.
void	remove(ValueVector v)
void	setRecordCount(int recordCount)
String	toString()
void	transferIn(VectorContainer containerIn) Transfer vectors from containerIn to this.
void	transferOut(VectorContainer containerOut) Transfer vectors from this to containerOut
void	zeroVectors() Clears the contained vectors.

Methods inherited from class java.lang.Object

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

Field Detail

wrappers

protected final List<VectorWrapper<?>> wrappers

Constructor Detail

VectorContainer

public VectorContainer()

VectorContainer

public VectorContainer(OperatorContext oContext)

VectorContainer

public VectorContainer(BufferAllocator allocator)

VectorContainer

public VectorContainer(BufferAllocator allocator,
               BatchSchema schema)

Create a new vector container given a pre-defined schema. Creates the corresponding vectors, but does not allocate memory for them. Call allocateNew() or allocateNewSafe() to allocate memory.

Note that this method does the equivalent of #buildSchema(SelectionVectorMode) using the schema provided.

Parameters:

allocator - allocator to be used to allocate memory later

schema - the schema that defines the vectors to create

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getAllocator

public BufferAllocator getAllocator()

isSchemaChanged

public boolean isSchemaChanged()

addHyperList

public void addHyperList(List<ValueVector> vectors)

addHyperList

public void addHyperList(List<ValueVector> vectors,
                boolean releasable)

transferIn

public void transferIn(VectorContainer containerIn)

Transfer vectors from containerIn to this.

transferOut

public void transferOut(VectorContainer containerOut)

Transfer vectors from this to containerOut

addOrGet

public <T extends ValueVector> T addOrGet(MaterializedField field)

addOrGet

public <T extends ValueVector> T addOrGet(MaterializedField field,
                                 SchemaChangeCallBack callBack)

addOrGet

public <T extends ValueVector> T addOrGet(String name,
                                 TypeProtos.MajorType type,
                                 Class<T> clazz)

getTransferClone

public static VectorContainer getTransferClone(VectorAccessible incoming,
                               OperatorContext oContext)

Get a set of transferred clones of this container. Note that this guarantees that the vectors in the cloned container have the same TypedFieldIds as the existing container, allowing interchangeability in generated code. In the case of hyper vectors, this container actually doesn't do a full transfer, rather creating a clone vector wrapper only.

Parameters:

incoming - The RecordBatch iterator the contains the batch we should take over.

Returns:

A cloned vector container.

getTransferClone

public static VectorContainer getTransferClone(VectorAccessible incoming,
                               BufferAllocator allocator)

getTransferClone

public static VectorContainer getTransferClone(VectorAccessible incoming,
                               VectorWrapper<?>[] ignoreWrappers,
                               OperatorContext oContext)

addCollection

public void addCollection(Iterable<ValueVector> vectors)

add

public TypedFieldId add(ValueVector vv)

add

public void add(ValueVector[] hyperVector)

add

public void add(ValueVector[] hyperVector,
       boolean releasable)

remove

public void remove(ValueVector v)

getValueVectorId

public TypedFieldId getValueVectorId(SchemaPath path)

Description copied from interface: VectorAccessible

Get the value vector type and id for the given schema path. The TypedFieldId should store a fieldId which is the same as the ordinal position of the field within the Iterator provided this classes implementation of Iterable.

Specified by:

getValueVectorId in interface VectorAccessible

Parameters:

path - the path where the vector should be located.

Returns:

the local field id associated with this vector. If no field matches this path, this will return a null TypedFieldId

getValueVector

public VectorWrapper<?> getValueVector(int index)

getValueAccessorById

public VectorWrapper<?> getValueAccessorById(Class<?> clazz,
                                    int... fieldIds)

Specified by:

getValueAccessorById in interface VectorAccessible

hasSchema

public boolean hasSchema()

getSchema

public BatchSchema getSchema()

Description copied from interface: VectorAccessible

Get the schema of the current RecordBatch. This changes if and only if a *_NEW_SCHEMA IterOutcome is provided.

Specified by:

getSchema in interface VectorAccessible

Returns:

schema of the current batch

buildSchema

public void buildSchema(BatchSchema.SelectionVectorMode mode)

iterator

public Iterator<VectorWrapper<?>> iterator()

Specified by:

iterator in interface Iterable<VectorWrapper<?>>

clear

public void clear()

setRecordCount

public void setRecordCount(int recordCount)

getRecordCount

public int getRecordCount()

Description copied from interface: VectorAccessible

Get the number of records.

Specified by:

getRecordCount in interface VectorAccessible

Returns:

number of records

hasRecordCount

public boolean hasRecordCount()

getSelectionVector2

public SelectionVector2 getSelectionVector2()

Specified by:

getSelectionVector2 in interface VectorAccessible

getSelectionVector4

public SelectionVector4 getSelectionVector4()

Specified by:

getSelectionVector4 in interface VectorAccessible

zeroVectors

public void zeroVectors()

Clears the contained vectors. (See ValueVector.clear()).

getNumberOfColumns

public int getNumberOfColumns()

allocateNew

public void allocateNew()

allocateNewSafe

public boolean allocateNewSafe()

merge

public VectorContainer merge(VectorContainer otherContainer)

Merge two batches to create a single, combined, batch. Vectors appear in the order defined by BatchSchema.merge(BatchSchema). The two batches must have identical row counts. The pattern is that this container is the main part of the record batch, the other represents new columns to merge.

Reference counts on the underlying buffers are unchanged. The client code is assumed to abandon the two input containers in favor of the merged container.

Parameters:

otherContainer - the container to merge with this one

Returns:

a new, merged, container