org.apache.drill.exec.record

Class AbstractSingleRecordBatch<T extends PhysicalOperator>

java.lang.Object

org.apache.drill.exec.record.AbstractRecordBatch<T>

org.apache.drill.exec.record.AbstractSingleRecordBatch<T>

All Implemented Interfaces:

AutoCloseable, Iterable<VectorWrapper<?>>, CloseableRecordBatch, RecordBatch, VectorAccessible

Direct Known Subclasses:

FilterRecordBatch, FlattenRecordBatch, LimitRecordBatch, ProjectRecordBatch, RemovingRecordBatch, TraceRecordBatch

public abstract class AbstractSingleRecordBatch<T extends PhysicalOperator>
extends AbstractRecordBatch<T>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.drill.exec.record.AbstractRecordBatch

AbstractRecordBatch.BatchState

Nested classes/interfaces inherited from interface org.apache.drill.exec.record.RecordBatch

RecordBatch.IterOutcome

Field Summary

Fields

Modifier and Type	Field and Description
protected SchemaChangeCallBack	callBack
protected RecordBatch	incoming
protected boolean	outOfMemory

Fields inherited from class org.apache.drill.exec.record.AbstractRecordBatch

container, context, oContext, popConfig, state, stats, unionTypeEnabled

Fields inherited from interface org.apache.drill.exec.record.RecordBatch

MAX_BATCH_SIZE

Constructor Summary

Constructors

Constructor and Description
AbstractSingleRecordBatch(T popConfig, FragmentContext context, RecordBatch incoming)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract RecordBatch.IterOutcome	doWork()
BatchSchema	getSchema() Gets the current schema of this record batch.
protected RecordBatch.IterOutcome	handleNullInput() Default behavior to handle NULL input (aka FAST NONE): incoming return NONE before return a OK_NEW_SCHEMA: This could happen when the underneath Scan operators do not produce any batch with schema.
RecordBatch.IterOutcome	innerNext()
protected void	killIncoming(boolean sendUpstream)
protected abstract boolean	setupNewSchema()

Methods inherited from class org.apache.drill.exec.record.AbstractRecordBatch

buildSchema, close, getContext, getOutgoingContainer, getPopConfig, getSelectionVector2, getSelectionVector4, getValueAccessorById, getValueVectorId, getWritableBatch, iterator, kill, next, next, next

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.record.RecordBatch

getRecordCount

Field Detail

incoming

protected final RecordBatch incoming

outOfMemory

protected boolean outOfMemory

callBack

protected SchemaChangeCallBack callBack

Constructor Detail

AbstractSingleRecordBatch

public AbstractSingleRecordBatch(T popConfig,
                         FragmentContext context,
                         RecordBatch incoming)
                          throws OutOfMemoryException

Throws:

OutOfMemoryException

Method Detail

killIncoming

protected void killIncoming(boolean sendUpstream)

Specified by:

killIncoming in class AbstractRecordBatch<T extends PhysicalOperator>

innerNext

public RecordBatch.IterOutcome innerNext()

Specified by:

innerNext in class AbstractRecordBatch<T extends PhysicalOperator>

getSchema

public BatchSchema getSchema()

Description copied from interface: RecordBatch

Gets the current schema of this record batch.

May be called only when the most recent call to RecordBatch.next(), if any, returned #OK_NEW_SCHEMA or #OK.

The schema changes when and only when RecordBatch.next() returns #OK_NEW_SCHEMA.

Specified by:

getSchema in interface RecordBatch

Specified by:

getSchema in interface VectorAccessible

Overrides:

getSchema in class AbstractRecordBatch<T extends PhysicalOperator>

Returns:

schema of the current batch

setupNewSchema

protected abstract boolean setupNewSchema()
                                   throws SchemaChangeException

Throws:

SchemaChangeException

doWork

protected abstract RecordBatch.IterOutcome doWork()

handleNullInput

protected RecordBatch.IterOutcome handleNullInput()

Default behavior to handle NULL input (aka FAST NONE): incoming return NONE before return a OK_NEW_SCHEMA: This could happen when the underneath Scan operators do not produce any batch with schema.

Notice that NULL input is different from input with an empty batch. In the later case, input provides at least a batch, thought it's empty.

This behavior could be override in each individual operator, if the operator's semantics is to inject a batch with schema.

Returns:

IterOutcome.NONE.