Esper API Documentation

Esper API

See:
          Description

Core API
net.esper.client This package defines the central Esper Client APIs.
net.esper.client.soda This package defines the Esper statement object model.
net.esper.client.time This package defines the Esper Client timer control events.
net.esper.event This package defines the Esper Client event API.

 

Other Packages
net.esper.adapter Adapter framework classes are in this package as they may provide service APIs to the engine.
net.esper.collection Internal collection classes
net.esper.core Implementation of client package interfaces, glue code
net.esper.dispatch Dispatching makes results available to joins and handles internal event routing
net.esper.emit Package for emitting events
net.esper.eql.agg Contains aggregation service and aggregators
net.esper.eql.core Contains EQL statement specification classes define the constructs that make up an EQL statement, such as the list of items in the select clause, the insert-into stream name and property names etc.
net.esper.eql.db Database SQL polling views and caches
net.esper.eql.expression This package contains the EQL expression nodes that represent all expressions such as used in select clauses, group-by and having clauses, or order-by clauses
net.esper.eql.generated ANTLR-generated classes for parsing and AST tree-walking
net.esper.eql.join Join process interfaces and glue code
net.esper.eql.join.assemble Outer join result set assembly code
net.esper.eql.join.exec Inner join execution
net.esper.eql.join.plan Inner join and outer join query planning
net.esper.eql.join.rep Outer join result set handling
net.esper.eql.join.table Indexes for views
net.esper.eql.parse Parsers and AST tree walkers and helper classes transforming AST into business objects
net.esper.eql.spec Contains EQL statement specification classes define the constructs that make up an EQL statement, such as the list of items in the select clause, the insert-into stream name and property names etc.
net.esper.eql.subquery Subquery execution strategies and lookup indexes
net.esper.eql.view Internal processing views for output rate limiting, filtering and internal event routing
net.esper.event.property Parsers and business objects to handle nested, indexed, mapped or generally complex properties for use in JavaBean access
net.esper.event.xml XML event wrappers
net.esper.filter Main switchboard filtering and routing of incoming events to interested statements is performed in this package.
net.esper.indicator.jmx Classes for indicating events through a JMX console
net.esper.indicator.pretty Classes for pretty-printing OLAP cubes
net.esper.pattern Pattern expression tree and pattern state objects, the later resembles pattern expression state for each active pattern instance
net.esper.pattern.guard Pattern guards that can define the lifetime of a pattern
net.esper.pattern.observer Pattern observer classes the observe timer events
net.esper.schedule Package for timer callback scheduling
net.esper.timer Supplies internal clocking triggering execution of schedule callbacks in a scheduling service
net.esper.type Internal primitive, enum and other type representations
net.esper.util Utility classes that center around Java type handling, printing, reflection, debugging
net.esper.view View infrastructure concerned with view creation and destroy, cloning and hooking views trees into filtering.
net.esper.view.ext Extension views that providing services such as sorting, which don't fit much into other categories.
net.esper.view.internal Internal management views for buffering view results and providing these to joins.
net.esper.view.stat Views computing statistical values.
net.esper.view.stat.olap Views computing OLAP cubes.
net.esper.view.std Base service views that perform typical SQL-like functions such as unique, grouping, size, last etc.
net.esper.view.stream View to event stream relationship service
net.esper.view.window Window views are in this package

 

Esper API

This documentation concentrates upon the following Core API interfaces:
  • net.esper.client
  • net.esper.client.time
  • net.esper.client.soda
  • net.esper.event


  • These interfaces are fully intended to be exposed to application code.

    The Extension API is intended to be used by application programmers to extend Esper functionality. None of these interfaces are intended to be called by the application - they are called internally by Esper. This API is less stable than the Core API. The safest way to extend functionality is to contribute extensions back to the project; that way extensions will be updated when the Extension API changes.

    Full Esper documentation may be found at esper.codehaus.org.

    See Also:
    net.esper.client, net.esper.client.time, net.esper.client.soda, net.esper.event