Esper Common 9.0.0 API

Esper Common API - Common to the compiler API and the runtime API

The common API consists of packages under com.espertech.esper.common.client. The classes and interfaces in the common API client packages are fully intended to be exposed to application code and are classes that are generally relevant to both the compiler API and the runtime API.

The com.espertech.esper.common.client.hook package contains Extension API is intended to be used by application programmers to extend functionality. The extension API is less stable than the other client API classes.


The classes under com.espertech.esper.common.internal are not intended for use by an application unless the application builds an extension. The internal API classes are not stable and can change significantly between versions.

Full documentation may be found at the home page.
Package
Description
Common API: Classes that are generally relevant to both the compiler API and the processEvent API.
This package defines the Esper EPL annotations, which prefix EPL statements for the purpose of adding statement information.
Configuration classes.
Configuration classes for the common section, which is relevant to both the compiler and the runtime
Configuration classes for the compiler section, which is only relevant to the compiler
Configuration classes for the runtime section, which is only relevant to the runtime
Context partition selection and descriptors.
Data flow are operators and infrastructure for declaring flows.
Data flow annotations.
Client API for data flows.
Client API for data flow io handlers.
Data flow utilities.
Classes related to fire-and-forget execution
Extension APIs and other callbacks.
Aggregation function (simple) extension API.
Aggregation multi-function extension API for aggregation functions that hold events, share state and/or operate with tables.
Conditions indicate special situations in the runtime.
Date-time method extension API.
Enumeration method extension API.
Callbacks for exception handling.
Invocation contexts for external code.
Injection strategies for compiler use.
 
Single-row user-defined-function extension API for stateless functions.
Type mapping callbacks.
Virtual data window extension API classes.
JSON processing related classes.
JSON event object interface and event sender.
JSON event object interface and event sender.
Event type additional information.
This package defines the Esper Client APIs for metrics reporting, and consists of the metrics reporting events (enable via configuration).
EPL module object model.
Classes related to event rendering to JSON or XML format
Test framework classes.
Serdes are for serializing and de-serializing.
This package defines the Esper statement object model.
Classes that represent EPL types.
Client utility classes.
Classes for variable management
Byte-Code-Generation Classes
Byte-Code-Generation Core
Byte-Code-Generation Expression Model
Byte-Code-Generation Statement Model
 
Byte-Code-Generation Utility Classes
Internal collection classes
Apache commons collection classes such as for soft-reference map implementation
Compiler plug-in classes allows plugging-in the desired compiler
 
 
 
Contains EPL statement specification classes define the constructs that make up an EPL statement, such as the list of items in the select clause, the insert-into stream name and property names etc.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Aggregation utility classes centered around local group-by parameters.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Classes for EPL annotation processing.
Approximation algos.
 
 
 
 
 
Data flow operator and related interface.
 
 
 
 
Date-Time calendar operations.
Date-time evaluators
Date-Time methods and related utility classes.
Interval algebra.
Interval delta expression evaluation
 
Date-Time re-formatting operations.
 
Byte-code-generation related classes for enumeration methods
 
Enumeration method utility classes and input data sources.
Enumeration method implementations.
 
Enumeration method implementations for "except", "intersect" and "union".
Enumeration method implementations for "noop".
Enumeration method implementations for "reverse".
Enumeration method implementations for "sequenceequal".
Enumeration method implementations for "take" and "takelast".
Enumeration method implementations for plug-in enumeration methods.
Enumeration method implementations for "allof" and "anyof".
Enumeration method implementations for "arrayof".
Enumeration method implementations for "average".
Enumeration base method implementations for zero-parameter and lambda-one-parameter with up to three forms: selector, index, size.
Enumeration method implementations for "count".
Enumeration method implementations for "distinctof".
Enumeration method implementations for "firstof" and "lastof".
Enumeration method implementations for "groupby" one-parameter.
Enumeration method implementations for "min" and "max".
Enumeration method implementations for "minby" and "maxby".
Enumeration method implementations for "mostfrequent" and "leastfrequent".
Enumeration method implementations for "orderby".
Enumeration method implementations for "selectfrom".
Enumeration method implementations for "sumof".
Enumeration method implementations for "takewhile" and "takewhilelast".
Enumeration method implementations for "where".
Enumeration method base implementations for enum methods that have a two-lambda form.
Enumeration method implementations for "groupby" two-parameter.
Enumeration method implementations for "tomap".
 
 
 
 
 
 
 
 
 
 
 
Expression dot-method innerForge evaluators.
 
 
 
 
 
 
'Previous'-group indexExpressions.
'Prior'-group indexExpressionTexts.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Poll result indexing strategies.
 
 
Polled executions for use with method-invocation joins
Quad-tree indexes
Advanced index provisioning
 
 
 
 
 
 
 
 
Outer join result set assembly code
 
 
Composite query execution for hash+btree combined lookup.
 
 
 
Btree lookup for query execution.
 
Hints related to joins.
 
 
 
 
 
 
Outer join result set handling
 
 
 
 
 
 
Dot-method validation for enumeration and date-time methods.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Pattern subexpression pool management
 
Result set processor for Aggregated and Grouped
 
 
 
 
Order-by and row-limit processors
 
Result set processor for Aggregated and Un-Grouped
Result set processor for Fully-Aggregated and Grouped
Result set processor for Rollup
 
 
 
 
Match-recognize core.
Match-recognize indexExpressions.
Match-recognize NFA.
Match-recognize state management.
 
Script expression evaluation.
JSR-223 script expression evaluation.
MVEL script expression evaluation.
Quadtree index core classes
Quadtree MXCIF index core classes
Quadtree MXCIF filter index
Quadtree MXCIF row index
Quadtree Point-region core classes
Quadtree Point-region filter index
Quadtree Point-region row index
Stream-type management
 
 
 
 
 
Helpers for EPL update functionality.
 
 
 
 
Object-array event type.
Avro event type core interfaces.
JavaBean and legacy Java underlying event classes are here.
 
 
 
 
 
This package defines the internal event APIs.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Map-underlying event classes are here.
 
Parsers and business objects to handle nested, indexed, mapped or generally complex properties for use in JavaBean access
 
Utilities around event rendering are here.
Utilities around event rendering are here.
 
Event wrap refers to adding properties to an existing event
XML event wrappers
 
 
 
 
 
Services for metrics reporting, including global flag, repositories and threading.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Core service multi-match handlers.
 
 
 
 
Internal primitive, enum and other type representations
Utility classes that center around Java type handling, printing, reflection, debugging