com.espertech.esper.common.client.annotation

Annotation Type XMLSchema

@Retention(value=RUNTIME)
public @interface XMLSchema

Annotation for use with XML schemas. Only the root element name is required.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	rootElementName The root element name (required).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoFragment 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.
String	defaultNamespace The default namespace
boolean	eventSenderValidatesRoot Set to true (the default) to indicate that an EventSender 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.
String	rootElementNamespace The root element namespace
String	schemaResource The schema resource URL
String	schemaText The schema text
String	xpathFunctionResolver Sets the class name of the XPath function resolver to be assigned to the XPath factory instance upon type initialization.
boolean	xpathPropertyExpr Set to false (the default) to indicate that property expressions are evaluated by the DOM-walker implementation (the default), or set to true to indicate that property expressions are rewritten into XPath expressions.
boolean	xpathResolvePropertiesAbsolute 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".
String	xpathVariableResolver Sets the class name of the XPath variable resolver to be assigned to the XPath factory instance upon type initialization.

Element Detail

rootElementName

public abstract String rootElementName

The root element name (required).

Returns:

root element name

schemaResource

public abstract String schemaResource

The schema resource URL

Returns:

url

Default:

""

schemaText

public abstract String schemaText

The schema text

Returns:

schema

Default:

""

xpathPropertyExpr

public abstract boolean xpathPropertyExpr

Set to false (the default) to indicate that property expressions are evaluated by the DOM-walker implementation (the default), or set to true to indicate that property expressions are rewritten into XPath expressions.

Returns:

xpath property use

Default:

false

xpathResolvePropertiesAbsolute

public abstract boolean xpathResolvePropertiesAbsolute

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.

Returns:

xpath resolve properties absolute flag

Default:

true

defaultNamespace

public abstract String defaultNamespace

The default namespace

Returns:

default namespace

Default:

""

rootElementNamespace

public abstract String rootElementNamespace

The root element namespace

Returns:

root element namespace

Default:

""

eventSenderValidatesRoot

public abstract boolean eventSenderValidatesRoot

Set to true (the default) to indicate that an EventSender 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.

Returns:

flag

Default:

true

autoFragment

public abstract boolean autoFragment

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.

Returns:

flag

Default:

true

xpathFunctionResolver

public abstract String xpathFunctionResolver

Sets the class name of the XPath function resolver to be assigned to the XPath factory instance upon type initialization.

Returns:

class name

Default:

""

xpathVariableResolver

public abstract String xpathVariableResolver

Sets the class name of the XPath variable resolver to be assigned to the XPath factory instance upon type initialization.

Returns:

class name

Default:

""