|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.esper.client.ConfigurationEventTypeXMLDOM
public class ConfigurationEventTypeXMLDOM
Configuration object for enabling the engine to process events represented as XML DOM document nodes.
Use this class to configure the engine 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 engine to map the document to the event type that has been named in an EQL or pattern statement.
Event properties that are results of XPath expressions can be made known to the engine via this class. For XPath expressions that must refer to namespace prefixes those prefixes and their namespace name must be supplied to the engine. A default namespace can be supplied as well.
By supplying a schema resource the engine can interrogate the schema, allowing the engine 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.
Nested Class Summary | |
---|---|
static class |
ConfigurationEventTypeXMLDOM.XPathPropertyDesc
Descriptor class for event properties that are resolved via XPath-expression. |
Constructor Summary | |
---|---|
ConfigurationEventTypeXMLDOM()
Ctor. |
Method Summary | |
---|---|
void |
addNamespacePrefix(String prefix,
String namespace)
Add a prefix and namespace name for use in XPath expressions refering to that prefix. |
void |
addXPathProperty(String name,
String xpath,
QName type)
Adds an event property for which the engine uses the supplied XPath expression against a DOM document node to resolve a property value. |
boolean |
equals(Object otherObj)
|
String |
getDefaultNamespace()
Returns the default namespace. |
Map<String,String> |
getNamespacePrefixes()
Returns the namespace prefixes in a map of prefix as key and namespace name as value. |
String |
getRootElementName()
Returns the root element name. |
String |
getRootElementNamespace()
Returns the root element namespace. |
String |
getSchemaResource()
Returns the schema resource. |
Map<String,ConfigurationEventTypeXMLDOM.XPathPropertyDesc> |
getXPathProperties()
Returns a map of property name and descriptor for XPath-expression properties. |
int |
hashCode()
|
void |
setDefaultNamespace(String defaultNamespace)
Sets the default namespace. |
void |
setRootElementName(String rootElementName)
Sets the root element name. |
void |
setRootElementNamespace(String rootElementNamespace)
Sets the root element namespace. |
void |
setSchemaResource(String schemaResource)
Sets the schema resource. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConfigurationEventTypeXMLDOM()
Method Detail |
---|
public String getRootElementName()
public void setRootElementName(String rootElementName)
rootElementName
- is the name of the root elementpublic String getRootElementNamespace()
public void setRootElementNamespace(String rootElementNamespace)
rootElementNamespace
- is the namespace for the root elementpublic String getDefaultNamespace()
public void setDefaultNamespace(String defaultNamespace)
defaultNamespace
- is the default namespacepublic String getSchemaResource()
public void setSchemaResource(String schemaResource)
schemaResource
- is the schema resourcepublic Map<String,ConfigurationEventTypeXMLDOM.XPathPropertyDesc> getXPathProperties()
public void addXPathProperty(String name, String xpath, QName type)
name
- of the event propertyxpath
- is an arbitrary xpath expressiontype
- is a constant obtained from javax.xml.xpath.XPathConstants. Typical values are
XPathConstants.NUMBER, STRING and BOOLEAN.public Map<String,String> getNamespacePrefixes()
public void addNamespacePrefix(String prefix, String namespace)
prefix
- is the prefix of the namespacenamespace
- is the namespace namepublic boolean equals(Object otherObj)
equals
in class Object
public int hashCode()
hashCode
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |