org.jvoicexml.documentserver

Class ExternalGrammarDocument

java.lang.Object

org.jvoicexml.documentserver.ExternalGrammarDocument

All Implemented Interfaces:

GrammarDocument

public final class ExternalGrammarDocument
extends java.lang.Object
implements GrammarDocument

Basic implementation of a GrammarDocument.

Since:

0.5.5

Constructor Summary

Constructors

Constructor and Description
ExternalGrammarDocument(java.net.URI source, byte[] content, java.lang.String encoding, boolean ascii) Creates a new grammar document.

Method Summary

Modifier and Type	Method and Description
boolean	equals(GrammarDocument other) Checks if this grammar document is equal to the given grammar document.
boolean	equals(java.lang.Object obj)
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.
int	hashCode()
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 grammartype) Sets the media type of this document.
void	setModeType(org.jvoicexml.xml.srgs.ModeType modeType) Sets the mode type.
void	setURI(java.net.URI value) Sets the URI of this grammar document.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExternalGrammarDocument

public ExternalGrammarDocument(java.net.URI source,
                               byte[] content,
                               java.lang.String encoding,
                               boolean ascii)

Creates a new grammar document. This constructor is intended to be used to capture external grammars.

Parameters:

source - URI of the grammar document

content - the grammar itself

encoding - guessed encoding of the grammar

ascii - true if content is in ASCII format

Method Detail

isCacheable

public boolean isCacheable()

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

Specified by:

isCacheable in interface GrammarDocument

Returns:

true if this grammar document can be cached.

setURI

public void setURI(java.net.URI value)

Sets the URI of this grammar document.

Specified by:

setURI in interface GrammarDocument

Parameters:

value - the new URI

getURI

public java.net.URI getURI()

Retrieves the URI of the source grammar.

Specified by:

getURI in interface GrammarDocument

Returns:

URI of the grammar document.

getMediaType

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

Returns the declared media type of the grammar.

Specified by:

getMediaType in interface GrammarDocument

Returns:

The media type of the grammar file.

setMediaType

public void setMediaType(org.jvoicexml.xml.srgs.GrammarType grammartype)

Sets the media type of this document.

Specified by:

setMediaType in interface GrammarDocument

Parameters:

grammartype - the new media type.

isAscii

public boolean isAscii()

Checks if the underlying document is an ASCII document.

Specified by:

isAscii in interface GrammarDocument

Returns:

true if the document is an ASCII document.

getBuffer

public byte[] getBuffer()

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

Specified by:

getBuffer in interface GrammarDocument

Returns:

the document's byte array

getDocument

public java.lang.String getDocument()

Retrieves the document as a string.

Specified by:

getDocument in interface GrammarDocument

Returns:

the document object.

getTextContent

public java.lang.String getTextContent()

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

Specified by:

getTextContent in interface GrammarDocument

Returns:

the document as a string

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equals

public boolean equals(GrammarDocument other)

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

Specified by:

equals in interface GrammarDocument

Parameters:

other - the grammar document to compare with.

Returns:

true if the GrammarDocuments share the same buffer

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getModeType

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

Returns the mode type of the grammar.

Specified by:

getModeType in interface GrammarDocument

Returns:

mode type of the grammar.

setModeType

public void setModeType(org.jvoicexml.xml.srgs.ModeType modeType)

Sets the mode type.

Specified by:

setModeType in interface GrammarDocument

Parameters:

modeType - the mode type

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object