org.apache.drill.exec.record

Class RecordBatchLoader

java.lang.Object

org.apache.drill.exec.record.RecordBatchLoader

All Implemented Interfaces:

Iterable<VectorWrapper<?>>, VectorAccessible

public class RecordBatchLoader
extends Object
implements VectorAccessible, Iterable<VectorWrapper<?>>

Holds record batch loaded from record batch message.

Constructor Summary

Constructors

Constructor and Description
RecordBatchLoader(BufferAllocator allocator) Constructs a loader using the given allocator for vector buffer allocation.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears this loader, which clears the internal vector container (see VectorContainer.clear()) and resets the record count to zero.
VectorContainer	getContainer()
int	getRecordCount() Get the number of records.
BatchSchema	getSchema() Get the schema of the current RecordBatch.
SelectionVector2	getSelectionVector2()
SelectionVector4	getSelectionVector4()
VectorWrapper<?>	getValueAccessorById(Class<?> clazz, int... ids)
TypedFieldId	getValueVectorId(SchemaPath path) Get the value vector type and id for the given schema path.
WritableBatch	getWritableBatch()
Iterator<VectorWrapper<?>>	iterator()
boolean	load(UserBitShared.RecordBatchDef def, DrillBuf buf) Load a record batch from a single buffer.
void	resetRecordCount()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordBatchLoader

public RecordBatchLoader(BufferAllocator allocator)

Constructs a loader using the given allocator for vector buffer allocation.

Method Detail

load

public boolean load(UserBitShared.RecordBatchDef def,
           DrillBuf buf)
             throws SchemaChangeException

Load a record batch from a single buffer.

Parameters:

def - The definition for the record batch.

buf - The buffer that holds the data associated with the record batch.

Returns:

Whether the schema changed since the previous load.

Throws:

SchemaChangeException - TODO: Clean: DRILL-2933 load(...) never actually throws SchemaChangeException.

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

getRecordCount

public int getRecordCount()

Description copied from interface: VectorAccessible

Get the number of records.

Specified by:

getRecordCount in interface VectorAccessible

Returns:

number of records

getContainer

public VectorContainer getContainer()

getValueAccessorById

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

Specified by:

getValueAccessorById in interface VectorAccessible

getWritableBatch

public WritableBatch getWritableBatch()

iterator

public Iterator<VectorWrapper<?>> iterator()

Specified by:

iterator in interface Iterable<VectorWrapper<?>>

getSelectionVector2

public SelectionVector2 getSelectionVector2()

Specified by:

getSelectionVector2 in interface VectorAccessible

getSelectionVector4

public SelectionVector4 getSelectionVector4()

Specified by:

getSelectionVector4 in interface VectorAccessible

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

resetRecordCount

public void resetRecordCount()

clear

public void clear()

Clears this loader, which clears the internal vector container (see VectorContainer.clear()) and resets the record count to zero.