Click or drag to resize

com.espertech.esper.common.client.hook.aggmultifunc Namespace

[Missing <summary> documentation for "N:com.espertech.esper.common.client.hook.aggmultifunc"]

Classes
  ClassDescription
Public classAggregationMultiFunctionAccessorFactoryContext
Context for use with plug-in aggregation multi-functions that implement .
Public classAggregationMultiFunctionAccessorModeManaged
Use this class to provide an accessor wherein there is no need to write code that generates code,
Public classAggregationMultiFunctionAgentFactoryContext
Context for use with plug-in aggregation multi-functions that implement .
Public classAggregationMultiFunctionAgentModeManaged
Use this class to provide an agent wherein there is no need to write code that generates code,
Public classAggregationMultiFunctionDeclarationContext
Context for use with provides information about an aggregation function at the time of declaration.

Declaration means when the aggregation function is discovered at the time of parsing an EPL statement. Or when using statement object model then at the time of mapping the object model to the internal statement representation.

Public classAggregationMultiFunctionStateFactoryContext
Context for use with plug-in aggregation multi-function that implement .
Public classAggregationMultiFunctionStateModeManaged
Use this class to provide an state factory wherein there is no need to write code that generates code,
Public classAggregationMultiFunctionTableReaderFactoryContext
Context for use with plug-in aggregation multi-function that implement .
Public classAggregationMultiFunctionTableReaderModeManaged
Use this class to provide a table reader wherein there is no need to write code that generates code,
Public classAggregationMultiFunctionValidationContext
Context for use with provides information about an aggregation function at the time of validation.

At validation time the event type information, parameter expressions and other statement-specific services are available.

Public classProxyAggregationMultiFunctionStateKey
Interfaces
  InterfaceDescription
Public interfaceAggregationMultiFunctionAccessor
Accessor for access aggregation functions.
Public interfaceAggregationMultiFunctionAccessorFactory
Factory for aggregation multi-function accessors.
Public interfaceAggregationMultiFunctionAccessorMode
Describes to the compiler how it should manage code for aggregation multi-function accessors.
Public interfaceAggregationMultiFunctionAgent
Agents change multi-function aggregation state.
Public interfaceAggregationMultiFunctionAgentFactory
Factory for aggregation multi-function agents
Public interfaceAggregationMultiFunctionAgentMode
Describes to the compiler how it should manage code for aggregation multi-function agents.
Public interfaceAggregationMultiFunctionForge
Entry point for the extension API for aggregation multi-functions.

This API allows adding one or more related aggregation functions that can share state, share parameters or exhibit related behavior.

Please use to register this factory class in the runtimetogether with one or more function names.

The runtimeinstantiates a single instance of this class at the time it encounters the first aggregation multi-function in a given statement at the time of statement parsing or compilation from statement object model.

At the time of statement parsing, each aggregation multi-function encountered during parsing of EPL statement text results in an invocation to {@link #addAggregationFunction(AggregationMultiFunctionDeclarationContext)}}. The same upon statement compilation for statement object model. For multiple aggregation functions, the order in which such calls occur is not well defined and should not be relied on by the implementation.

The runtimeinvokes {@link #validateGetHandler(AggregationMultiFunctionValidationContext)}} at the time of expression node validation. Validation occurs after statement parsing and when type information is established. For multiple aggregation functions, the order in which such calls occur is not well defined and should not be relied on by the implementation.

Usually a single handler class can handle the needs of all related aggregation functions. Usually you have a single handler class and return one handler object for each aggregation function expression, where the handler object takes the validation context as a parameter. Use multiple different handler classes when your aggregation functions have sufficiently different execution contexts or behaviors. Your application may want to use the expression and type information available in to decide what behavior to provide.

The function class must be Serializable only when used with EsperHA.

Public interfaceAggregationMultiFunctionHandler
Part of the aggregation multi-function extension API, this class represents one of more aggregation function expression instances. This class is responsible for providing a state reader (called accessor) for returning value from aggregation state, and for providing return type information of the accessor, and for providing state factory information.

Note the information returned by must match the value objects returned by accessors provided by .

For example, assuming you have an EPL statement such as {@code select search(), query() from MyEvent} then you would likely use one handler class and two handler objects (one for search and one for query).

Public interfaceAggregationMultiFunctionState
Base interface for providing access-aggregations, i.e. aggregations that mirror a data window but group by the group-by clause and that do not mirror the data windows sorting policy.
Public interfaceAggregationMultiFunctionStateFactory
Factory for aggregation multi-function state
Public interfaceAggregationMultiFunctionStateKey
Marker interface for use with multi-function aggregation to indicate whether aggregation functions share state
Public interfaceAggregationMultiFunctionStateMode
Describes to the compiler how it should manage code for aggregation multi-function state factory.
Public interfaceAggregationMultiFunctionTableReader
Reader for aggregation multi-function state held by a table column.
Public interfaceAggregationMultiFunctionTableReaderFactory
Factory for aggregation multi-function table readers
Public interfaceAggregationMultiFunctionTableReaderMode
Describes to the compiler how it should manage code for aggregation multi-function table reader.