org.jvoicexml.interpreter

Interface EventCountable

All Known Subinterfaces:

GrammarContainer, InputItem

All Known Implementing Classes:

FieldFormItem, InitialFormItem, ObjectFormItem, RecordFormItem, SubdialogFormItem, TransferFormItem

public interface EventCountable

Counter to allow counting of different occurrences of the same event.

Each <form>, <menu>, and form item maintains a counter for each event that occurs while it is being visited. Item-level event counters are used for events thrown while visiting individual form items and while executing <filled> elements contained within those items. Form-level and menu-level counters are used for events thrown during dialog initialization and while executing form-level <filled> elements.

Form-level and menu-level event counters are reset each time the <menu> or <form> is re-entered. Form-level and menu-level event counters are not reset by the <clear> element.

Item-level event counters are reset each time the <form> containing the item is re-entered. Item-level event counters are also reset when the item is reset with the <clear> element. An item's event counters are not reset when the item is re-entered without leaving the <form>.

Counters are incremented against the full event name and every prefix matching event name; for example, occurrence of the event event.foo.1 increments the counters for event.foo.1 plus event.foo and event.

Since:

0.6

See Also:

FieldFormItem, ObjectFormItem, RecordFormItem, SubdialogFormItem, TransferFormItem

Method Summary

Modifier and Type	Method and Description
int	getEventCount(java.lang.String type) Retrieve the counter for the given event type.
void	incrementEventCounter(JVoiceXMLEvent event) Increment counters for all events that have the same name as the given event or have a name that is a prefix of the given event.
void	resetEventCounter() Reset the counter for all events.

Method Detail

incrementEventCounter

void incrementEventCounter(JVoiceXMLEvent event)

Increment counters for all events that have the same name as the given event or have a name that is a prefix of the given event.

Parameters:

event - Event to increment.

getEventCount

int getEventCount(java.lang.String type)

Retrieve the counter for the given event type.

Parameters:

type - Event type.

Returns:

Count for the given event type.

resetEventCounter

void resetEventCounter()

Reset the counter for all events.