com.espertech.esper.common.client.configuration.common

Class ConfigurationCommon

java.lang.Object

com.espertech.esper.common.client.configuration.common.ConfigurationCommon

All Implemented Interfaces:

java.io.Serializable

public class ConfigurationCommon
extends java.lang.Object
implements java.io.Serializable

Contains settings that apply to both the compile-time and the runtime.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANNOTATION_IMPORT Import name of the package that hosts the annotation classes.
protected java.util.List<java.lang.String>	annotationImports For annotations only, the class and package name imports that will be used to resolve partial class names (not available in EPL statements unless used in an annotation).
protected java.util.Map<java.lang.String,ConfigurationCommonDBRef>	databaseReferences The class and package name imports that will be used to resolve partial class names.
static java.lang.String	DATAFLOWOPERATOR_IMPORT Import package for data flow operator forges.
protected java.util.Map<java.lang.String,java.lang.String>	eventClasses Map of event name and fully-qualified class name.
protected ConfigurationCommonEventTypeMeta	eventMeta Event type common configuration
protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeAvro>	eventTypesAvro Map of event type name and XML DOM configuration.
protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeBean>	eventTypesBean Map of event type name and bean-type event configuration.
protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeXMLDOM>	eventTypesXMLDOM Map of event type name and XML DOM configuration.
protected ConfigurationCommonExecution	execution Execution-related configuration
protected java.util.List<java.lang.String>	imports The class and package name imports that will be used to resolve partial class names.
protected ConfigurationCommonLogging	logging Logging configuration.
protected java.util.Map<java.lang.String,java.util.Properties>	mapNames The type names for events that are backed by java.util.Map, not containing strongly-typed nested maps.
protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeMap>	mapTypeConfigurations Map event types additional configuration information.
protected java.util.Map<java.lang.String,ConfigurationCommonMethodRef>	methodInvocationReferences Map of class name and configuration for method invocations on that class.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	nestableMapNames The type names for events that are backed by java.util.Map, possibly containing strongly-typed nested maps.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	nestableObjectArrayNames The type names for events that are backed by java.util.Map, possibly containing strongly-typed nested maps.
protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeObjectArray>	objectArrayTypeConfigurations Map event types additional configuration information.
protected ConfigurationCommonTimeSource	timeSource Time source configuration
protected java.util.Map<java.lang.String,java.lang.Object>	transientConfiguration Transient configuration.
protected java.util.Map<java.lang.String,ConfigurationCommonVariable>	variables Map of variables.
protected java.util.Map<java.lang.String,ConfigurationCommonVariantStream>	variantStreams Variant streams allow events of disparate types to be treated the same.

Constructor Summary

Constructors

Constructor and Description
ConfigurationCommon() Constructs an empty configuration.

Method Summary

Modifier and Type	Method and Description
void	addAnnotationImport(java.lang.Class autoImport) Add a class to the imports available for annotations only
void	addAnnotationImport(java.lang.String importName) Adds a package or class to the list of automatically-imported classes and packages for use by annotations only.
void	addDatabaseReference(java.lang.String name, ConfigurationCommonDBRef configurationDBRef) Add a database reference with a given database name.
void	addEventType(java.lang.Class eventClass) Add an name for an event type represented by Java-bean plain-old Java object events, and the name is the simple class name of the class.
void	addEventType(java.lang.String eventTypeName, java.lang.Class eventClass) Add an name for an event type represented by Java-bean plain-old Java object events.
void	addEventType(java.lang.String eventTypeName, ConfigurationCommonEventTypeXMLDOM xmlDOMEventTypeDesc) Add an name for an event type that represents org.w3c.dom.Node events.
void	addEventType(java.lang.String eventTypeName, java.util.Map<java.lang.String,java.lang.Object> typeMap) Add an name 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	addEventType(java.lang.String eventTypeName, java.util.Map<java.lang.String,java.lang.Object> typeMap, ConfigurationCommonEventTypeMap mapConfig) Add a name 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	addEventType(java.lang.String eventTypeName, java.util.Map<java.lang.String,java.lang.Object> typeMap, java.lang.String[] superTypes) Add a name 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	addEventType(java.lang.String eventTypeName, java.util.Properties typeMap) Add an name for an event type that represents java.util.Map events.
void	addEventType(java.lang.String eventTypeName, java.lang.String eventClassName) Add an name for an event type represented by Java-bean plain-old Java object events.
void	addEventType(java.lang.String eventTypeName, java.lang.String[] propertyNames, java.lang.Object[] propertyTypes) Add an event type that represents Object-array (Object[]) events.
void	addEventType(java.lang.String eventTypeName, java.lang.String[] propertyNames, java.lang.Object[] propertyTypes, ConfigurationCommonEventTypeObjectArray optionalConfiguration) Add an event type that represents Object-array (Object[]) events.
void	addEventType(java.lang.String eventTypeName, java.lang.String eventClass, ConfigurationCommonEventTypeBean beanEventTypeDesc) Add an name for an event type that represents bean Java type (non-JavaBean style) events.
void	addEventTypeAutoName(java.lang.String packageName) Adds a Java package name of a package that Java event classes reside in.
void	addEventTypeAvro(java.lang.String eventTypeName, ConfigurationCommonEventTypeAvro avro) Adds an Avro event type
void	addImport(java.lang.Class autoImport) Adds a class to the list of automatically-imported classes.
void	addImport(java.lang.String autoImport) Adds a package or class to the list of automatically-imported classes and packages.
void	addMapConfiguration(java.lang.String mapeventTypeName, ConfigurationCommonEventTypeMap config) Add configuration for a map event type.
void	addMapSuperType(java.lang.String mapeventTypeName, java.lang.String mapSupertypeName) Add, for a given Map event type identified by the first parameter, the supertype (by its event type name).
void	addMethodRef(java.lang.Class clazz, ConfigurationCommonMethodRef methodInvocationConfig) Adds a cache configuration for a class providing methods for use in the from-clause.
void	addMethodRef(java.lang.String className, ConfigurationCommonMethodRef methodInvocationConfig) Adds a cache configuration for a class providing methods for use in the from-clause.
void	addObjectArrayConfiguration(java.lang.String objectArrayeventTypeName, ConfigurationCommonEventTypeObjectArray config) Add configuration for a object array event type.
void	addObjectArraySuperType(java.lang.String eventTypeName, java.lang.String supertypeName) Add, for a given Object-array event type identified by the first parameter, the supertype (by its event type name).
void	addVariable(java.lang.String variableName, java.lang.Class type, java.lang.Object initializationValue) Add a global variable.
void	addVariable(java.lang.String variableName, java.lang.Class type, java.lang.Object initializationValue, boolean constant) Add variable that can be a constant.
void	addVariable(java.lang.String variableName, java.lang.String type, java.lang.Object initializationValue) Add a global variable.
void	addVariable(java.lang.String variableName, java.lang.String type, java.lang.Object initializationValue, boolean constant) Add a global variable, allowing constants.
void	addVariantStream(java.lang.String variantStreamName, ConfigurationCommonVariantStream variantStreamConfig) Adds a new variant stream.
java.util.List<java.lang.String>	getAnnotationImports() Returns the annotation imports
java.util.Map<java.lang.String,ConfigurationCommonDBRef>	getDatabaseReferences() Returns the database names
ConfigurationCommonEventTypeMeta	getEventMeta() Returns event representation default settings.
java.util.Set<java.lang.String>	getEventTypeAutoNamePackages() Returns a set of Java package names that Java event classes reside in.
java.util.Map<java.lang.String,java.lang.String>	getEventTypeNames() Returns the mapping of event type name to Java class name.
java.util.Map<java.lang.String,ConfigurationCommonEventTypeAvro>	getEventTypesAvro() Returns the Avro event types.
java.util.Map<java.lang.String,ConfigurationCommonEventTypeBean>	getEventTypesBean() Returns the mapping of event type name to legacy java event type information.
java.util.Map<java.lang.String,java.util.Properties>	getEventTypesMapEvents() Returns a map keyed by event type name, and values being the definition for the Map event type of the property names and types that make up the event.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getEventTypesNestableMapEvents() Returns a map keyed by event type name, and values being the definition for the event type of the property names and types that make up the event, for nestable, strongly-typed Map-based event representations.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>	getEventTypesNestableObjectArrayEvents() Returns the object-array event types.
java.util.Map<java.lang.String,ConfigurationCommonEventTypeXMLDOM>	getEventTypesXMLDOM() Returns the mapping of event type name to XML DOM event type information.
ConfigurationCommonExecution	getExecution() Returns the execution settings.
java.util.List<java.lang.String>	getImports() Returns the imports
ConfigurationCommonLogging	getLogging() Returns logging settings applicable to common.
java.util.Map<java.lang.String,ConfigurationCommonEventTypeMap>	getMapTypeConfigurations() Returns for each Map event type name the set of supertype event type names (Map types only).
java.util.Map<java.lang.String,ConfigurationCommonMethodRef>	getMethodInvocationReferences() Returns the method-invocation-names for use in joins
java.util.Map<java.lang.String,ConfigurationCommonEventTypeObjectArray>	getObjectArrayTypeConfigurations() Returns the object-array event type configurations.
ConfigurationCommonTimeSource	getTimeSource() Returns the time source configuration.
java.util.Map<java.lang.String,java.lang.Object>	getTransientConfiguration() Returns transient configuration, i.e.
java.util.Map<java.lang.String,ConfigurationCommonVariable>	getVariables() Returns the preconfigured variables
java.util.Map<java.lang.String,ConfigurationCommonVariantStream>	getVariantStreams() Returns a map of variant stream name and variant configuration information.
boolean	isEventTypeExists(java.lang.String eventTypeName) Checks if an event type has already been registered for that name.
boolean	isVariantStreamExists(java.lang.String name) Returns true if a variant stream by the name has been declared, or false if not.
void	removeImport(java.lang.String name) Remove an import.
protected void	reset() Reset to an empty configuration.
void	setTransientConfiguration(java.util.Map<java.lang.String,java.lang.Object> transientConfiguration) Sets transient configuration, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANNOTATION_IMPORT

public static final java.lang.String ANNOTATION_IMPORT

Import name of the package that hosts the annotation classes.

DATAFLOWOPERATOR_IMPORT

public static final java.lang.String DATAFLOWOPERATOR_IMPORT

Import package for data flow operator forges.

eventClasses

protected java.util.Map<java.lang.String,java.lang.String> eventClasses

Map of event name and fully-qualified class name.

eventTypesXMLDOM

protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeXMLDOM> eventTypesXMLDOM

Map of event type name and XML DOM configuration.

eventTypesAvro

protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeAvro> eventTypesAvro

Map of event type name and XML DOM configuration.

eventTypesBean

protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeBean> eventTypesBean

Map of event type name and bean-type event configuration.

mapNames

protected java.util.Map<java.lang.String,java.util.Properties> mapNames

The type names for events that are backed by java.util.Map, not containing strongly-typed nested maps.

nestableMapNames

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> nestableMapNames

The type names for events that are backed by java.util.Map, possibly containing strongly-typed nested maps.

Each entrie's value must be either a Class or a Map<String,Object> to define nested maps.

nestableObjectArrayNames

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> nestableObjectArrayNames

The type names for events that are backed by java.util.Map, possibly containing strongly-typed nested maps.

Each entrie's value must be either a Class or a Map<String,Object> to define nested maps.

mapTypeConfigurations

protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeMap> mapTypeConfigurations

Map event types additional configuration information.

objectArrayTypeConfigurations

protected java.util.Map<java.lang.String,ConfigurationCommonEventTypeObjectArray> objectArrayTypeConfigurations

Map event types additional configuration information.

imports

protected java.util.List<java.lang.String> imports

The class and package name imports that will be used to resolve partial class names.

annotationImports

protected java.util.List<java.lang.String> annotationImports

For annotations only, the class and package name imports that will be used to resolve partial class names (not available in EPL statements unless used in an annotation).

databaseReferences

protected java.util.Map<java.lang.String,ConfigurationCommonDBRef> databaseReferences

The class and package name imports that will be used to resolve partial class names.

variables

protected java.util.Map<java.lang.String,ConfigurationCommonVariable> variables

Map of variables.

methodInvocationReferences

protected java.util.Map<java.lang.String,ConfigurationCommonMethodRef> methodInvocationReferences

Map of class name and configuration for method invocations on that class.

variantStreams

protected java.util.Map<java.lang.String,ConfigurationCommonVariantStream> variantStreams

Variant streams allow events of disparate types to be treated the same.

transientConfiguration

protected transient java.util.Map<java.lang.String,java.lang.Object> transientConfiguration

Transient configuration.

eventMeta

protected ConfigurationCommonEventTypeMeta eventMeta

Event type common configuration

logging

protected ConfigurationCommonLogging logging

Logging configuration.

timeSource

protected ConfigurationCommonTimeSource timeSource

Time source configuration

execution

protected ConfigurationCommonExecution execution

Execution-related configuration

Constructor Detail

ConfigurationCommon

public ConfigurationCommon()

Constructs an empty configuration. The auto import values are set by default to java.lang, java.math, java.text and java.util.

Method Detail

isEventTypeExists

public boolean isEventTypeExists(java.lang.String eventTypeName)

Checks if an event type has already been registered for that name.

Parameters:

eventTypeName - the name

Returns:

true if already registered

Since:

2.1

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.lang.String eventClassName)

Add an name for an event type represented by Java-bean plain-old Java object events.

A given class can be associated to multiple event types, each representing a separate event stream. I.e. event type identity is by event type name and not by Java class (version 8.x and newer).

Applications should register superclasses and interfaces before registering child classes and implementations, for applications that intend to use superclasses and interfaces by a name other than the fully-qualified class name.

Parameters:

eventTypeName - is the name for the event type

eventClassName - fully-qualified class name of the event type

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.lang.Class eventClass)

Add an name for an event type represented by Java-bean plain-old Java object events.

A given class can be associated to multiple event types, each representing a separate event stream. I.e. event type identity is by event type name and not by Java class (version 8.x and newer).

Applications should register superclasses and interfaces before registering child classes and implementations, for applications that intend to use superclasses and interfaces by a name other than the fully-qualified class name.

Parameters:

eventTypeName - is the name for the event type

eventClass - is the Java event class for which to add the name

addEventType

public void addEventType(java.lang.Class eventClass)

Add an name for an event type represented by Java-bean plain-old Java object events, and the name is the simple class name of the class.

Parameters:

eventClass - is the Java event class for which to add the name

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.util.Properties typeMap)

Add an name for an event type that represents java.util.Map events.

Each entry in the type map is the property name and the fully-qualified Java class name or primitive type name.

Parameters:

eventTypeName - is the name 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.

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.util.Map<java.lang.String,java.lang.Object> typeMap)

Add an name 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.

Each entry in the type mapping must contain the String property name as the key value, and either a Class, or a further Map<String, Object>, or the name of another previously-register Map event type (append [] for array of Map).

Parameters:

eventTypeName - is the name 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.

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.util.Map<java.lang.String,java.lang.Object> typeMap,
                         java.lang.String[] superTypes)

Add a name 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.

Each entry in the type mapping must contain the String property name as the key value, and either a Class, or a further Map<String, Object>, or the name of another previously-register Map event type (append [] for array of Map).

Parameters:

eventTypeName - is the name 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.

superTypes - is an array of event type name of further Map types that this

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.util.Map<java.lang.String,java.lang.Object> typeMap,
                         ConfigurationCommonEventTypeMap mapConfig)

Add a name 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.

Each entry in the type mapping must contain the String property name as the key value, and either a Class, or a further Map<String, Object>, or the name of another previously-register Map event type (append [] for array of Map).

Parameters:

eventTypeName - is the name 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.

mapConfig - is the Map-event type configuration that may defined super-types, timestamp-property-name etc.

addMapSuperType

public void addMapSuperType(java.lang.String mapeventTypeName,
                            java.lang.String mapSupertypeName)

Add, for a given Map event type identified by the first parameter, the supertype (by its event type name).

Each Map event type may have any number of supertypes, each supertype must also be of a Map-type event.

Parameters:

mapeventTypeName - the name of a Map event type, that is to have a supertype

mapSupertypeName - the name of a Map event type that is the supertype

addObjectArraySuperType

public void addObjectArraySuperType(java.lang.String eventTypeName,
                                    java.lang.String supertypeName)

Add, for a given Object-array event type identified by the first parameter, the supertype (by its event type name).

Each Object array event type may have any number of supertypes, each supertype must also be of a Object-array-type event.

Parameters:

eventTypeName - the name of a Map event type, that is to have a supertype

supertypeName - the name of a Map event type that is the supertype

addMapConfiguration

public void addMapConfiguration(java.lang.String mapeventTypeName,
                                ConfigurationCommonEventTypeMap config)

Add configuration for a map event type.

Parameters:

mapeventTypeName - configuration to add

config - map type configuration

addObjectArrayConfiguration

public void addObjectArrayConfiguration(java.lang.String objectArrayeventTypeName,
                                        ConfigurationCommonEventTypeObjectArray config)

Add configuration for a object array event type.

Parameters:

objectArrayeventTypeName - configuration to add

config - map type configuration

addEventType

public void addEventType(java.lang.String eventTypeName,
                         ConfigurationCommonEventTypeXMLDOM xmlDOMEventTypeDesc)

Add an name for an event type that represents org.w3c.dom.Node events.

Parameters:

eventTypeName - is the name for the event type

xmlDOMEventTypeDesc - descriptor containing property and mapping information for XML-DOM events

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.lang.String[] propertyNames,
                         java.lang.Object[] propertyTypes)

Add an event type that represents Object-array (Object[]) events.

Parameters:

eventTypeName - is the name for the event type

propertyNames - name of each property, length must match number of types

propertyTypes - type of each property, length must match number of names

Throws:

ConfigurationException - if the name is already in used for a different type

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.lang.String[] propertyNames,
                         java.lang.Object[] propertyTypes,
                         ConfigurationCommonEventTypeObjectArray optionalConfiguration)
                  throws ConfigurationException

Add an event type that represents Object-array (Object[]) events.

Parameters:

eventTypeName - is the name for the event type

propertyNames - name of each property, length must match number of types

propertyTypes - type of each property, length must match number of names

optionalConfiguration - object-array type configuration

Throws:

ConfigurationException - if the name is already in used for a different type

addDatabaseReference

public void addDatabaseReference(java.lang.String name,
                                 ConfigurationCommonDBRef configurationDBRef)

Add a database reference with a given database name.

Parameters:

name - is the database name

configurationDBRef - descriptor containing database connection and access policy information

addEventType

public void addEventType(java.lang.String eventTypeName,
                         java.lang.String eventClass,
                         ConfigurationCommonEventTypeBean beanEventTypeDesc)

Add an name for an event type that represents bean Java type (non-JavaBean style) events.

A given class can be associated to multiple event types, each representing a separate event stream. I.e. event type identity is by event type name and not by Java class (version 8.x and newer).

Applications should register superclasses and interfaces before registering child classes and implementations, for applications that intend to use superclasses and interfaces by a name other than the fully-qualified class name.

Parameters:

eventTypeName - is the name for the event type

eventClass - fully-qualified class name of the event type

beanEventTypeDesc - descriptor containing property and mapping information for Legacy Java type events

addImport

public void addImport(java.lang.String autoImport)

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, specify a package with wildcard, such as com.mycompany.staticlib.*.

Parameters:

autoImport - is a fully-qualified class name or a package name with wildcard

addImport

public void addImport(java.lang.Class autoImport)

Adds a class to the list of automatically-imported classes.

Use #addImport(String) to import a package.

Parameters:

autoImport - is a class to import

addAnnotationImport

public void addAnnotationImport(java.lang.String importName)

Adds a package or class to the list of automatically-imported classes and packages for use by annotations only.

Parameters:

importName - import such as package name, class name, or package with ".*".

Throws:

ConfigurationException - if incorrect package or class names are encountered

addAnnotationImport

public void addAnnotationImport(java.lang.Class autoImport)

Add a class to the imports available for annotations only

Parameters:

autoImport - class to add

removeImport

public void removeImport(java.lang.String name)

Remove an import.

Parameters:

name - to remove

addMethodRef

public void addMethodRef(java.lang.String className,
                         ConfigurationCommonMethodRef methodInvocationConfig)

Adds a cache configuration for a class providing methods for use in the from-clause.

Parameters:

className - is the class name (simple or fully-qualified) providing methods

methodInvocationConfig - is the cache configuration

addMethodRef

public void addMethodRef(java.lang.Class clazz,
                         ConfigurationCommonMethodRef methodInvocationConfig)

Adds a cache configuration for a class providing methods for use in the from-clause.

Parameters:

clazz - is the class providing methods

methodInvocationConfig - is the cache configuration

getEventTypeNames

public java.util.Map<java.lang.String,java.lang.String> getEventTypeNames()

Returns the mapping of event type name to Java class name.

Returns:

event type names for Java class names

getEventTypesMapEvents

public java.util.Map<java.lang.String,java.util.Properties> getEventTypesMapEvents()

Returns a map keyed by event type name, and values being the definition for the Map event type of the property names and types that make up the event.

Returns:

map of event type name and definition of event properties

getEventTypesNestableMapEvents

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getEventTypesNestableMapEvents()

Returns a map keyed by event type name, and values being the definition for the event type of the property names and types that make up the event, for nestable, strongly-typed Map-based event representations.

Returns:

map of event type name and definition of event properties

getEventTypesNestableObjectArrayEvents

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> getEventTypesNestableObjectArrayEvents()

Returns the object-array event types.

Returns:

object-array event types

getEventTypesXMLDOM

public java.util.Map<java.lang.String,ConfigurationCommonEventTypeXMLDOM> getEventTypesXMLDOM()

Returns the mapping of event type name to XML DOM event type information.

Returns:

event type name mapping to XML DOM configs

getEventTypesAvro

public java.util.Map<java.lang.String,ConfigurationCommonEventTypeAvro> getEventTypesAvro()

Returns the Avro event types.

Returns:

Avro event types

getEventTypesBean

public java.util.Map<java.lang.String,ConfigurationCommonEventTypeBean> getEventTypesBean()

Returns the mapping of event type name to legacy java event type information.

Returns:

event type name mapping to legacy java class configs

getImports

public java.util.List<java.lang.String> getImports()

Returns the imports

Returns:

imports

getAnnotationImports

public java.util.List<java.lang.String> getAnnotationImports()

Returns the annotation imports

Returns:

annotation imports

getDatabaseReferences

public java.util.Map<java.lang.String,ConfigurationCommonDBRef> getDatabaseReferences()

Returns the database names

Returns:

database names

getObjectArrayTypeConfigurations

public java.util.Map<java.lang.String,ConfigurationCommonEventTypeObjectArray> getObjectArrayTypeConfigurations()

Returns the object-array event type configurations.

Returns:

type configs

getVariables

public java.util.Map<java.lang.String,ConfigurationCommonVariable> getVariables()

Returns the preconfigured variables

Returns:

variables

getMethodInvocationReferences

public java.util.Map<java.lang.String,ConfigurationCommonMethodRef> getMethodInvocationReferences()

Returns the method-invocation-names for use in joins

Returns:

method-invocation-names

getMapTypeConfigurations

public java.util.Map<java.lang.String,ConfigurationCommonEventTypeMap> getMapTypeConfigurations()

Returns for each Map event type name the set of supertype event type names (Map types only).

Returns:

map of name to set of supertype names

addVariable

public void addVariable(java.lang.String variableName,
                        java.lang.Class type,
                        java.lang.Object initializationValue)

Add a global variable.

Use the runtime API to set variable values or EPL statements to change variable values.

Parameters:

variableName - name of the variable to add

type - the type name of the variable, must be a primitive or boxed Java-builtin scalar type or "object" for any value or an event type name or a class name or fully-qualified class name. Append "[]" for array.

initializationValue - is the first assigned value. For static initialization the value can be string-typed and will be parsed. For static initialization the initialization value, if provided, must implement Serializable or Externalizable.

Throws:

ConfigurationException - if the type and initialization value don't match or the variable name is already in use

addVariable

public void addVariable(java.lang.String variableName,
                        java.lang.Class type,
                        java.lang.Object initializationValue,
                        boolean constant)

Add variable that can be a constant.

Parameters:

variableName - name of variable

type - variable type

initializationValue - initial value

constant - constant indicator

addVariable

public void addVariable(java.lang.String variableName,
                        java.lang.String type,
                        java.lang.Object initializationValue)

Add a global variable.

Use the runtime API to set variable values or EPL statements to change variable values.

Parameters:

variableName - name of the variable to add

type - the type name of the variable, must be a primitive or boxed Java-builtin scalar type or "object" for any value or an event type name or a class name or fully-qualified class name. Append "[]" for array.

initializationValue - is the first assigned value The value can be string-typed and will be parsed. For static initialization the initialization value, if provided, must implement Serializable or Externalizable.

Throws:

ConfigurationException - if the type and initialization value don't match or the variable name is already in use

addVariable

public void addVariable(java.lang.String variableName,
                        java.lang.String type,
                        java.lang.Object initializationValue,
                        boolean constant)

Add a global variable, allowing constants.

Use the runtime API to set variable values or EPL statements to change variable values.

Parameters:

variableName - name of the variable to add

type - the type name of the variable, must be a primitive or boxed Java-builtin scalar type or "object" for any value or an event type name or a class name or fully-qualified class name. Append "[]" for array.

initializationValue - is the first assigned value For static initialization the value can be string-typed and will be parsed. For static initialization the initialization value, if provided, must implement Serializable or Externalizable.

constant - true to identify the variable as a constant

Throws:

ConfigurationException - if the type and initialization value don't match or the variable name is already in use

addVariantStream

public void addVariantStream(java.lang.String variantStreamName,
                             ConfigurationCommonVariantStream variantStreamConfig)

Adds a new variant stream. Variant streams allow events of disparate types to be treated the same.

Parameters:

variantStreamName - is the name of the variant stream

variantStreamConfig - the configuration such as variant type names and any-type setting

getVariantStreams

public java.util.Map<java.lang.String,ConfigurationCommonVariantStream> getVariantStreams()

Returns a map of variant stream name and variant configuration information. Variant streams allows handling events of all sorts of different event types the same way.

Returns:

map of name and variant stream config

isVariantStreamExists

public boolean isVariantStreamExists(java.lang.String name)

Returns true if a variant stream by the name has been declared, or false if not.

Parameters:

name - of variant stream

Returns:

indicator whether the variant stream by that name exists

addEventTypeAvro

public void addEventTypeAvro(java.lang.String eventTypeName,
                             ConfigurationCommonEventTypeAvro avro)

Adds an Avro event type

Parameters:

eventTypeName - type name

avro - configs

getTransientConfiguration

public java.util.Map<java.lang.String,java.lang.Object> getTransientConfiguration()

Returns transient configuration, i.e. information that is passed along as a reference and not as a value

Returns:

map of transients

setTransientConfiguration

public void setTransientConfiguration(java.util.Map<java.lang.String,java.lang.Object> transientConfiguration)

Sets transient configuration, i.e. information that is passed along as a reference and not as a value

Parameters:

transientConfiguration - map of transients

getEventMeta

public ConfigurationCommonEventTypeMeta getEventMeta()

Returns event representation default settings.

Returns:

event representation default settings

getTimeSource

public ConfigurationCommonTimeSource getTimeSource()

Returns the time source configuration.

Returns:

time source enum

reset

protected void reset()

Reset to an empty configuration.

getLogging

public ConfigurationCommonLogging getLogging()

Returns logging settings applicable to common.

Returns:

logging settings

getExecution

public ConfigurationCommonExecution getExecution()

Returns the execution settings.

Returns:

execution settings

addEventTypeAutoName

public void addEventTypeAutoName(java.lang.String packageName)

Adds a Java package name of a package that Java event classes reside in.

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 runtime attempts to resolve an event type name to a Java class residing in each declared package.

For example, in the statement "select * from MyEvent" the runtime attempts to load class "javaPackageName.MyEvent" and if successful, uses that class as the event type.

Parameters:

packageName - is the fully-qualified Java package name of the Java package that event classes reside in

getEventTypeAutoNamePackages

public java.util.Set<java.lang.String> getEventTypeAutoNamePackages()

Returns a set of Java package names that Java event classes reside in.

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 runtime attempts to resolve an event type name to a Java class residing in each declared package.

For example, in the statement "select * from MyEvent" the runtime attempts to load class "javaPackageName.MyEvent" and if successful, uses that class as the event type.

Returns:

set of Java package names to look for events types when encountering a new event type name