org.jvoicexml.implementation

Interface GrammarImplementation<T>

Type Parameters:

T - the grammar implementation.

All Known Implementing Classes:

DocumentGrammarImplementation, NuanceDynagramBinaryGrammarImplementation, SrgsXmlGrammarImplementation

public interface GrammarImplementation<T>

Implementation of a grammar that is accessed by the VoiceXML interpreter and passed to the ImplementationPlatform if the grammar is activated or deactivated.

VoiceXML is designed to support at least

• JSGF
• SRGS grammar with ABNF format
• SRGS grammar with XML format

Custom implementations must implement this interface to hook their own grammar specification.

Since:

0.5.5

Method Summary

Modifier and Type	Method and Description
boolean	equals(GrammarImplementation<T> other) Checks if this grammar implementation is equal to the given grammar implementation.
T	getGrammarDocument() Retrieves the grammar document.
org.jvoicexml.xml.srgs.GrammarType	getMediaType() Returns the declared media type of the external grammar.
org.jvoicexml.xml.srgs.ModeType	getModeType() Returns the mode type of the grammar.
java.net.URI	getURI() Retrieves the URI of the grammar.

Method Detail

getMediaType

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

Returns the declared media type of the external grammar.

Returns:

The media type of the grammar file.

getModeType

org.jvoicexml.xml.srgs.ModeType getModeType()

Returns the mode type of the grammar.

Returns:

mode type of the grammar.

Since:

0.7

getGrammarDocument

T getGrammarDocument()

Retrieves the grammar document.

Returns:

the grammar.

getURI

java.net.URI getURI()

Retrieves the URI of the grammar.

Returns:

URI of the grammar document.

Since:

0.7.5

equals

boolean equals(GrammarImplementation<T> other)

Checks if this grammar implementation is equal to the given grammar implementation.

Parameters:

other - the grammar implementation to compare with.

Returns:

true if the grammar implementations are equal.

Since:

0.7.2