org.jvoicexml.xml.srgs

Class SrgsXmlDocument

java.lang.Object

org.jvoicexml.xml.XmlDocument

org.jvoicexml.xml.srgs.SrgsXmlDocument

All Implemented Interfaces:

java.io.Serializable, org.w3c.dom.Document, org.w3c.dom.Node

public final class SrgsXmlDocument
extends XmlDocument

A SRGS XML document according to the specifcation in http://www.w3.org/TR/2004/REC-speech-grammar-20040316/.

Objects of this class can create SRGS XML grammar documents or parse them.

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Constructor Summary

Constructors

Constructor and Description
SrgsXmlDocument() Creates an empty XML Grammar Document.
SrgsXmlDocument(org.xml.sax.InputSource source) Constructs a new Grammar document from the given input source.

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.Node	createRootNode() Create the root node of the document.
protected java.lang.String	getDefaultNamespaceURI() Retrieves the default namespace.
Grammar	getGrammar() Get the one and only child of this document: The grammar node.
XmlNodeFactory<?>	getXmlNodefactory() Retrieves the node factory for child node lists.
protected org.w3c.dom.NodeList	getXmlNodeList(org.w3c.dom.NodeList nodeList) Get the XmlNodeList object corresponding to the nodelist.
Grammar	setGrammarSimple(java.lang.String id, java.lang.String text) Sets the simplest grammar possible as root with the given id and text.

Methods inherited from class org.jvoicexml.xml.XmlDocument

adoptNode, appendChild, cloneNode, compareDocumentPosition, createAttribute, createAttributeNS, createCDATASection, createComment, createDocumentFragment, createElement, createElementNS, createEntityReference, createProcessingInstruction, createTextNode, getAttributes, getBaseURI, getChildNodes, getDoctype, getDocument, getDocumentElement, getDocumentURI, getDomConfig, getElementById, getElementsByTagName, getElementsByTagNameNS, getFeature, getFirstChild, getImplementation, getInputEncoding, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getStrictErrorChecking, getTextContent, getUserData, getXmlEncoding, getXmlNode, getXmlStandalone, getXmlVersion, hasAttributes, hasChildNodes, importNode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, normalizeDocument, removeChild, renameNode, replaceChild, setDocumentURI, setNodeValue, setPrefix, setStrictErrorChecking, setTextContent, setUserData, setXmlStandalone, setXmlVersion, toString, toXml

Methods inherited from class java.lang.Object

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

Constructor Detail

SrgsXmlDocument

public SrgsXmlDocument()
                throws javax.xml.parsers.ParserConfigurationException

Creates an empty XML Grammar Document.

Throws:

javax.xml.parsers.ParserConfigurationException - If anything goes wrong while parsing the document.

SrgsXmlDocument

public SrgsXmlDocument(org.xml.sax.InputSource source)
                throws javax.xml.parsers.ParserConfigurationException,
                       org.xml.sax.SAXException,
                       java.io.IOException

Constructs a new Grammar document from the given input source.

Parameters:

source - Input source for a single XML document.

Throws:

javax.xml.parsers.ParserConfigurationException - Error creating the document builder.

org.xml.sax.SAXException - Error parsing the input source.

java.io.IOException - Error reading the input source.

Method Detail

getXmlNodefactory

public XmlNodeFactory<?> getXmlNodefactory()

Retrieves the node factory for child node lists.

Specified by:

getXmlNodefactory in class XmlDocument

Returns:

Node factory for child node lists.

createRootNode

protected org.w3c.dom.Node createRootNode()

Create the root node of the document.

Specified by:

createRootNode in class XmlDocument

Returns:

Root node

getXmlNodeList

protected org.w3c.dom.NodeList getXmlNodeList(org.w3c.dom.NodeList nodeList)

Get the XmlNodeList object corresponding to the nodelist.

Specified by:

getXmlNodeList in class XmlDocument

Parameters:

nodeList - - Node to convert to an XmlNodeList

Returns:

XmlNodeList representing the node.

getGrammar

public Grammar getGrammar()

Get the one and only child of this document: The grammar node.

Returns:

The grammar child, null if there is none.

getDefaultNamespaceURI

protected java.lang.String getDefaultNamespaceURI()

Retrieves the default namespace.

Specified by:

getDefaultNamespaceURI in class XmlDocument

Returns:

the default namespace, never null.

setGrammarSimple

public Grammar setGrammarSimple(java.lang.String id,
                                java.lang.String text)

Sets the simplest grammar possible as root with the given id and text.

Parameters:

id - the id of the grammar

text - the grammar text

Returns:

the grammar

Since:

0.7.5