Click or drag to resize

ConfigurationCommonEventTypeXMLDOM Class

Configuration object for enabling the runtime to process events represented as XML DOM document nodes.

Use this class to configure the runtime for processing of XML DOM objects that represent events and contain all the data for event properties used by statements.

Minimally required is the root element name which allows the runtime to map the document to the event type that has been named in an EPL or pattern statement.

Event properties that are results of XPath expressions can be made known to the runtime via this class. For XPath expressions that must refer to namespace prefixes those prefixes and their namespace name must be supplied to the runtime. A default namespace can be supplied as well.

By supplying a schema resource the runtime can interrogate the schema, allowing the runtime to verify event properties and return event properties in the type defined by the schema. When a schema resource is supplied, the optional root element namespace defines the namespace in case the root element name occurs in multiple namespaces.

Inheritance Hierarchy
SystemObject
  com.espertech.esper.common.client.configuration.commonConfigurationCommonEventTypeXMLDOM

Namespace:  com.espertech.esper.common.client.configuration.common
Assembly:  NEsper.Common (in NEsper.Common.dll) Version: 8.0.0.0
Syntax
C#
[SerializableAttribute]
public class ConfigurationCommonEventTypeXMLDOM

The ConfigurationCommonEventTypeXMLDOM type exposes the following members.

Constructors
  NameDescription
Public methodConfigurationCommonEventTypeXMLDOM
Ctor.
Top
Properties
  NameDescription
Public propertyDefaultNamespace
Returns the default namespace.
Public propertyEndTimestampPropertyName
Returns the property name of the property providing the end timestamp value.
Public propertyIsAutoFragment
Set to true (the default) to look up or create event types representing fragments of an XML document automatically upon request for fragment event type information; Or false when only explicit properties may return fragments.
Public propertyIsEventSenderValidatesRoot
Returns true to indicate that an returned for this event type validates the root document element name against the one configured (the default), or false to not validate the root document element name as configured.
Public propertyIsXPathPropertyExpr
Returns false to indicate that property expressions are evaluated by the DOM-walker implementation (the default), or true to indicate that property expressions are rewritten into XPath expressions.
Public propertyIsXPathResolvePropertiesAbsolute
When set to true (the default), indicates that when properties are compiled to XPath expressions that the compilation should generate an absolute XPath expression such as "/getQuote/request" for the simple request property, or "/getQuote/request/symbol" for a "request.symbol" nested property, wherein the root element node is "getQuote".

When set to false, indicates that when properties are compiled to XPath expressions that the compilation should generate a deep XPath expression such as "//symbol" for the simple symbol property, or "//request/symbol" for a "request.symbol" nested property.

Public propertyNamespacePrefixes
Returns the namespace prefixes in a map of prefix as key and namespace name as value.
Public propertyRootElementName
Returns the root element name.
Public propertyRootElementNamespace
Returns the root element namespace.
Public propertySchemaResource
Returns the schema resource.
Public propertySchemaText
Returns the schema text, if provided instead of a schema resource, this call returns the actual text of the schema document.

Set a schema text first. This call will not resolve the schema resource to a text.

Public propertyStartTimestampPropertyName
Returns the property name of the property providing the start timestamp value.
Public propertyXPathFunctionResolver
Returns the class name of the XPath function resolver to be assigned to the XPath factory instance upon type initialization.
Public propertyXPathProperties
Returns a map of property name and descriptor for XPath-expression properties.
Public propertyXPathVariableResolver
Returns the class name of the XPath variable resolver to be assigned to the XPath factory instance upon type initialization.
Top
Methods
  NameDescription
Public methodAddNamespacePrefix
Add a prefix and namespace name for use in XPath expressions refering to that prefix.
Public methodAddNamespacePrefixes
Public methodAddXPathProperty(String, String, XPathResultType)
Adds an event property for which the runtime uses the supplied XPath expression against a DOM document node to resolve a property value.
Public methodAddXPathProperty(String, String, XPathResultType, String)
Adds an event property for which the runtime uses the supplied XPath expression against a DOM document node to resolve a property value.
Public methodAddXPathPropertyFragment
Adds an event property for which the runtime uses the supplied XPath expression against a DOM document node to resolve a property value.
Public methodEquals
Public methodGetHashCode
Top
See Also