org.jvoicexml

Interface GrammarDocument

All Known Implementing Classes:

ExternalGrammarDocument, ExternalReferenceGrammarDocument, InternalGrammarDocument

public interface GrammarDocument

Grammar document that is retrieved from the DocumentServer.

VoiceXML is designed to support at least

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

Usually grammar documents will be text based, but also precompiled binary grammars are supported. This can be checked by isAscii(). The contents of text based grammars can be retrieved by getDocument(). The byte buffer of binary grammar documents can be retrieved by getBuffer().

Since:

0.5.5

Method Summary

Modifier and Type	Method and Description
boolean	equals(GrammarDocument other) Checks if this grammar document is equal to the given grammar document.
byte[]	getBuffer() Retrieves the document's byte array.
java.lang.String	getDocument() Retrieves the document as a string.
org.jvoicexml.xml.srgs.GrammarType	getMediaType() Returns the declared media type of the grammar.
org.jvoicexml.xml.srgs.ModeType	getModeType() Returns the mode type of the grammar.
java.lang.String	getTextContent() Retrieves the document as a string.
java.net.URI	getURI() Retrieves the URI of the source grammar.
boolean	isAscii() Checks if the underlying document is an ASCII document.
boolean	isCacheable() Checks, if this grammar document can be cached or should be retrieved anew.
void	setMediaType(org.jvoicexml.xml.srgs.GrammarType type) Sets the media type of this document.
void	setModeType(org.jvoicexml.xml.srgs.ModeType type) Sets the mode type.
void	setURI(java.net.URI uri) Sets the URI of this grammar document.

Method Detail

isCacheable

boolean isCacheable()

Checks, if this grammar document can be cached or should be retrieved anew.

Returns:

true if this grammar document can be cached.

Since:

0.7.7

setURI

void setURI(java.net.URI uri)

Sets the URI of this grammar document.

Parameters:

uri - the new URI

Since:

0.7.7

getURI

java.net.URI getURI()

Retrieves the URI of the source grammar.

Returns:

URI of the grammar document.

Since:

0.7.5

setMediaType

void setMediaType(org.jvoicexml.xml.srgs.GrammarType type)

Sets the media type of this document.

Parameters:

type - the new media type.

getMediaType

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

Returns the declared media type of the grammar.

Returns:

The media type of the grammar file.

setModeType

void setModeType(org.jvoicexml.xml.srgs.ModeType type)

Sets the mode type.

Parameters:

type - the mode type

Since:

0.7.5

getModeType

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

Returns the mode type of the grammar.

Returns:

mode type of the grammar.

Since:

0.7

isAscii

boolean isAscii()

Checks if the underlying document is an ASCII document.

Returns:

true if the document is an ASCII document.

Since:

0.7.5

getDocument

java.lang.String getDocument()

Retrieves the document as a string.

Returns:

the document object.

getTextContent

java.lang.String getTextContent()

Retrieves the document as a string. In contrast to getDocument() this method returns the text content of a node if it was loaded from a Grammar node of a VoiceXmlNode.

Returns:

the document as a string

Since:

0.7.5

getBuffer

byte[] getBuffer()

Retrieves the document's byte array. This is typically useful if isAscii() return false, otherwise the contents of the string based buffer is returned via String.getBytes().

Returns:

the document's byte array

Since:

0.7.5

equals

boolean equals(GrammarDocument other)

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

Parameters:

other - the grammar document to compare with.

Returns:

true if the grammar documents are equal.

Since:

0.7.2