org.jvoicexml.interpreter.grammar

Class JVoiceXmlGrammarProcessor

java.lang.Object

org.jvoicexml.interpreter.grammar.JVoiceXmlGrammarProcessor

All Implemented Interfaces:

Configurable, GrammarProcessor

public final class JVoiceXmlGrammarProcessor
extends java.lang.Object
implements GrammarProcessor

The GrammarProcessor is the main entry point for grammar processing.
This class provides a lean method interface to process a grammar in a VoiceXML file.

Constructor Summary

Constructors

Constructor and Description
JVoiceXmlGrammarProcessor() Private constructor to prevent manual instantiation.

Method Summary

Modifier and Type	Method and Description
void	init(Configuration configuration) Initializes this component with data from the given configuration object.
GrammarDocument	process(VoiceXmlInterpreterContext context, FetchAttributes attributes, org.jvoicexml.xml.srgs.Grammar grammar, java.util.Locale language) Give in grammar into this processor and let it do it's job.
void	setGrammaridentifier(GrammarIdentifierCentral central) Sets the central to identify grammars.

Methods inherited from class java.lang.Object

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

Constructor Detail

JVoiceXmlGrammarProcessor

public JVoiceXmlGrammarProcessor()

Private constructor to prevent manual instantiation.

Method Detail

init

public void init(Configuration configuration)
          throws ConfigurationException

Initializes this component with data from the given configuration object. This implementation loads the GrammarIdentifiers from the configuration. They can also be added manually by GrammarIdentifierCentral.addIdentifier(GrammarIdentifier) TODO Rewrite the configuration to let the centrals be configured.

Specified by:

init in interface Configurable

Parameters:

configuration - the current configuration, maybe null

Throws:

ConfigurationException - error initializing the component.

setGrammaridentifier

public void setGrammaridentifier(GrammarIdentifierCentral central)

Sets the central to identify grammars.

Parameters:

central - GrammarIdentifierCentral

Since:

0.5

process

public GrammarDocument process(VoiceXmlInterpreterContext context,
                               FetchAttributes attributes,
                               org.jvoicexml.xml.srgs.Grammar grammar,
                               java.util.Locale language)
                        throws NoresourceError,
                               BadFetchError,
                               UnsupportedFormatError,
                               SemanticError

Give in grammar into this processor and let it do it's job.

Ok, to be a more specific, here is a short briefing, what is done to the grammar:

First of all, the grammar node is going to be walked along to check it's attributes and children. If it has a "src" attribut as well as an inline grammar an "error.badfetch" is thrown.

External grammars referenced by the src attribute as well as external rule expansions are going to be fetched. This is done in a loop until all external grammars are loaded.
While fetching all grammars one by one, the type and language is going to be checked.
If a unsupported grammar type is referenced an "UnsupportedFormatError" is thrown.
If a grammar for an unsupported language is fetched "UnsupportedLanguageError" is thrown.

Specified by:

process in interface GrammarProcessor

Parameters:

context - the current context.

attributes - attributes governing the fetch.

grammar - the grammar to process

language - the default xml:lang attribute

Returns:

the transformed grammar

Throws:

NoresourceError - Error accessing the input device.

BadFetchError - If the document could not be fetched successfully.

UnsupportedFormatError - If an unsupported grammar has to be processed.

SemanticError - if there was an error evaluating a scripting expression