org.jvoicexml.event.plain.implementation

Class SpokenInputEvent

java.lang.Object

java.lang.Throwable

org.jvoicexml.event.JVoiceXMLEvent

org.jvoicexml.event.plain.implementation.SpokenInputEvent

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

InputStartedEvent, NomatchEvent, RecognitionEvent, RecognitionStartedEvent, RecognitionStoppedEvent

public class SpokenInputEvent
extends JVoiceXMLEvent

Event generated from the SpokenInput implementation.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_TYPE The detail message.
static int	INPUT_STARTED The user has started to speak.
static int	RECOGNITION_STARTED The recognition process has been started.
static int	RECOGNITION_STOPPED The recognition process has ended.
static int	RESULT_ACCEPTED The user made an utterance that matched an active grammar.
static int	RESULT_REJECTED The user made an utterance that did not match an active grammar.

Constructor Summary

Constructors

Constructor and Description
SpokenInputEvent(SpokenInput output, java.lang.String id) Constructs a new object.
SpokenInputEvent(SpokenInput output, java.lang.String detailedType, java.lang.String id) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEventType() Get the event type of this event.
java.lang.String	getSessionId() Retrieves the session id.
SpokenInput	getSource() Retrieves the object that caused the event.

Methods inherited from class org.jvoicexml.event.JVoiceXMLEvent

getMessage, isType

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_TYPE

public static final java.lang.String EVENT_TYPE

The detail message.

RECOGNITION_STARTED

public static final int RECOGNITION_STARTED

The recognition process has been started.

See Also:

Constant Field Values

RECOGNITION_STOPPED

public static final int RECOGNITION_STOPPED

The recognition process has ended.

See Also:

Constant Field Values

INPUT_STARTED

public static final int INPUT_STARTED

The user has started to speak.

See Also:

Constant Field Values

RESULT_ACCEPTED

public static final int RESULT_ACCEPTED

The user made an utterance that matched an active grammar.

See Also:

Constant Field Values

RESULT_REJECTED

public static final int RESULT_REJECTED

The user made an utterance that did not match an active grammar.

See Also:

Constant Field Values

Constructor Detail

SpokenInputEvent

public SpokenInputEvent(SpokenInput output,
                        java.lang.String detailedType,
                        java.lang.String id)
                 throws java.lang.IllegalArgumentException

Constructs a new object.

Parameters:

output - object that caused the event.

detailedType - detailed message

id - the session id

Throws:

java.lang.IllegalArgumentException - if an illegal event type is passed.

SpokenInputEvent

public SpokenInputEvent(SpokenInput output,
                        java.lang.String id)
                 throws java.lang.IllegalArgumentException

Constructs a new object.

Parameters:

output - object that caused the event.

id - the session id

Throws:

java.lang.IllegalArgumentException - if an illegal event type is passed.

Method Detail

getSource

public final SpokenInput getSource()

Retrieves the object that caused the event.

Returns:

the source object.

getSessionId

public final java.lang.String getSessionId()

Retrieves the session id.

Returns:

the session id

Since:

0.7.7

getEventType

public java.lang.String getEventType()

Get the event type of this event.

Specified by:

getEventType in class JVoiceXMLEvent

Returns:

Event type.