org.jvoicexml.xml.vxml

Class VoiceXmlDocument

java.lang.Object

org.jvoicexml.xml.XmlDocument

org.jvoicexml.xml.vxml.VoiceXmlDocument

All Implemented Interfaces:

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

public final class VoiceXmlDocument
extends XmlDocument
implements java.io.Serializable

A VoiceXML 2.0 or VoiceXML 2.1 document according to the specification in specified at http://www.w3.org/TR/voicexml20/ and http://www.w3.org/TR/voicexml21/.

VoiceXML is designed for creating audio dialogs that feature synthesized speech, digitized audio, recognition of spoken and DTMF key input, recording of spoken input, telephony and mixed initiative conversations. Its major goal is to bring the advantages of web-based development and content delivery to interactive voice response applications.

Objects of this class can create such VoiceXML documents or parse them.

The document type can be controlled via the jvoicexml.vxml.version environment property. A value of 2.0 sets the document type to VoiceXml20DocumentType and a value of 2.1 sets the document type to VoiceXml21DocumentType.

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
VoiceXmlDocument() Create an empty VoiceXML document containing only the root Vxml element.
VoiceXmlDocument(org.w3c.dom.Document doc) Construct a new VoiceXML document with the given document.
VoiceXmlDocument(org.xml.sax.InputSource source) Constructs a new VoiceXML 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.
org.w3c.dom.DocumentType	getDoctype() The Document Type Declaration (see DocumentType) associated with this document.
Vxml	getVxml() Get the one and only child of this document: The Vxml 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.
static void	setDocumentTypeFactory(DocumentTypeFactory factory) Sets the document type factory.

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, 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

VoiceXmlDocument

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

Create an empty VoiceXML document containing only the root Vxml element.

Throws:

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

VoiceXmlDocument

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

Constructs a new VoiceXML 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.

VoiceXmlDocument

public VoiceXmlDocument(org.w3c.dom.Document doc)

Construct a new VoiceXML document with the given document.

Parameters:

doc - Encapsulated document.

Method Detail

setDocumentTypeFactory

public static void setDocumentTypeFactory(DocumentTypeFactory factory)

Sets the document type factory. This method needs to be called once per process if custom document types are to be supported.

Parameters:

factory - the factory to use.

getDoctype

public org.w3c.dom.DocumentType getDoctype()

The Document Type Declaration (see DocumentType) associated with this document.

Specified by:

getDoctype in interface org.w3c.dom.Document

Overrides:

getDoctype in class XmlDocument

Returns:

DocumentType

See Also:

DocumentType

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. Creates a new Vxml node.

Specified by:

createRootNode in class XmlDocument

Returns:

The new created vxml.

getVxml

public Vxml getVxml()

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

Returns:

The Vxml child, null if there is none.

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.

getDefaultNamespaceURI

protected java.lang.String getDefaultNamespaceURI()

Retrieves the default namespace.

Specified by:

getDefaultNamespaceURI in class XmlDocument

Returns:

the default namespace, never null.