net.esper.event
Interface EventAdapterService

All Known Implementing Classes:
EventAdapterServiceImpl

public interface EventAdapterService

Interface for a service to resolve event names to event type.


Method Summary
 EventBean adapterForBean(Object event)
          Wrap the native event returning an EventBean.
 EventBean adapterForDOM(Node node)
          Returns an adapter for the XML DOM document that exposes it's data as event properties for use in statements.
 EventBean adapterForMap(Map event, String eventTypeAlias)
          Wrap the Map-type event returning an EventBean using the event type alias name to identify the EventType that the event should carry.
 EventType addBeanType(String eventTypeAlias, Class clazz)
          Add an event type with the given alias and Java class.
 EventType addBeanType(String eventTypeAlias, String fullyQualClassName)
          Add an event type with the given alias and Java fully-qualified class name.
 EventType addMapType(String eventTypeAlias, Map<String,Class> propertyTypes)
          Add an event type with the given alias and a given set of properties.
 EventType createAddToEventType(EventType originalType, String[] fieldNames, Class[] fieldTypes)
          Create an event type based on the original type passed in adding one or more properties.
 EventType createAnonymousMapType(Map<String,Class> propertyTypes)
          Creates a new anonymous EventType instance for an event type that contains a map of name value pairs.
 EventBean createMapFromUnderlying(Map<String,EventBean> events, EventType eventType)
          Create an aggregate event wrapper bean from a set of named events stored in a Map.
 EventBean createMapFromValues(Map<String,Object> properties, EventType eventType)
          Create an event wrapper bean from a set of event properties (name and value objectes) stored in a Map.
 EventType getEventType(String eventTypeAlias)
          Return the event type for a given event name, or null if none is registered for that name.
 

Method Detail

getEventType

EventType getEventType(String eventTypeAlias)
Return the event type for a given event name, or null if none is registered for that name.

Parameters:
eventTypeAlias - is the event type alias name to return type for
Returns:
event type for named event, or null if unknown/unnamed type

addMapType

EventType addMapType(String eventTypeAlias,
                     Map<String,Class> propertyTypes)
                     throws EventAdapterException
Add an event type with the given alias and a given set of properties.

If the alias already exists with the same event property information, returns the existing EventType instance.

If the alias already exists with different event property information, throws an exception.

If the alias does not already exists, adds the alias and constructs a new MapEventType.

Parameters:
eventTypeAlias - is the alias name for the event type
propertyTypes - is the names and types of event properties
Returns:
event type is the type added
Throws:
EventAdapterException - if alias already exists and doesn't match property type info

createAnonymousMapType

EventType createAnonymousMapType(Map<String,Class> propertyTypes)
Creates a new anonymous EventType instance for an event type that contains a map of name value pairs. The method accepts a Map that contains the property names as keys and Class objects as the values. The Class instances represent the property types.

New instances are created by this method on every invocation. Clients to this method need to cache the returned EventType instance to reuse EventType's for same-typed events.

Parameters:
propertyTypes - is a map of String to Class objects
Returns:
EventType implementation for map field names and value types

createMapFromValues

EventBean createMapFromValues(Map<String,Object> properties,
                              EventType eventType)
Create an event wrapper bean from a set of event properties (name and value objectes) stored in a Map.

Parameters:
properties - is key-value pairs for the event properties
eventType - is the type metadata for any maps of that type
Returns:
EventBean instance

createMapFromUnderlying

EventBean createMapFromUnderlying(Map<String,EventBean> events,
                                  EventType eventType)
Create an aggregate event wrapper bean from a set of named events stored in a Map.

Parameters:
events - is key-value pairs where the key is the event name and the value is the event
eventType - is the type metadata for any maps of that type
Returns:
EventBean instance

addBeanType

EventType addBeanType(String eventTypeAlias,
                      String fullyQualClassName)
                      throws EventAdapterException
Add an event type with the given alias and Java fully-qualified class name.

If the alias already exists with the same class name, returns the existing EventType instance.

If the alias already exists with different class name, throws an exception.

If the alias does not already exists, adds the alias and constructs a new BeanEventType.

Parameters:
eventTypeAlias - is the alias name for the event type
fullyQualClassName - is the fully qualified class name
Returns:
event type is the type added
Throws:
EventAdapterException - if alias already exists and doesn't match class names

addBeanType

EventType addBeanType(String eventTypeAlias,
                      Class clazz)
                      throws EventAdapterException
Add an event type with the given alias and Java class.

If the alias already exists with the same Class, returns the existing EventType instance.

If the alias already exists with different Class name, throws an exception.

If the alias does not already exists, adds the alias and constructs a new BeanEventType.

Parameters:
eventTypeAlias - is the alias name for the event type
clazz - is the fully Java class
Returns:
event type is the type added
Throws:
EventAdapterException - if alias already exists and doesn't match class names

adapterForBean

EventBean adapterForBean(Object event)
Wrap the native event returning an EventBean.

Parameters:
event - to be wrapped
Returns:
event bean wrapping native underlying event

adapterForMap

EventBean adapterForMap(Map event,
                        String eventTypeAlias)
                        throws EventAdapterException
Wrap the Map-type event returning an EventBean using the event type alias name to identify the EventType that the event should carry.

Parameters:
event - to be wrapped
eventTypeAlias - alias for the event type of the event
Returns:
event bean wrapping native underlying event
Throws:
EventAdapterException - if the alias has not been declared, or the event cannot be wrapped using that alias's event type

createAddToEventType

EventType createAddToEventType(EventType originalType,
                               String[] fieldNames,
                               Class[] fieldTypes)
Create an event type based on the original type passed in adding one or more properties.

Parameters:
originalType - - event type to add property to
fieldNames - - names of properties
fieldTypes - - types of properties
Returns:
new event type

adapterForDOM

EventBean adapterForDOM(Node node)
Returns an adapter for the XML DOM document that exposes it's data as event properties for use in statements.

Parameters:
node - is the node to wrap
Returns:
event wrapper for document