io.cdap.wrangler.api

Interface Compiler

@PublicEvolving
public interface Compiler

This Compiler interface provides a way to implement your own version of compiler for directive or recipe.

This interface contains methods that provides variants of the source from which the recipe are read. It support reading from string, HDFS location and Path.

Each of the methods would return CompileStatus objects that contains the compiled directives in the form of Executor or iterator of SyntaxError in case of failure to compile.

Method Summary

Modifier and Type	Method and Description
CompileStatus	compile(org.apache.twill.filesystem.Location location) Compiles the recipe that is supplied in a Location on HDFS.
CompileStatus	compile(Path path) Compiles the recipe that is supplied in a Path on Filesystem.
CompileStatus	compile(String recipe) Compiles the recipe that is supplied in a String format.

Method Detail

compile

CompileStatus compile(String recipe)
               throws CompileException

Compiles the recipe that is supplied in a String format.

Parameters:

recipe - representing the String form of recipe.

Returns:

CompileStatus status of compilation.

Throws:

CompileException

compile

CompileStatus compile(org.apache.twill.filesystem.Location location)
               throws CompileException

Compiles the recipe that is supplied in a Location on HDFS.

Parameters:

location - Location to the recipe being compiled.

Returns:

CompileStatus status of compilation.

Throws:

CompileException

compile

CompileStatus compile(Path path)
               throws CompileException

Compiles the recipe that is supplied in a Path on Filesystem.

Parameters:

path - Path to the recipe being compiled.

Returns:

CompileStatus status of compilation.

Throws:

CompileException