com.espertech.esper.compiler.client

Interface EPCompiler

public interface EPCompiler

The EPL compiler compiles EPL text as well as object models to byte code.

Method Summary

Modifier and Type	Method and Description
EPCompiled	compile(Module module, CompilerArguments arguments) Compiles a module object model and returns the byte code for deployment into a runtime.
EPCompiled	compile(java.lang.String epl, CompilerArguments arguments) Compiles EPL and returns the byte code for deployment into a runtime.
EPCompiled	compileQuery(EPStatementObjectModel fireAndForgetEPLQueryModel, CompilerArguments arguments) Compiles fire-and-forget query object model for execution by the runtime.
EPCompiled	compileQuery(java.lang.String fireAndForgetEPLQuery, CompilerArguments arguments) Compiles a single fire-and-forget query for execution by the runtime.
EPStatementObjectModel	eplToModel(java.lang.String epl, Configuration configuration) Parse the single-statement EPL and return a statement object model.
Module	parseModule(java.lang.String eplModuleText) Parse the module text returning the module object model.
Module	readModule(java.io.File file) Read the module by reading the text file and return the module.
Module	readModule(java.io.InputStream stream, java.lang.String moduleUri) Read the input stream and return the module.
Module	readModule(java.lang.String resource, java.lang.ClassLoader classLoader) Read the resource by opening from classpath and return the module.
Module	readModule(java.net.URL url) Read the module by reading from the URL provided and return the module.
void	syntaxValidate(Module module, CompilerArguments arguments) Validate the syntax of the module.

Method Detail

compile

EPCompiled compile(java.lang.String epl,
                   CompilerArguments arguments)
            throws EPCompileException

Compiles EPL and returns the byte code for deployment into a runtime.

Use semicolon(;) to separate multiple statements in a module.

Parameters:

epl - epl to compile

arguments - compiler arguments

Returns:

byte code

Throws:

EPCompileException - when the compilation failed

compile

EPCompiled compile(Module module,
                   CompilerArguments arguments)
            throws EPCompileException

Compiles a module object model and returns the byte code for deployment into a runtime.

Parameters:

module - module object to compile

arguments - compiler arguments

Returns:

byte code

Throws:

EPCompileException - when the compilation failed

compileQuery

EPCompiled compileQuery(java.lang.String fireAndForgetEPLQuery,
                        CompilerArguments arguments)
                 throws EPCompileException

Compiles a single fire-and-forget query for execution by the runtime.

Parameters:

fireAndForgetEPLQuery - fire-and-forget query to compile

arguments - compiler arguments

Returns:

byte code

Throws:

EPCompileException - when the compilation failed

compileQuery

EPCompiled compileQuery(EPStatementObjectModel fireAndForgetEPLQueryModel,
                        CompilerArguments arguments)
                 throws EPCompileException

Compiles fire-and-forget query object model for execution by the runtime.

Parameters:

fireAndForgetEPLQueryModel - fire-and-forget query to compile

arguments - compiler arguments

Returns:

byte code

Throws:

EPCompileException - when the compilation failed

parseModule

Module parseModule(java.lang.String eplModuleText)
            throws java.io.IOException,
                   ParseException

Parse the module text returning the module object model.

Parameters:

eplModuleText - to parse

Returns:

module object model

Throws:

java.io.IOException - when the parser failed

ParseException - when parsing of the module failed

eplToModel

EPStatementObjectModel eplToModel(java.lang.String epl,
                                  Configuration configuration)
                           throws EPCompileException

Parse the single-statement EPL and return a statement object model.

Parameters:

epl - to parse

configuration - a configuration object when available

Returns:

statement object model

Throws:

EPCompileException - when the EPL could not be parsed

syntaxValidate

void syntaxValidate(Module module,
                    CompilerArguments arguments)
             throws EPCompileException

Validate the syntax of the module.

Parameters:

module - to validate

arguments - compiler arguments

Throws:

EPCompileException - when the EPL could not be parsed

readModule

Module readModule(java.io.InputStream stream,
                  java.lang.String moduleUri)
           throws java.io.IOException,
                  ParseException

Read the input stream and return the module. It is up to the calling method to close the stream when done.

Parameters:

stream - to read

moduleUri - uri of the module

Returns:

module module

Throws:

java.io.IOException - when the io operation failed

ParseException - when parsing of the module failed

readModule

Module readModule(java.lang.String resource,
                  java.lang.ClassLoader classLoader)
           throws java.io.IOException,
                  ParseException

Read the resource by opening from classpath and return the module.

Parameters:

resource - name of the classpath resource

classLoader - classloader

Returns:

module module

Throws:

java.io.IOException - when the resource could not be read

ParseException - when parsing of the module failed

readModule

Module readModule(java.io.File file)
           throws java.io.IOException,
                  ParseException

Read the module by reading the text file and return the module.

Parameters:

file - the file to read

Returns:

module

Throws:

java.io.IOException - when the file could not be read

ParseException - when parsing of the module failed

readModule

Module readModule(java.net.URL url)
           throws java.io.IOException,
                  ParseException

Read the module by reading from the URL provided and return the module.

Parameters:

url - the URL to read

Returns:

module

Throws:

java.io.IOException - when the url input stream could not be read

ParseException - when parsing of the module failed