org.apache.drill.exec.ops

Interface FragmentContextInterface

All Known Implementing Classes:

BaseFragmentContext, FragmentContext

public interface FragmentContextInterface

Fragment context interface: separates implementation from definition. Allows unit testing by mocking or reimplementing services with test-time versions. The name is awkward, chosen to avoid renaming the implementation class which is used in many places in legacy code. New code should use this interface, and the names should eventually be swapped with FragmentContext becoming FragmentContextImpl and this interface becoming FragmentContext.

Method Summary

Methods

Modifier and Type	Method and Description
DrillConfig	getConfig() Returns the Drill configuration for this run.
DrillbitContext	getDrillbitContext() Drillbit context.
ExecutionControls	getExecutionControls() Return the set of execution controls used to inject faults into running code for testing.
FunctionImplementationRegistry	getFunctionRegistry() Returns the UDF registry.
<T> T	getImplementationClass(ClassGenerator<T> cg) Generates code for a class given a ClassGenerator, and returns a single instance of the generated class.
<T> List<T>	getImplementationClass(ClassGenerator<T> cg, int instanceCount) Generates code for a class given a ClassGenerator, and returns the specified number of instances of the generated class.
<T> T	getImplementationClass(CodeGenerator<T> cg) Generates code for a class given a CodeGenerator, and returns a single instance of the generated class.
<T> List<T>	getImplementationClass(CodeGenerator<T> cg, int instanceCount) Generates code for a class given a CodeGenerator, and returns the specified number of instances of the generated class.
DrillBuf	getManagedBuffer()
DrillBuf	getManagedBuffer(int size)
OptionSet	getOptionSet() Returns a read-only version of the session options.
DrillBuf	replace(DrillBuf old, int newSize)
boolean	shouldContinue() Determine if fragment execution has been interrupted.

Method Detail

getDrillbitContext

DrillbitContext getDrillbitContext()

Drillbit context. Valid only in production; returns null in operator test environments.

getFunctionRegistry

FunctionImplementationRegistry getFunctionRegistry()

Returns the UDF registry.

Returns:

the UDF registry

getOptionSet

OptionSet getOptionSet()

Returns a read-only version of the session options.

Returns:

the session options

getImplementationClass

<T> T getImplementationClass(ClassGenerator<T> cg)
                         throws ClassTransformationException,
                                IOException

Generates code for a class given a ClassGenerator, and returns a single instance of the generated class. (Note that the name is a misnomer, it would be better called getImplementationInstance.)

Parameters:

cg - the class generator

Returns:

an instance of the generated class

Throws:

ClassTransformationException

IOException

getImplementationClass

<T> T getImplementationClass(CodeGenerator<T> cg)
                         throws ClassTransformationException,
                                IOException

Generates code for a class given a CodeGenerator, and returns a single instance of the generated class. (Note that the name is a misnomer, it would be better called getImplementationInstance.)

Parameters:

cg - the code generator

Returns:

an instance of the generated class

Throws:

ClassTransformationException

IOException

getImplementationClass

<T> List<T> getImplementationClass(ClassGenerator<T> cg,
                                 int instanceCount)
                               throws ClassTransformationException,
                                      IOException

Generates code for a class given a ClassGenerator, and returns the specified number of instances of the generated class. (Note that the name is a misnomer, it would be better called getImplementationInstances.)

Parameters:

cg - the class generator

Returns:

list of instances of the generated class

Throws:

ClassTransformationException

IOException

getImplementationClass

<T> List<T> getImplementationClass(CodeGenerator<T> cg,
                                 int instanceCount)
                               throws ClassTransformationException,
                                      IOException

Generates code for a class given a CodeGenerator, and returns the specified number of instances of the generated class. (Note that the name is a misnomer, it would be better called getImplementationInstances.)

Parameters:

cg - the code generator

Returns:

list of instances of the generated class

Throws:

ClassTransformationException

IOException

shouldContinue

boolean shouldContinue()

Determine if fragment execution has been interrupted.

Returns:

true if execution should continue, false if an interruption has occurred and fragment execution should halt

getExecutionControls

ExecutionControls getExecutionControls()

Return the set of execution controls used to inject faults into running code for testing.

Returns:

the execution controls

getConfig

DrillConfig getConfig()

Returns the Drill configuration for this run. Note that the config is global and immutable.

Returns:

the Drill configuration

replace

DrillBuf replace(DrillBuf old,
               int newSize)

getManagedBuffer

DrillBuf getManagedBuffer()

getManagedBuffer

DrillBuf getManagedBuffer(int size)