com.espertech.esper.event.xml
Class DOMComplexElementGetter

java.lang.Object
  com.espertech.esper.event.xml.DOMComplexElementGetter

All Implemented Interfaces:

EventPropertyGetter, DOMPropertyGetter

public class DOMComplexElementGetter
extends java.lang.Object
implements EventPropertyGetter, DOMPropertyGetter

Getter for a DOM complex element.

Constructor Summary

DOMComplexElementGetter(java.lang.String propertyName, FragmentFactory fragmentFactory, boolean isArray)
Ctor.

Method Summary

java.lang.Object	get(EventBean obj) Return the value for the property in the event object specified when the instance was obtained.
java.lang.Object	getFragment(EventBean obj) Returns EventBean or array of EventBean for a property name or property expression.
java.lang.Object	getValueAsFragment(org.w3c.dom.Node node) Returns a property value as a fragment.
org.w3c.dom.Node	getValueAsNode(org.w3c.dom.Node node) Returns a property value as a node.
org.w3c.dom.Node[]	getValueAsNodeArray(org.w3c.dom.Node node) Returns a property value that is indexed as a node array.
boolean	isExistsProperty(EventBean eventBean) Returns true if the property exists, or false if the type does not have such a property.

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMComplexElementGetter

public DOMComplexElementGetter(java.lang.String propertyName,
                               FragmentFactory fragmentFactory,
                               boolean isArray)

Ctor.

Parameters:

propertyName - property name

fragmentFactory - for creating fragments

isArray - if this is an array property

Method Detail

getValueAsFragment

public java.lang.Object getValueAsFragment(org.w3c.dom.Node node)

Description copied from interface: DOMPropertyGetter

Returns a property value as a fragment.

Specified by:

getValueAsFragment in interface DOMPropertyGetter

Parameters:

node - to evaluate

Returns:

fragment

getValueAsNode

public org.w3c.dom.Node getValueAsNode(org.w3c.dom.Node node)

Description copied from interface: DOMPropertyGetter

Returns a property value as a node.

Specified by:

getValueAsNode in interface DOMPropertyGetter

Parameters:

node - to evaluate

Returns:

value node

getValueAsNodeArray

public org.w3c.dom.Node[] getValueAsNodeArray(org.w3c.dom.Node node)

Description copied from interface: DOMPropertyGetter

Returns a property value that is indexed as a node array.

Specified by:

getValueAsNodeArray in interface DOMPropertyGetter

Parameters:

node - to evaluate

Returns:

nodes

get

public java.lang.Object get(EventBean obj)
                     throws PropertyAccessException

Description copied from interface: EventPropertyGetter

Return the value for the property in the event object specified when the instance was obtained. Useful for fast access to event properties. Throws a PropertyAccessException if the getter instance doesn't match the EventType it was obtained from, and to indicate other property access problems.

Specified by:

get in interface EventPropertyGetter

Parameters:

obj - is the event to get the value of a property from

Returns:

value of property in event

Throws:

PropertyAccessException - to indicate that property access failed

isExistsProperty

public boolean isExistsProperty(EventBean eventBean)

Description copied from interface: EventPropertyGetter

Returns true if the property exists, or false if the type does not have such a property.

Useful for dynamic properties of the syntax "property?" and the dynamic nested/indexed/mapped versions. Dynamic nested properties follow the syntax "property?.nested" which is equivalent to "property?.nested?". If any of the properties in the path of a dynamic nested property return null, the dynamic nested property does not exists and the method returns false.

For non-dynamic properties, this method always returns true since a getter would not be available unless

Specified by:

isExistsProperty in interface EventPropertyGetter

Parameters:

eventBean - is the event to check if the dynamic property exists

Returns:

indictor whether the property exists, always true for non-dynamic (default) properties

getFragment

public java.lang.Object getFragment(EventBean obj)
                             throws PropertyAccessException

Description copied from interface: EventPropertyGetter

Returns EventBean or array of EventBean for a property name or property expression.

For use with properties whose value is itself an event or whose value can be represented as an event by the underlying event representation.

The EventType of the EventBean instance(s) returned by this method can be determined by EventType.getFragmentType(String). Use EventPropertyDescriptor to obtain a list of properties that return fragments from an event type.

Returns null if the property value is null or the property value cannot be represented as a fragment by the underlying representation.

Specified by:

getFragment in interface EventPropertyGetter

Parameters:

obj - is the event to get the fragment value of a property

Returns:

the value of a property as an EventBean or array of EventBean

Throws:

PropertyAccessException - - if there is no property of the specified name, or the property cannot be accessed