Esper API Documentation

Esper API

See:
          Description

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

 

Other Packages
com.espertech.esper.antlr ANTLR utility classes around parsing and AST tree walking.
com.espertech.esper.collection Internal collection classes
com.espertech.esper.collection.apachecommons Apache commons collection classes such as for soft-reference map implementation
com.espertech.esper.core Implementation of client package interfaces, glue code
com.espertech.esper.dispatch Dispatching makes results available to joins and handles internal event routing
com.espertech.esper.emit Package for emitting events
com.espertech.esper.epl.agg Contains aggregation service and aggregators
com.espertech.esper.epl.core 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.
com.espertech.esper.epl.db Database SQL polling views and caches
com.espertech.esper.epl.expression This package contains the EPL expression nodes that represent all expressions such as used in select clauses, group-by and having clauses, or order-by clauses
com.espertech.esper.epl.generated ANTLR-generated classes for parsing and AST tree-walking
com.espertech.esper.epl.join Join process interfaces and glue code
com.espertech.esper.epl.join.assemble Outer join result set assembly code
com.espertech.esper.epl.join.exec Inner join execution
com.espertech.esper.epl.join.plan Inner join and outer join query planning
com.espertech.esper.epl.join.rep Outer join result set handling
com.espertech.esper.epl.join.table Indexes for views
com.espertech.esper.epl.lookup Subquery execution strategies and lookup indexes
com.espertech.esper.epl.named Named window classes are in this package
com.espertech.esper.epl.parse Parsers and AST tree walkers and helper classes transforming AST into business objects
com.espertech.esper.epl.spec 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.
com.espertech.esper.epl.subquery Subquery helper classes are found here.
com.espertech.esper.epl.variable Variable service and variable collections
com.espertech.esper.epl.view Internal processing views for output rate limiting, filtering and internal event routing
com.espertech.esper.event.property Parsers and business objects to handle nested, indexed, mapped or generally complex properties for use in JavaBean access
com.espertech.esper.event.vaevent Value added events are revision events and variant events.
com.espertech.esper.event.xml XML event wrappers
com.espertech.esper.filter Main switchboard filtering and routing of incoming events to interested statements is performed in this package.
com.espertech.esper.indicator.jmx Classes for indicating events through a JMX console
com.espertech.esper.indicator.pretty Classes for pretty-printing OLAP cubes
com.espertech.esper.pattern Pattern expression tree and pattern state objects, the later resembles pattern expression state for each active pattern instance
com.espertech.esper.pattern.guard Pattern guards that can define the lifetime of a pattern
com.espertech.esper.pattern.observer Pattern observer classes the observe timer events
com.espertech.esper.plugin APIs for plug-in adapter (for input-output) and plug-in event representation (event types and event objects) are in this package.
com.espertech.esper.schedule Package for timer callback scheduling
com.espertech.esper.timer Supplies internal clocking triggering execution of schedule callbacks in a scheduling service
com.espertech.esper.type Internal primitive, enum and other type representations
com.espertech.esper.util Utility classes that center around Java type handling, printing, reflection, debugging
com.espertech.esper.view View infrastructure concerned with view creation and destroy, cloning and hooking views trees into filtering.
com.espertech.esper.view.ext Extension views that providing services such as sorting, which don't fit much into other categories.
com.espertech.esper.view.internal Internal management views for buffering view results and providing these to joins.
com.espertech.esper.view.stat Views computing statistical values.
com.espertech.esper.view.stat.olap Views computing OLAP cubes.
com.espertech.esper.view.std Base service views that perform typical SQL-like functions such as unique, grouping, size, last etc.
com.espertech.esper.view.stream View to event stream relationship service
com.espertech.esper.view.window Window views are in this package

 

Esper API

This documentation concentrates upon the following Core API interfaces:
  • com.espertech.esper.client
  • com.espertech.esper.client.time
  • com.espertech.esper.client.soda
  • com.espertech.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:
    com.espertech.esper.client, com.espertech.esper.client.time, com.espertech.esper.client.soda, com.espertech.esper.event

    © 2007 EsperTech Inc.
    All rights reserved.
    Visit us at espertech.com