org.jvoicexml.xml.ccxml

Class CcxmlDocument

java.lang.Object

org.jvoicexml.xml.XmlDocument

org.jvoicexml.xml.ccxml.CcxmlDocument

All Implemented Interfaces:

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

public final class CcxmlDocument
extends XmlDocument

A CCXML document according to the specifcation in http://www.w3.org/TR/ccxml.

CCXML is designed to provide telephony call control support for dialog systems, such as VoiceXML [VOICEXML]. While CCXML can be used with any dialog systems capable of handling media, CCXML has been designed to complement and integrate with a VoiceXML interpreter.

Objects of this class can create such CCXML 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
CcxmlDocument() Create an empty CCXML document containg only the root Ccxml element.
CcxmlDocument(org.w3c.dom.Document doc) Construct a new CCXML document with the given document.
CcxmlDocument(org.xml.sax.InputSource source) Constructs a new CCXML document from the given input source.

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.Node	createRootNode() Create a new Ccxml node.
Ccxml	getCcxml() Get the one and only child of this document: The Ccxml node.
protected java.lang.String	getDefaultNamespaceURI() Retrieves the default namespace.
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.

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

CcxmlDocument

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

Create an empty CCXML document containg only the root Ccxml element.

Throws:

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

CcxmlDocument

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

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

CcxmlDocument

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

Construct a new CCXML document with the given document.

Parameters:

doc - Encapsulated document.

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

Specified by:

createRootNode in class XmlDocument

Returns:

The new created ccxml.

getCcxml

public Ccxml getCcxml()

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

Returns:

The Ccxml 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.