org.jvoicexml.interpreter

Class JVoiceXmlApplication

java.lang.Object

org.jvoicexml.interpreter.JVoiceXmlApplication

All Implemented Interfaces:

Application

public final class JVoiceXmlApplication
extends java.lang.Object
implements Application

Implementation of the Application.

Since:

0.5.5

See Also:

Application

Constructor Summary

Constructors

Constructor and Description
JVoiceXmlApplication() Constructs a new object.
JVoiceXmlApplication(ScopeObserver scopeObserver) Creates a new object.

Method Summary

Modifier and Type	Method and Description
void	addDocument(java.net.URI uri, org.jvoicexml.xml.vxml.VoiceXmlDocument doc) Adds the given document to the application.
java.net.URI	getApplication() Retrieves the URI of the application.
org.jvoicexml.xml.vxml.VoiceXmlDocument	getCurrentDocument() Retrieves the current document.
java.util.List<LastResult>	getLastResult() Retrieves information about the last recognition to occur within this application.
java.net.URI	getXmlBase() Retrieves the base URI.
boolean	isLoaded(java.net.URI uri) Checks, if the document with the given uri is loaded.
java.net.URI	resolve(java.net.URI uri) Converts the given URI into a hierarchical URI.
java.net.URI	resolve(java.net.URI base, java.net.URI uri) Converts the given URI into a hierarchical URI.
void	setLastResult(java.util.List<LastResult> result) Sets the last result.
void	setRootDocument(org.jvoicexml.xml.vxml.VoiceXmlDocument document) Sets the new root document.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JVoiceXmlApplication

public JVoiceXmlApplication()

Constructs a new object.

JVoiceXmlApplication

public JVoiceXmlApplication(ScopeObserver scopeObserver)

Creates a new object.

Parameters:

scopeObserver - the scope observer.

Method Detail

addDocument

public void addDocument(java.net.URI uri,
                        org.jvoicexml.xml.vxml.VoiceXmlDocument doc)
                 throws BadFetchError

Adds the given document to the application.

Specified by:

addDocument in interface Application

Parameters:

uri - the URI of the document.

doc - the document to add.

Throws:

BadFetchError - error in the document.

setRootDocument

public void setRootDocument(org.jvoicexml.xml.vxml.VoiceXmlDocument document)
                     throws BadFetchError

Sets the new root document.

Specified by:

setRootDocument in interface Application

Parameters:

document - the new root document.

Throws:

BadFetchError - error in the document.

getApplication

public java.net.URI getApplication()

Retrieves the URI of the application.

Specified by:

getApplication in interface Application

Returns:

URI of the application.

getXmlBase

public java.net.URI getXmlBase()

Retrieves the base URI.

Specified by:

getXmlBase in interface Application

Returns:

the base URI.

getCurrentDocument

public org.jvoicexml.xml.vxml.VoiceXmlDocument getCurrentDocument()

Retrieves the current document.

Specified by:

getCurrentDocument in interface Application

Returns:

the current document.

resolve

public java.net.URI resolve(java.net.URI uri)

Converts the given URI into a hierarchical URI. If the given URI is a relative URI, it is expanded using the application URI.

Specified by:

resolve in interface Application

Parameters:

uri - the URI to resolve.

Returns:

Hierarchical URI.

resolve

public java.net.URI resolve(java.net.URI base,
                            java.net.URI uri)

Converts the given URI into a hierarchical URI. If the given URI is a relative URI, it is expanded using the baseUri.

Specified by:

resolve in interface Application

Parameters:

base - the base URI.

uri - the URI to resolve.

Returns:

Hierarchical URI.

isLoaded

public boolean isLoaded(java.net.URI uri)

Checks, if the document with the given uri is loaded.

Specified by:

isLoaded in interface Application

Parameters:

uri - the URI to check.

Returns:

true if the document is loaded.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setLastResult

public void setLastResult(java.util.List<LastResult> result)

Sets the last result.

Specified by:

setLastResult in interface Application

Parameters:

result - the last result to set.

getLastResult

public java.util.List<LastResult> getLastResult()

Retrieves information about the last recognition to occur within this application. It is an array of elements where each element, represents a possible result.

Specified by:

getLastResult in interface Application

Returns:

last recognition result information, maybe null.