org.jvoicexml.implementation

Class SrgsXmlGrammarImplementation

java.lang.Object

org.jvoicexml.implementation.SrgsXmlGrammarImplementation

All Implemented Interfaces:

GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument>

public final class SrgsXmlGrammarImplementation
extends java.lang.Object
implements GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument>

Implementation of a SRGS XML grammar.

Since:

0.5.5

Constructor Summary

Constructors

Constructor and Description
SrgsXmlGrammarImplementation(org.jvoicexml.xml.srgs.SrgsXmlDocument doc, java.net.URI documentUri) Constructs a new object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument> other) Checks if this grammar implementation is equal to the given grammar implementation.
org.jvoicexml.xml.srgs.SrgsXmlDocument	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.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

SrgsXmlGrammarImplementation

public SrgsXmlGrammarImplementation(org.jvoicexml.xml.srgs.SrgsXmlDocument doc,
                                    java.net.URI documentUri)

Constructs a new object.

Parameters:

doc - the grammar

documentUri - the URI of the grammar document

Method Detail

getURI

public java.net.URI getURI()

Retrieves the URI of the grammar.

Specified by:

getURI in interface GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument>

Returns:

URI of the grammar document.

getGrammarDocument

public org.jvoicexml.xml.srgs.SrgsXmlDocument getGrammarDocument()

Retrieves the grammar document.

Specified by:

getGrammarDocument in interface GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument>

Returns:

the grammar.

getMediaType

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

Returns the declared media type of the external grammar.

Specified by:

getMediaType in interface GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument>

Returns:

The media type of the grammar file.

getModeType

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

Returns the mode type of the grammar.

Specified by:

getModeType in interface GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument>

Returns:

mode type of the grammar.

equals

public boolean equals(GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument> other)

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

Specified by:

equals in interface GrammarImplementation<org.jvoicexml.xml.srgs.SrgsXmlDocument>

Parameters:

other - the grammar implementation to compare with.

Returns:

true if the grammar implementations are equal.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object