org.jvoicexml.interpreter

Class VoiceXmlInterpreter

java.lang.Object

org.jvoicexml.interpreter.VoiceXmlInterpreter

public final class VoiceXmlInterpreter
extends java.lang.Object

VoiceXML interpreter that process VoiceXML documents retrieved from a document server.

Constructor Summary

Constructors

Constructor and Description
VoiceXmlInterpreter(VoiceXmlInterpreterContext ctx) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	enterFinalProcessingState() Under certain circumstances (in particular, while the VoiceXML interpreter is processing a disconnect event) the interpreter may continue executing in the final processing state after there is no longer a connection to allow the interpreter to interact with the end user.
Dialog	getDialog(java.lang.String id) Retrieves the dialog with the given id.
FormInterpretationAlgorithm	getFormInterpretationAlgorithm() Retrieves the current FIA.
java.util.Locale	getLanguage() Retrieves the language of the current VoiceXML document.
Dialog	getNextDialog() Retrieves the next dialog to process.
InterpreterState	getState() Retrieves the interpreter state.
boolean	isInFinalProcessingState() Checks, if the interpreter is in the final processing state.
void	process(Dialog dialog, java.util.Map<java.lang.String,java.lang.Object> parameters) Process the given dialog.
void	setState(InterpreterState newState) Sets the interpreter state.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoiceXmlInterpreter

public VoiceXmlInterpreter(VoiceXmlInterpreterContext ctx)

Constructs a new object.

Parameters:

ctx - The VoiceXML interpreter context.

Method Detail

getFormInterpretationAlgorithm

public FormInterpretationAlgorithm getFormInterpretationAlgorithm()

Retrieves the current FIA.

Returns:

the FIA while the interpreter is processing, null otherwise.

Since:

0.7

getState

public InterpreterState getState()

Retrieves the interpreter state.

Returns:

the interpreter state.

Since:

0.6

setState

public void setState(InterpreterState newState)

Sets the interpreter state.

Parameters:

newState - the new interpreter state.

Since:

0.6

getNextDialog

public Dialog getNextDialog()

Retrieves the next dialog to process.

Returns:

next dialog to be processed, null if there is no next dialog to process.

getDialog

public Dialog getDialog(java.lang.String id)

Retrieves the dialog with the given id.

Parameters:

id - Id of the form to find.

Returns:

form with the given id, null if there is no dialog with that id.

Since:

0.3

process

public void process(Dialog dialog,
                    java.util.Map<java.lang.String,java.lang.Object> parameters)
             throws JVoiceXMLEvent

Process the given dialog.

Parameters:

dialog - the dialog to be processed.

parameters - passed parameters when executing this dialog

Throws:

JVoiceXMLEvent - Error or event processing the dialog.

enterFinalProcessingState

public void enterFinalProcessingState()

Under certain circumstances (in particular, while the VoiceXML interpreter is processing a disconnect event) the interpreter may continue executing in the final processing state after there is no longer a connection to allow the interpreter to interact with the end user. The purpose of this state is to allow the VoiceXML application to perform any necessary final cleanup, such as submitting information to the application server.

isInFinalProcessingState

public boolean isInFinalProcessingState()

Checks, if the interpreter is in the final processing state.

Returns:

true if the interpreter is in the final processing state.

getLanguage

public java.util.Locale getLanguage()

Retrieves the language of the current VoiceXML document.

If the language is not set, the system's default locale is used by calling Locale.getDefault().

Returns:

language of the VoiceXML document, null if there is no document.

Since:

0.7.3