net.esper.client
Interface ConfigurationOperations

All Known Implementing Classes:
Configuration, ConfigurationOperationsImpl

public interface ConfigurationOperations

Provides configuration operations for configuration-time and runtime parameters.


Method Summary
 void addEventTypeAlias(String eventTypeAlias, Class javaEventClass)
          Add an alias for an event type represented by Java-bean plain-old Java object events.
 void addEventTypeAlias(String eventTypeAlias, ConfigurationEventTypeXMLDOM xmlDOMEventTypeDesc)
          Add an alias for an event type that represents org.w3c.dom.Node events.
 void addEventTypeAlias(String eventTypeAlias, Map<String,Class> typeMap)
          Add an alias for an event type that represents java.util.Map events, taking a Map of event property and class name as a parameter.
 void addEventTypeAlias(String eventTypeAlias, Properties typeMap)
          Add an alias for an event type that represents java.util.Map events.
 void addEventTypeAlias(String eventTypeAlias, String javaEventClassName)
          Add an alias for an event type represented by JavaBean object events.
 void addImport(String importName)
          Adds a package or class to the list of automatically-imported classes and packages.
 void addPlugInAggregationFunction(String functionName, String aggregationClassName)
          Adds a plug-in aggregation function given a function name and an aggregation class name.
 

Method Detail

addPlugInAggregationFunction

void addPlugInAggregationFunction(String functionName,
                                  String aggregationClassName)
                                  throws ConfigurationException
Adds a plug-in aggregation function given a function name and an aggregation class name.

The aggregation class must extends the base class AggregationSupport.

The same function name cannot be added twice.

Parameters:
functionName - is the new aggregation function name
aggregationClassName - is the fully-qualified class name of the class implementing the aggregation function
Throws:
ConfigurationException - is thrown to indicate a problem adding aggregation function

addImport

void addImport(String importName)
               throws ConfigurationException
Adds a package or class to the list of automatically-imported classes and packages.

To import a single class offering a static method, simply supply the fully-qualified name of the class and use the syntax classname.methodname(...)

To import a whole package and use the classname.methodname(...) syntax, specifiy a package with wildcard, such as com.mycompany.staticlib.*.

Parameters:
importName - is a fully-qualified class name or a package name with wildcard
Throws:
ConfigurationException - if incorrect package or class names are encountered

addEventTypeAlias

void addEventTypeAlias(String eventTypeAlias,
                       String javaEventClassName)
                       throws ConfigurationException
Add an alias for an event type represented by JavaBean object events.

Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.

Parameters:
eventTypeAlias - is the alias for the event type
javaEventClassName - fully-qualified class name of the event type
Throws:
ConfigurationException - if the alias is already in used for a different type

addEventTypeAlias

void addEventTypeAlias(String eventTypeAlias,
                       Class javaEventClass)
                       throws ConfigurationException
Add an alias for an event type represented by Java-bean plain-old Java object events.

Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.

Parameters:
eventTypeAlias - is the alias for the event type
javaEventClass - is the Java event class for which to create the alias
Throws:
ConfigurationException - if the alias is already in used for a different type

addEventTypeAlias

void addEventTypeAlias(String eventTypeAlias,
                       Properties typeMap)
                       throws ConfigurationException
Add an alias for an event type that represents java.util.Map events.

Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.

Parameters:
eventTypeAlias - is the alias for the event type
typeMap - maps the name of each property in the Map event to the type (fully qualified classname) of its value in Map event instances.
Throws:
ConfigurationException - if the alias is already in used for a different type

addEventTypeAlias

void addEventTypeAlias(String eventTypeAlias,
                       Map<String,Class> typeMap)
                       throws ConfigurationException
Add an alias for an event type that represents java.util.Map events, taking a Map of event property and class name as a parameter.

This method is provided for convenience and is same in function to method taking a Properties object that contain fully qualified class name as values.

Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.

Parameters:
eventTypeAlias - is the alias for the event type
typeMap - maps the name of each property in the Map event to the type of its value in the Map object
Throws:
ConfigurationException - if the alias is already in used for a different type

addEventTypeAlias

void addEventTypeAlias(String eventTypeAlias,
                       ConfigurationEventTypeXMLDOM xmlDOMEventTypeDesc)
                       throws ConfigurationException
Add an alias for an event type that represents org.w3c.dom.Node events.

Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.

Parameters:
eventTypeAlias - is the alias for the event type
xmlDOMEventTypeDesc - descriptor containing property and mapping information for XML-DOM events
Throws:
ConfigurationException - if the alias is already in used for a different type