VoiceXmlInterpreterContext (org.jvoicexml 0.7.8 API)

java.lang.Object
- org.jvoicexml.interpreter.VoiceXmlInterpreterContext

```
public class VoiceXmlInterpreterContext
extends java.lang.Object
```
Component that uses a VoiceXmlInterpreter to interpret a VoiceXmlDocument and that may also interact with the ImplementationPlatform independent of the VoiceXmlInterpreter.

Constructor Summary

Constructors
Constructor and Description
`VoiceXmlInterpreterContext(JVoiceXmlSession currentSession, Configuration config)` Creates a new object.
`VoiceXmlInterpreterContext(JVoiceXmlSession currentSession, Configuration config, ScopeObserver observer)` Creates a new object in the context of the observing entity specified by the observer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GrammarDocument`	`acquireExternalGrammar(java.net.URI uri, FetchAttributes attributes)` Acquire the VoiceXML document with the given URI.
`org.jvoicexml.xml.vxml.VoiceXmlDocument`	`acquireVoiceXmlDocument(DocumentDescriptor descriptor)` Acquires the VoiceXML document with the given URI.
`void`	`close()` Closes all open resources.
`void`	`enterScope(Scope scope)` Enter a new scope for resolving variables. this is useful if we enter a new block, but at least every file should have it's own scope.
`void`	`exitScope(Scope scope)` Return from a previously created scope. i.e. pop current scope from stack.
`ActiveGrammarSet`	`getActiveGrammarSet()` Retrieves the active grammar set.
`Application`	`getApplication()` Retrieves the application.
`CallControlProperties`	`getCallControlProperties(FormInterpretationAlgorithm fia)` Loads the speech recognizer properties.
`Configuration`	`getConfiguration()` Retrieves the configuration.
`DataModel`	`getDataModel()` Lazy instantiation of the data model.
`DocumentServer`	`getDocumentServer()` Retrieves a reference to the document server.
`DtmfRecognizerProperties`	`getDtmfRecognizerProperties(FormInterpretationAlgorithm fia)` Loads the DTMF recognizer properties.
`EventBus`	`getEventBus()` Retrieves the event bus.
`EventHandler`	`getEventHandler()` Retrieves the event handler to use in this context.
`GrammarProcessor`	`getGrammarProcessor()` Retrieves a reference to the grammar processor.
`ImplementationPlatform`	`getImplementationPlatform()` Retrieves a reference to the used implementation platform.
`Profile`	`getProfile()` Retrieves the active profile.
`java.lang.String`	`getProperty(java.lang.String name)` Retrieves the value of the given property.
`java.lang.String`	`getProperty(java.lang.String name, java.lang.String defValue)` Retrieves the value of the given property.
`ScopeObserver`	`getScopeObserver()` Retrieves the scope observer for this session.
`Session`	`getSession()` Retrieves the current session.
`SpeechRecognizerProperties`	`getSpeechRecognizerProperties(FormInterpretationAlgorithm fia)` Loads the speech recognizer properties.
`org.jvoicexml.xml.vxml.VoiceXmlDocument`	`loadDocument(DocumentDescriptor descriptor)` Loads the document of the descriptor with the associated attributes and adds it to the list of loaded documents.
`void`	`process(Application appl)` Starts processing the given application.
`void`	`processSubdialog(Application appl, DocumentDescriptor desc, java.util.Map<java.lang.String,java.lang.Object> parameters)` Starts processing the given application.
`void`	`setApplication(Application value)` Sets the current application.
`void`	`setProperty(java.lang.String name, java.lang.String value)` Sets the property with the given name to the given value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VoiceXmlInterpreterContext
```
public VoiceXmlInterpreterContext(JVoiceXmlSession currentSession,
                                  Configuration config)
```
    Creates a new object.
    
    Parameters:
    
    currentSession - the current session
    
    config - the configuration to use.
  - VoiceXmlInterpreterContext
```
public VoiceXmlInterpreterContext(JVoiceXmlSession currentSession,
                                  Configuration config,
                                  ScopeObserver observer)
```
    Creates a new object in the context of the observing entity specified by the observer. Usually, this is needed to model subdialogs.
    
    Parameters:
    
    currentSession - the current session
    
    config - the configuration to use
    
    observer - the scope observer
- Method Detail
  - getSession
```
public Session getSession()
```
    Retrieves the current session.
    
    Returns:
    
    the current session.
    
    Since:
    
    0.7
  - getProfile
```
public Profile getProfile()
```
    Retrieves the active profile.
    
    Returns:
    
    the profile
    
    Since:
    
    0.7.7
  - getScopeObserver
```
public ScopeObserver getScopeObserver()
```
    Retrieves the scope observer for this session.
    
    Returns:
    
    The scope observer.
  - getImplementationPlatform
```
public ImplementationPlatform getImplementationPlatform()
```
    Retrieves a reference to the used implementation platform.
    
    Returns:
    
    The used implementation platform.
  - getGrammarProcessor
```
public GrammarProcessor getGrammarProcessor()
```
    Retrieves a reference to the grammar processor.
    
    Returns:
    
    The grammar processor.
    
    Since:
    
    0.3
  - getConfiguration
```
public Configuration getConfiguration()
```
    Retrieves the configuration.
    
    Returns:
    
    the configuration
    
    Since:
    
    0.7.4
  - getDataModel
```
public DataModel getDataModel()
```
    Lazy instantiation of the data model.
    
    Returns:
    
    the data model.
    
    Since:
    
    0.7.7
  - getEventBus
```
public EventBus getEventBus()
```
    Retrieves the event bus.
    
    Returns:
    
    the event bus
    
    Since:
    
    0.7.7
  - getEventHandler
```
public EventHandler getEventHandler()
```
    Retrieves the event handler to use in this context.
    
    Returns:
    
    the event handler.
    
    Since:
    
    0.7
  - enterScope
```
public void enterScope(Scope scope)
```
    Enter a new scope for resolving variables. this is useful if we enter a new block, but at least every file should have it's own scope.
    
    Parameters:
    
    scope - the new scope.
  - exitScope
```
public void exitScope(Scope scope)
```
    Return from a previously created scope. i.e. pop current scope from stack.
    
    Parameters:
    
    scope - The scope which was left.
  - close
```
public void close()
```
    Closes all open resources.
  - getActiveGrammarSet
```
public ActiveGrammarSet getActiveGrammarSet()
```
    Retrieves the active grammar set.
    
    Returns:
    
    the active grammar set.
  - setProperty
```
public void setProperty(java.lang.String name,
                        java.lang.String value)
```
    Sets the property with the given name to the given value.
    
    Parameters:
    
    name - Name of the property.
    
    value - Value of the property.
  - getProperty
```
public java.lang.String getProperty(java.lang.String name)
```
    Retrieves the value of the given property.
    
    Parameters:
    
    name - Name of the property.
    
    Returns:
    
    Value of the property.
  - getProperty
```
public java.lang.String getProperty(java.lang.String name,
                                    java.lang.String defValue)
```
    Retrieves the value of the given property.
    
    Parameters:
    
    name - name of the property.
    
    defValue - the default value, if the property is not defined.
    
    Returns:
    
    value of the property or default value if no property is defined
    
    Since:
    
    0.7.4
  - getSpeechRecognizerProperties
```
public SpeechRecognizerProperties getSpeechRecognizerProperties(FormInterpretationAlgorithm fia)
                                                         throws ConfigurationException
```
    Loads the speech recognizer properties. The values from the configuration are replaced by property settings if any.
    
    Parameters:
    
    fia - the current form interpretation algorithm, maybe null.
    
    Returns:
    
    the speech recognizer properties
    
    Throws:
    
    ConfigurationException - if the object could not be loaded.
    
    Since:
    
    0.7.5
  - getDtmfRecognizerProperties
```
public DtmfRecognizerProperties getDtmfRecognizerProperties(FormInterpretationAlgorithm fia)
                                                     throws ConfigurationException
```
    Loads the DTMF recognizer properties. The values from the configuration are replaced by property settings if any.
    
    Parameters:
    
    fia - the current form interpretation algorithm, maybe null.
    
    Returns:
    
    the DTMF recognizer properties
    
    Throws:
    
    ConfigurationException - if the object could not be loaded.
    
    Since:
    
    0.7.5
  - getCallControlProperties
```
public CallControlProperties getCallControlProperties(FormInterpretationAlgorithm fia)
                                               throws ConfigurationException
```
    Loads the speech recognizer properties. The values from the configuration are replaced by property settings if any.
    
    Parameters:
    
    fia - the current form interpretation algorithm, maybe null.
    
    Returns:
    
    the speech recognizer properties
    
    Throws:
    
    ConfigurationException - if the object could not be loaded.
    
    Since:
    
    0.7.5
  - setApplication
```
public void setApplication(Application value)
```
    Sets the current application.
    
    Parameters:
    
    value - the new application
    
    Since:
    
    0.7.7
  - getApplication
```
public Application getApplication()
```
    Retrieves the application.
    
    Returns:
    
    the application.
  - process
```
public void process(Application appl)
             throws ErrorEvent
```
    Starts processing the given application.
    
    Parameters:
    
    appl - The application to process.
    
    Throws:
    
    ErrorEvent - Error processing the document.
  - processSubdialog
```
public void processSubdialog(Application appl,
                             DocumentDescriptor desc,
                             java.util.Map<java.lang.String,java.lang.Object> parameters)
                      throws JVoiceXMLEvent
```
    Starts processing the given application.
    
    Parameters:
    
    appl - the application to process.
    
    desc - the document descriptor for the subdialog
    
    parameters - passed parameters when executing this dialog
    
    Throws:
    
    JVoiceXMLEvent - Error processing the document.
  - loadDocument
```
public org.jvoicexml.xml.vxml.VoiceXmlDocument loadDocument(DocumentDescriptor descriptor)
                                                     throws BadFetchError
```
    Loads the document of the descriptor with the associated attributes and adds it to the list of loaded documents.
    If an application is active, the descriptor is also modified to contain the resolved URI.
    
    Parameters:
    
    descriptor - descriptor of the next document to process.
    
    Returns:
    
    VoiceXML document with the given URI
    
    Throws:
    
    BadFetchError - Error retrieving the document.
    
    Since:
    
    0.7
  - getDocumentServer
```
public DocumentServer getDocumentServer()
```
    Retrieves a reference to the document server.
    
    Returns:
    
    Reference to the document server.
  - acquireVoiceXmlDocument
```
public org.jvoicexml.xml.vxml.VoiceXmlDocument acquireVoiceXmlDocument(DocumentDescriptor descriptor)
                                                                throws BadFetchError
```
    Acquires the VoiceXML document with the given URI.
    If a relative URI is given, the scheme and authority of the last document are used to create a hierarchical URI for the next document.
    
    Parameters:
    
    descriptor - descriptor of the next document to process.
    
    Returns:
    
    VoiceXML document with the given URI
    
    Throws:
    
    BadFetchError - Error retrieving the document.
  - acquireExternalGrammar
```
public GrammarDocument acquireExternalGrammar(java.net.URI uri,
                                              FetchAttributes attributes)
                                       throws BadFetchError
```
    Acquire the VoiceXML document with the given URI.
    If a relative URI is given, the scheme and authority of the last document are used to create a hierarchical URI for the next document.
    
    Parameters:
    
    uri - URI of the next document to process.
    
    attributes - attributes governing the fetch.
    
    Returns:
    
    Grammar document with the given URI.
    
    Throws:
    
    BadFetchError - Error retrieving the document.
    
    Since:
    
    0.3

Class VoiceXmlInterpreterContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VoiceXmlInterpreterContext

VoiceXmlInterpreterContext

Method Detail

getSession

getProfile

getScopeObserver

getImplementationPlatform

getGrammarProcessor

getConfiguration

getDataModel

getEventBus

getEventHandler

enterScope

exitScope

close

getActiveGrammarSet

setProperty

getProperty

getProperty

getSpeechRecognizerProperties

getDtmfRecognizerProperties

getCallControlProperties

setApplication

getApplication

process

processSubdialog

loadDocument

getDocumentServer

acquireVoiceXmlDocument

acquireExternalGrammar