org.jvoicexml.xml.vxml
Class VoiceXmlDocument

java.lang.Object
  org.jvoicexml.xml.XmlDocument
      org.jvoicexml.xml.vxml.VoiceXmlDocument

All Implemented Interfaces:

Serializable, XmlWritable, Document, Node

public final class VoiceXmlDocument
extends XmlDocument
implements Serializable

A VoiceXML document according to the specifcation in http://www.w3.org/TR/2005/REC-voicexml20-20050316.

VoiceXML is designed for creating audio dialogs that feature synthesized speech, digitized audio, regognition 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 voiceresponse applications.

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

Version:

$Revision: 154 $

Copyright © 2005-2006 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Dirk Schnelle

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

VoiceXmlDocument()
Create an empty VoiceXML document containg only the root Vxml element.

VoiceXmlDocument(Document doc)
Construct a new VoiceXML document with the given document.

VoiceXmlDocument(InputSource source)
Constructs a new VoiceXML document from the given input source.

Method Summary

protected Node	createRootNode() Create the root node of the document. Creates a new Vxml node.
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 NodeList	getXmlNodeList(NodeList nodeList) Get the XmlNodeList object corresponding to the nodelist.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

VoiceXmlDocument

public VoiceXmlDocument()
                 throws ParserConfigurationException

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

Throws:

ParserConfigurationException - Error creating the document builder.

VoiceXmlDocument

public VoiceXmlDocument(InputSource source)
                 throws ParserConfigurationException,
                        SAXException,
                        IOException

Constructs a new VoiceXML document from the given input source.

Parameters:

source - Input source for a single XML document.

Throws:

ParserConfigurationException - Error creating the document builder.

SAXException - Error parsing the input source.

IOException - Error reading the input source.

VoiceXmlDocument

public VoiceXmlDocument(Document doc)

Construct a new VoiceXML document with the given document.

Parameters:

doc - Encapsulated document.

Method Detail

getDoctype

public DocumentType getDoctype()

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

Specified by:

getDoctype in interface Document

Overrides:

getDoctype in class XmlDocument

Returns:

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 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 NodeList getXmlNodeList(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.