com.espertech.esper.event.property

Interface Property

All Known Implementing Classes:

DynamicIndexedProperty, DynamicMappedProperty, DynamicSimpleProperty, IndexedProperty, MappedProperty, NestedProperty, PropertyBase, SimpleProperty

public interface Property

Interface for a property of an event of type BeanEventType (JavaBean event). Properties are designed to handle the different types of properties for such events: indexed, mapped, simple, nested, or a combination of those.

Method Summary

Modifier and Type	Method and Description
EventPropertyGetterSPI	getGetter(BeanEventType eventType, EventAdapterService eventAdapterService) Returns value getter for the property of an event of the given event type.
EventPropertyGetterSPI	getGetterDOM() Returns the getter-method for use with XML DOM event representations.
EventPropertyGetterSPI	getGetterDOM(SchemaElementComplex complexProperty, EventAdapterService eventAdapterService, BaseXMLEventType xmlEventType, java.lang.String propertyExpression) Returns the getter-method for use with XML DOM event representations.
MapEventPropertyGetter	getGetterMap(java.util.Map optionalMapPropTypes, EventAdapterService eventAdapterService) Returns the getter-method for use with Map event representations.
ObjectArrayEventPropertyGetter	getGetterObjectArray(java.util.Map<java.lang.String,java.lang.Integer> indexPerProperty, java.util.Map<java.lang.String,java.lang.Object> nestableTypes, EventAdapterService eventAdapterService)
java.lang.String	getPropertyNameAtomic()
java.lang.Class	getPropertyType(BeanEventType eventType, EventAdapterService eventAdapterService) Returns the property type.
GenericPropertyDesc	getPropertyTypeGeneric(BeanEventType eventType, EventAdapterService eventAdapterService) Returns the property type plus its generic type parameter, if any.
java.lang.Class	getPropertyTypeMap(java.util.Map optionalMapPropTypes, EventAdapterService eventAdapterService) Returns the property type for use with Map event representations.
SchemaItem	getPropertyTypeSchema(SchemaElementComplex complexProperty, EventAdapterService eventAdapterService) Returns the property type for use with DOM event representations.
boolean	isDynamic() Returns true for dynamic properties.
java.lang.String[]	toPropertyArray() Return a String-array of atomic property names.
void	toPropertyEPL(java.io.StringWriter writer) Write the EPL-representation of the property.

Method Detail

getPropertyType

java.lang.Class getPropertyType(BeanEventType eventType,
                                EventAdapterService eventAdapterService)

Returns the property type.

Parameters:

eventType - is the event type representing the JavaBean

eventAdapterService - for event adapters

Returns:

property type class

getPropertyTypeGeneric

GenericPropertyDesc getPropertyTypeGeneric(BeanEventType eventType,
                                           EventAdapterService eventAdapterService)

Returns the property type plus its generic type parameter, if any.

Parameters:

eventType - is the event type representing the JavaBean

eventAdapterService - for event adapters

Returns:

type and generic descriptor

getGetter

EventPropertyGetterSPI getGetter(BeanEventType eventType,
                                 EventAdapterService eventAdapterService)

Returns value getter for the property of an event of the given event type.

Parameters:

eventType - is the type of event to make a getter for

eventAdapterService - factory for event beans and event types

Returns:

fast property value getter for property

getPropertyTypeMap

java.lang.Class getPropertyTypeMap(java.util.Map optionalMapPropTypes,
                                   EventAdapterService eventAdapterService)

Returns the property type for use with Map event representations.

Parameters:

optionalMapPropTypes - a map-within-map type definition, if supplied, or null if not supplied

eventAdapterService - for resolving further map event types that are property types

Returns:

property type @param optionalMapPropTypes

getGetterMap

MapEventPropertyGetter getGetterMap(java.util.Map optionalMapPropTypes,
                                    EventAdapterService eventAdapterService)

Returns the getter-method for use with Map event representations.

Parameters:

optionalMapPropTypes - a map-within-map type definition, if supplied, or null if not supplied

eventAdapterService - for resolving further map event types that are property types

Returns:

getter for maps

getGetterObjectArray

ObjectArrayEventPropertyGetter getGetterObjectArray(java.util.Map<java.lang.String,java.lang.Integer> indexPerProperty,
                                                    java.util.Map<java.lang.String,java.lang.Object> nestableTypes,
                                                    EventAdapterService eventAdapterService)

getPropertyTypeSchema

SchemaItem getPropertyTypeSchema(SchemaElementComplex complexProperty,
                                 EventAdapterService eventAdapterService)

Returns the property type for use with DOM event representations.

Parameters:

complexProperty - a element-within-element type definition

eventAdapterService - for resolving further element event types if defined

Returns:

property type

getGetterDOM

EventPropertyGetterSPI getGetterDOM(SchemaElementComplex complexProperty,
                                    EventAdapterService eventAdapterService,
                                    BaseXMLEventType xmlEventType,
                                    java.lang.String propertyExpression)

Returns the getter-method for use with XML DOM event representations.

Parameters:

complexProperty - a element-within-element type definition

eventAdapterService - for resolving or creating further event types that are property types

xmlEventType - the event type

propertyExpression - the full property expression

Returns:

getter

getGetterDOM

EventPropertyGetterSPI getGetterDOM()

Returns the getter-method for use with XML DOM event representations.

Returns:

getter

toPropertyEPL

void toPropertyEPL(java.io.StringWriter writer)

Write the EPL-representation of the property.

Parameters:

writer - to write to

toPropertyArray

java.lang.String[] toPropertyArray()

Return a String-array of atomic property names.

Returns:

array of atomic names in a property expression

isDynamic

boolean isDynamic()

Returns true for dynamic properties.

Returns:

false for not-dynamic properties, true for dynamic properties.

getPropertyNameAtomic

java.lang.String getPropertyNameAtomic()