org.jvoicexml.interpreter.event

Class JVoiceXmlEventHandler

java.lang.Object

org.jvoicexml.interpreter.event.JVoiceXmlEventHandler

All Implemented Interfaces:

EventSubscriber, EventHandler

public final class JVoiceXmlEventHandler
extends java.lang.Object
implements EventHandler

Event handler to catch events generated from the ImplementationPlatform via the EventBus. This event handler can catch only one event at a time. The first event is propagated to the the FIA while subsequent events will be ignored.

See Also:

ImplementationPlatform

Constructor Summary

Constructors

Constructor and Description
JVoiceXmlEventHandler(DataModel dataModel, ScopeObserver observer) Construct a new object.

Method Summary

Modifier and Type	Method and Description
boolean	addStrategy(EventStrategy strategy) Adds a strategy for the given event type.
void	clean(FormItem item) Removes all event handlers that were collected for the given form item.
void	clearEvent() Removes all cached events that have been received.
void	collect(VoiceXmlInterpreterContext context, VoiceXmlInterpreter interpreter, Dialog dialog) Adds all event handlers defined in the given dialog.
java.util.Collection<EventStrategy>	collect(VoiceXmlInterpreterContext context, VoiceXmlInterpreter interpreter, FormInterpretationAlgorithm fia, CatchContainer item) Adds all event handlers defined in the given input item.
void	collect(VoiceXmlInterpreterContext context, VoiceXmlInterpreter interpreter, org.jvoicexml.xml.vxml.VoiceXmlDocument document) Adds all event handlers defined in the given document.
JVoiceXMLEvent	getEvent() Retrieves the event.
void	onEvent(JVoiceXMLEvent e) Notification about the given event.
void	processEvent(CatchContainer item) Processes the last received event.
boolean	removeStrategies(java.util.Collection<EventStrategy> strats) Removes the given strategies.
JVoiceXMLEvent	waitEvent() Waits until an event was generated in the implementation platform.

Methods inherited from class java.lang.Object

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

Constructor Detail

JVoiceXmlEventHandler

public JVoiceXmlEventHandler(DataModel dataModel,
                             ScopeObserver observer)

Construct a new object.

Parameters:

dataModel - the emplyoed data model

observer - the scope observer.

Method Detail

collect

public void collect(VoiceXmlInterpreterContext context,
                    VoiceXmlInterpreter interpreter,
                    org.jvoicexml.xml.vxml.VoiceXmlDocument document)

Adds all event handlers defined in the given document.

Specified by:

collect in interface EventHandler

Parameters:

context - the current VoiceXmlInterpreterContext

interpreter - the current VoiceXmlInterpreter

document - the document to inspect.

collect

public void collect(VoiceXmlInterpreterContext context,
                    VoiceXmlInterpreter interpreter,
                    Dialog dialog)

Adds all event handlers defined in the given dialog.

Specified by:

collect in interface EventHandler

Parameters:

context - the current VoiceXmlInterpreterContext

interpreter - the current VoiceXmlInterpreter

dialog - the dialog to inspect.

collect

public java.util.Collection<EventStrategy> collect(VoiceXmlInterpreterContext context,
                                                   VoiceXmlInterpreter interpreter,
                                                   FormInterpretationAlgorithm fia,
                                                   CatchContainer item)

Adds all event handlers defined in the given input item.

Specified by:

collect in interface EventHandler

Parameters:

context - the current VoiceXmlInterpreterContext

interpreter - the current VoiceXmlInterpreter

fia - the current FIA.

item - the form item to inspect.

Returns:

added event handlers

addStrategy

public boolean addStrategy(EventStrategy strategy)

Adds a strategy for the given event type.

Specified by:

addStrategy in interface EventHandler

Parameters:

strategy - the strategy to add.

Returns:

true if the strategy was added.

clean

public void clean(FormItem item)

Removes all event handlers that were collected for the given form item.

Specified by:

clean in interface EventHandler

Parameters:

item - the form item

waitEvent

public JVoiceXMLEvent waitEvent()

Waits until an event was generated in the implementation platform.

Specified by:

waitEvent in interface EventHandler

Returns:

the caught event.

processEvent

public void processEvent(CatchContainer item)
                  throws JVoiceXMLEvent

Processes the last received event. The relevant EventStrategy is determined via a chaining of EventFilters.

Specified by:

processEvent in interface EventHandler

Parameters:

item - The current form item.

Throws:

JVoiceXMLEvent - Error or event processing the event or there was no handler to process the current event

clearEvent

public void clearEvent()

Removes all cached events that have been received.

Specified by:

clearEvent in interface EventHandler

onEvent

public void onEvent(JVoiceXMLEvent e)

Notification about the given event. Receive the event from the EventBus and handle form interpretation.

Specified by:

onEvent in interface EventSubscriber

Parameters:

e - the event

getEvent

public JVoiceXMLEvent getEvent()

Retrieves the event.

Specified by:

getEvent in interface EventHandler

Returns:

the caught event.

removeStrategies

public boolean removeStrategies(java.util.Collection<EventStrategy> strats)

Removes the given strategies.

Specified by:

removeStrategies in interface EventHandler

Parameters:

strats - strategies to remove

Returns:

true if at least one strategy was removed