org.jvoicexml.implementation.grammar

Interface GrammarParser<T>

Type Parameters:

T - grammar implementation

public interface GrammarParser<T>

A grammar processor is able to parse any GrammarDocument into something that can be evaluated later to retrieve semantic interpretation from a given utterance .

Since:

0.7.8

Method Summary

Modifier and Type	Method and Description
org.jvoicexml.xml.srgs.GrammarType	getType() Retrieves the grammar type that this parser will process.
GrammarImplementation<T>	load(java.net.URI uri) Loads a grammar by its URI.
GrammarEvaluator	parse(GrammarDocument document) Parses a given GrammarDocument into a GrammarEvaluator.

Method Detail

getType

org.jvoicexml.xml.srgs.GrammarType getType()

Retrieves the grammar type that this parser will process.

Returns:

the grammar type

load

GrammarImplementation<T> load(java.net.URI uri)
                       throws java.io.IOException

Loads a grammar by its URI.

Parameters:

uri - the URI to load the grammar from

Returns:

grammar implementation

Throws:

java.io.IOException - error loading the grammar

parse

GrammarEvaluator parse(GrammarDocument document)
                throws java.io.IOException,
                       UnsupportedFormatError

Parses a given GrammarDocument into a GrammarEvaluator. This also means that there is a 1:1 relationship between grammars and their evaluators.

Parameters:

document - the document to process.

Returns:

grammar evaluator

Throws:

java.io.IOException - error reading the grammar

UnsupportedFormatError - the grammar format is not supported