com.espertech.esper.client
Interface EPRuntimeIsolated

All Known Subinterfaces:

EPRuntimeIsolatedSPI

All Known Implementing Classes:

EPRuntimeIsolatedImpl

public interface EPRuntimeIsolated

Runtime interface for the isolated service provider, for controlling event visibility and scheduling for the statements contained within the isolated service.

Method Summary

long	getCurrentTime() Returns current engine time.
EventSender	getEventSender(java.lang.String eventTypeName) Returns a facility to process event objects that are of a known type.
EventSender	getEventSender(java.net.URI[] uris) For use with plug-in event representations, returns a facility to process event objects that are of one of a number of types that one or more of the registered plug-in event representation extensions can reflect upon and provide an event for.
java.lang.Long	getNextScheduledTime() Returns the time at which the next schedule execution is expected, returns null if no schedule execution is outstanding.
void	sendEvent(java.util.Map map, java.lang.String eventTypeName) Send a map containing event property values to the event stream processing runtime.
void	sendEvent(org.w3c.dom.Node node) Send an event represented by a DOM node to the event stream processing runtime.
void	sendEvent(java.lang.Object object) Send an event represented by a plain Java object to the event stream processing runtime.
void	sendEvent(java.lang.Object[] objectarray, java.lang.String objectArrayEventTypeName) Send an object array containing event property values to the event stream processing runtime.

Method Detail

sendEvent

void sendEvent(java.lang.Object object)
               throws EPException

Send an event represented by a plain Java object to the event stream processing runtime.

Use the route method for sending events into the runtime from within UpdateListener code, to avoid the possibility of a stack overflow due to nested calls to sendEvent.

Parameters:

object - is the event to sent to the runtime

Throws:

EPException - is thrown when the processing of the event lead to an error

sendEvent

void sendEvent(java.util.Map map,
               java.lang.String eventTypeName)
               throws EPException

Send a map containing event property values to the event stream processing runtime.

Use the route method for sending events into the runtime from within UpdateListener code. to avoid the possibility of a stack overflow due to nested calls to sendEvent.

Parameters:

map - - map that contains event property values. Keys are expected to be of type String while values can be of any type. Keys and values should match those declared via Configuration for the given eventTypeName.

eventTypeName - - the name for the Map event type that was previously configured

Throws:

EPException - - when the processing of the event leads to an error

sendEvent

void sendEvent(java.lang.Object[] objectarray,
               java.lang.String objectArrayEventTypeName)

Send an object array containing event property values to the event stream processing runtime.

Use the route method for sending events into the runtime from within UpdateListener code. to avoid the possibility of a stack overflow due to nested calls to sendEvent.

Parameters:

objectarray - - array that contains event property values. Your application must ensure that property values match the exact same order that the property names and types have been declared, and that the array length matches the number of properties declared.

objectArrayEventTypeName - - the name for the Object-array event type that was previously configured

Throws:

EPException - - when the processing of the event leads to an error

sendEvent

void sendEvent(org.w3c.dom.Node node)
               throws EPException

Send an event represented by a DOM node to the event stream processing runtime.

Use the route method for sending events into the runtime from within UpdateListener code. to avoid the possibility of a stack overflow due to nested calls to sendEvent.

Parameters:

node - is the DOM node as an event

Throws:

EPException - is thrown when the processing of the event lead to an error

getCurrentTime

long getCurrentTime()

Returns current engine time.

If time is provided externally via timer events, the function returns current time as externally provided.

Returns:

current engine time

getNextScheduledTime

java.lang.Long getNextScheduledTime()

Returns the time at which the next schedule execution is expected, returns null if no schedule execution is outstanding.

Returns:

time of next schedule if any

getEventSender

EventSender getEventSender(java.lang.String eventTypeName)
                           throws EventTypeException

Returns a facility to process event objects that are of a known type.

Given an event type name this method returns a sender that allows to send in event objects of that type. The event objects send in via the event sender are expected to match the event type, thus the event sender does not inspect the event object other then perform basic checking.

For events backed by a Java class (JavaBean events), the sender ensures that the object send in matches in class, or implements or extends the class underlying the event type for the given event type name.

For events backed by a Object[] (Object-array events), the sender does not perform any checking other then checking that the event object indeed is an array of object.

For events backed by a java.util.Map (Map events), the sender does not perform any checking other then checking that the event object indeed implements Map.

For events backed by a org.w3c.Node (XML DOM events), the sender checks that the root element name indeed does match the root element name for the event type name.

Parameters:

eventTypeName - is the name of the event type

Returns:

sender for fast-access processing of event objects of known type (and content)

Throws:

EventTypeException - thrown to indicate that the name does not exist

getEventSender

EventSender getEventSender(java.net.URI[] uris)
                           throws EventTypeException

For use with plug-in event representations, returns a facility to process event objects that are of one of a number of types that one or more of the registered plug-in event representation extensions can reflect upon and provide an event for.

Parameters:

uris - is the URIs that specify which plug-in event representations may process an event object.

URIs do not need to match event representation URIs exactly, a child (hierarchical) match is enough for an event representation to participate.

The order of URIs is relevant as each event representation's factory is asked in turn to process the event, until the first factory processes the event.

Returns:

sender for processing of event objects of one of the plug-in event representations

Throws:

EventTypeException - thrown to indicate that the URI list was invalid