|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConfigurationOperations
Provides configuration operations for configuration-time and runtime parameters.
Method Summary | |
---|---|
void |
addEventTypeAlias(String eventTypeAlias,
Class eventClass)
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 eventClassName)
Add an alias for an event type represented by JavaBean object events. |
void |
addEventTypeAliasNestable(String eventTypeAlias,
Map<String,Object> typeMap)
Add an alias for an event type that represents java.util.Map events, and for which each property may itself be a Map of further properties, with unlimited nesting levels. |
void |
addEventTypeAliasSimpleName(Class eventClass)
Add an alias for an event type represented by Java-bean plain-old Java object events, using the simple name of the Java class as the alias. |
void |
addEventTypeAutoAlias(String packageName)
Adds a Java package name of a package that Java event classes reside in. |
void |
addImport(String importName)
Adds a package or class to the list of automatically-imported classes and packages. |
void |
addNestableEventTypeAlias(String eventTypeAlias,
Map<String,Object> typeMap)
Add an alias for an event type that represents nestable strong-typed java.util.Map events, taking a Map of event property and class name as a parameter. |
void |
addPlugInAggregationFunction(String functionName,
String aggregationClassName)
Adds a plug-in aggregation function given a function name and an aggregation class name. |
void |
addPlugInEventType(String eventTypeAlias,
URI[] resolutionURIs,
Serializable initializer)
Adds an alias for an event type that one of the plug-in event representations resolves to an event type. |
void |
addRevisionEventType(String revisionEventTypeAlias,
ConfigurationRevisionEventType revisionEventTypeConfig)
Adds an revision event type. |
void |
addVariable(String variableName,
Class type,
Object initializationValue)
Add a variable. |
void |
addVariantStream(String variantStreamName,
ConfigurationVariantStream variantStreamConfig)
Adds a new variant stream. |
boolean |
isEventTypeAliasExists(String eventTypeAlias)
Checks if an eventTypeAlias has already been registered for that alias name. |
void |
setPlugInEventTypeAliasResolutionURIs(URI[] urisToResolveAlias)
Sets the URIs that point to plug-in event representations that are given a chance to dynamically resolve an event type alias to an event type, when a new (unseen) event type alias occurs in a new EPL statement. |
Method Detail |
---|
void addEventTypeAutoAlias(String packageName)
This setting allows an application to place all it's events into one or more Java packages and then declare these packages via this method. The engine attempts to resolve an event type alias to a Java class residing in each declared package.
For example, in the statement "select * from MyEvent" the engine attempts to load class "javaPackageName.MyEvent" and if successful, uses that class as the event type.
packageName
- is the fully-qualified Java package name of the Java package that event classes reside invoid addPlugInAggregationFunction(String functionName, String aggregationClassName) throws ConfigurationException
The aggregation class must extends the base class AggregationSupport
.
The same function name cannot be added twice.
functionName
- is the new aggregation function nameaggregationClassName
- is the fully-qualified class name of the class implementing the aggregation function
ConfigurationException
- is thrown to indicate a problem adding aggregation functionvoid addImport(String importName) throws ConfigurationException
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.*
.
importName
- is a fully-qualified class name or a package name with wildcard
ConfigurationException
- if incorrect package or class names are encounteredboolean isEventTypeAliasExists(String eventTypeAlias)
eventTypeAlias
- the alias name
void addEventTypeAlias(String eventTypeAlias, String eventClassName) throws ConfigurationException
Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.
eventTypeAlias
- is the alias for the event typeeventClassName
- fully-qualified class name of the event type
ConfigurationException
- if the alias is already in used for a different typevoid addEventTypeAlias(String eventTypeAlias, Class eventClass) throws ConfigurationException
Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.
eventTypeAlias
- is the alias for the event typeeventClass
- is the Java event class for which to create the alias
ConfigurationException
- if the alias is already in used for a different typevoid addEventTypeAliasSimpleName(Class eventClass)
For example, if your class is "com.mycompany.MyEvent", then this method adds the alias "MyEvent" for the class.
Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.
eventClass
- is the Java event class for which to create the alias from the class simple name
ConfigurationException
- if the alias is already in used for a different typevoid addEventTypeAlias(String eventTypeAlias, Properties typeMap) throws ConfigurationException
Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.
eventTypeAlias
- is the alias for the event typetypeMap
- maps the name of each property in the Map event to the type
(fully qualified classname) of its value in Map event instances.
ConfigurationException
- if the alias is already in used for a different typevoid addEventTypeAlias(String eventTypeAlias, Map<String,Class> typeMap) throws ConfigurationException
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.
eventTypeAlias
- is the alias for the event typetypeMap
- maps the name of each property in the Map event to the type of its value in the Map object
ConfigurationException
- if the alias is already in used for a different typevoid addEventTypeAliasNestable(String eventTypeAlias, Map<String,Object> typeMap) throws ConfigurationException
Each entry in the type mapping must contain the String property name
and either a Class or further Map
eventTypeAlias
- is the alias for the event typetypeMap
- maps the name of each property in the Map event to the type
(fully qualified classname) of its value in Map event instances.
ConfigurationException
- if the alias is already in used for a different type
void addNestableEventTypeAlias(String eventTypeAlias, Map<String,Object> typeMap) throws ConfigurationException
This method takes a Map of String property names and Object property type. Each Object property
type can either be a java.lang.Class to denote a built-in type or POJO application object,
or can itself also be a Map
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.
eventTypeAlias
- is the alias for the event typetypeMap
- maps the name of each property in the Map event to the type of its value in the Map object
ConfigurationException
- if the alias is already in used for a different type
void addEventTypeAlias(String eventTypeAlias, ConfigurationEventTypeXMLDOM xmlDOMEventTypeDesc) throws ConfigurationException
Allows a second alias to be added for the same type. Does not allow the same alias to be used for different types.
eventTypeAlias
- is the alias for the event typexmlDOMEventTypeDesc
- descriptor containing property and mapping information for XML-DOM events
ConfigurationException
- if the alias is already in used for a different typevoid addVariable(String variableName, Class type, Object initializationValue) throws ConfigurationException
variableName
- name of the variable to addtype
- the type of the variable must be a primitive or boxed Java-builtin scalar type.initializationValue
- is the first assigned value
ConfigurationException
- if the type and initialization value don't match or the variable name
is already in usevoid addPlugInEventType(String eventTypeAlias, URI[] resolutionURIs, Serializable initializer)
The order of the URIs matters as event representations are asked in turn, to accept the event type.
URIs can be child URIs of plug-in event representations and can add additional parameters or fragments for use by the event representation.
eventTypeAlias
- is the alias name of the event typeresolutionURIs
- is URIs that are matched to registered event representationsinitializer
- is an optional value for parameterizing or configuring the event typevoid setPlugInEventTypeAliasResolutionURIs(URI[] urisToResolveAlias)
The order of the URIs matters as event representations are asked in turn, to accept the alias.
URIs can be child URIs of plug-in event representations and can add additional parameters or fragments for use by the event representation.
urisToResolveAlias
- URIs for resolving the aliasvoid addRevisionEventType(String revisionEventTypeAlias, ConfigurationRevisionEventType revisionEventTypeConfig)
revisionEventTypeAlias
- the alias name of the revision event typerevisionEventTypeConfig
- the configurationvoid addVariantStream(String variantStreamName, ConfigurationVariantStream variantStreamConfig)
variantStreamName
- is the name of the variant streamvariantStreamConfig
- the configuration such as variant type aliases and any-type setting
|
© 2007 EsperTech Inc. All rights reserved. Visit us at espertech.com |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |