Package com.espertech.esper.common.internal.event.xml

Class XPathPropertyGetter

java.lang.Object

com.espertech.esper.common.internal.event.xml.XPathPropertyGetter

All Implemented Interfaces:

EventPropertyGetter, EventPropertyValueGetter, EventPropertyGetterSPI, EventPropertyValueGetterForge

public class XPathPropertyGetter
extends Object
implements EventPropertyGetterSPI

Getter for properties of DOM xml events.

Author:

pablo

Field Summary

Fields

Modifier and Type	Field	Description
static final EPTypeClass	EPTYPE

Fields inherited from interface com.espertech.esper.common.client.EventPropertyValueGetter

EPTYPEARRAY

Constructor Summary

Constructors

Constructor	Description
XPathPropertyGetter(BaseXMLEventType baseXMLEventType, String propertyName, String expressionText, XPathExpression xPathExpression, QName resultType, EPTypeClass optionalCastToType, FragmentFactory fragmentFactory)

Method Summary

Modifier and Type	Method	Description
static Object	evaluateXPathFragment(Object und, XPathExpression expression, String expressionText, String property, FragmentFactory fragmentFactory, QName resultType)
static Object	evaluateXPathGet(Node und, XPathExpression expression, String expressionText, String property, EPTypeClass optionalCastToType, QName resultType, boolean isCastToArray, SimpleTypeParser simpleTypeParser)	NOTE: Code-generation-invoked method, method name and parameter order matters
CodegenExpression	eventBeanExistsCodegen(CodegenExpression beanExpression, CodegenMethodScope codegenMethodScope, CodegenClassScope codegenClassScope)
CodegenExpression	eventBeanFragmentCodegen(CodegenExpression beanExpression, CodegenMethodScope codegenMethodScope, CodegenClassScope codegenClassScope)
CodegenExpression	eventBeanGetCodegen(CodegenExpression beanExpression, CodegenMethodScope codegenMethodScope, CodegenClassScope codegenClassScope)
Object	get(EventBean eventBean)	Return the value for the property in the event object specified when the instance was obtained.
Object	getFragment(EventBean eventBean)	Returns EventBean or array of EventBean for a property name or property expression.
Object	getFragmentFromUnderlying(Object und)
Object	getFromUnderlying(Node node)
String	getProperty()
boolean	isExistsProperty(EventBean eventBean)	Returns true if the property exists, or false if the type does not have such a property.
CodegenExpression	underlyingExistsCodegen(CodegenExpression underlyingExpression, CodegenMethodScope codegenMethodScope, CodegenClassScope codegenClassScope)
CodegenExpression	underlyingFragmentCodegen(CodegenExpression underlyingExpression, CodegenMethodScope codegenMethodScope, CodegenClassScope codegenClassScope)
CodegenExpression	underlyingGetCodegen(CodegenExpression underlyingExpression, CodegenMethodScope codegenMethodScope, CodegenClassScope codegenClassScope)

Methods inherited from class java.lang.Object

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

Field Details

EPTYPE

public static final EPTypeClass EPTYPE

Constructor Details

XPathPropertyGetter

public XPathPropertyGetter(BaseXMLEventType baseXMLEventType,
 String propertyName,
 String expressionText,
 XPathExpression xPathExpression,
 QName resultType,
 EPTypeClass optionalCastToType,
 FragmentFactory fragmentFactory)

Method Details

get

public Object get(EventBean eventBean)
           throws PropertyAccessException

Description copied from interface: EventPropertyValueGetter

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 EventPropertyValueGetter

Parameters:

eventBean - 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

getFromUnderlying

public Object getFromUnderlying(Node node)
                         throws PropertyAccessException

Throws:

PropertyAccessException

evaluateXPathGet

public static Object evaluateXPathGet(Node und,
 XPathExpression expression,
 String expressionText,
 String property,
 EPTypeClass optionalCastToType,
 QName resultType,
 boolean isCastToArray,
 SimpleTypeParser simpleTypeParser)

NOTE: Code-generation-invoked method, method name and parameter order matters

Parameters:

und - underlying

expression - xpath

expressionText - text

property - prop

optionalCastToType - type or null

resultType - result xpath type

isCastToArray - array indicator

simpleTypeParser - parse

Returns:

value

evaluateXPathFragment

public static Object evaluateXPathFragment(Object und,
 XPathExpression expression,
 String expressionText,
 String property,
 FragmentFactory fragmentFactory,
 QName resultType)

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 Object getFragment(EventBean eventBean)

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:

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

Returns:

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

getFragmentFromUnderlying

public Object getFragmentFromUnderlying(Object und)

eventBeanGetCodegen

public CodegenExpression eventBeanGetCodegen(CodegenExpression beanExpression,
 CodegenMethodScope codegenMethodScope,
 CodegenClassScope codegenClassScope)

Specified by:

eventBeanGetCodegen in interface EventPropertyValueGetterForge

eventBeanExistsCodegen

public CodegenExpression eventBeanExistsCodegen(CodegenExpression beanExpression,
 CodegenMethodScope codegenMethodScope,
 CodegenClassScope codegenClassScope)

Specified by:

eventBeanExistsCodegen in interface EventPropertyGetterSPI

eventBeanFragmentCodegen

public CodegenExpression eventBeanFragmentCodegen(CodegenExpression beanExpression,
 CodegenMethodScope codegenMethodScope,
 CodegenClassScope codegenClassScope)

Specified by:

eventBeanFragmentCodegen in interface EventPropertyGetterSPI

underlyingGetCodegen

public CodegenExpression underlyingGetCodegen(CodegenExpression underlyingExpression,
 CodegenMethodScope codegenMethodScope,
 CodegenClassScope codegenClassScope)

Specified by:

underlyingGetCodegen in interface EventPropertyGetterSPI

underlyingExistsCodegen

public CodegenExpression underlyingExistsCodegen(CodegenExpression underlyingExpression,
 CodegenMethodScope codegenMethodScope,
 CodegenClassScope codegenClassScope)

Specified by:

underlyingExistsCodegen in interface EventPropertyGetterSPI

underlyingFragmentCodegen

public CodegenExpression underlyingFragmentCodegen(CodegenExpression underlyingExpression,
 CodegenMethodScope codegenMethodScope,
 CodegenClassScope codegenClassScope)

Specified by:

underlyingFragmentCodegen in interface EventPropertyGetterSPI

getProperty

public String getProperty()