org.jvoicexml.xml.ccxml

Class Ccxml

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.ccxml.Ccxml

All Implemented Interfaces:

CcxmlNode, XmlNode, org.w3c.dom.Node

public final class Ccxml
extends AbstractXmlNode

This is the parent element of a CCXML document and encloses the entire CCXML script in a document. When a <ccxml> is executed, its child elements are collected logically together at the beginning of the document and executed in document order before the target <eventprocessor>. This is called document initialization.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_VERSION The version of CCXML of this document (required).
static java.lang.String	ATTRIBUTE_XML_BASE The base URI for this document as defined in XML Base, J.
static java.lang.String	ATTRIBUTE_XMLNS The designated namespace for CCXXML (required).
static java.lang.String	DEFAULT_VERSION Default cc xml version number.
static java.lang.String	DEFAULT_XMLNS Default namespace.
static java.lang.String	TAG_NAME Name of the tag.

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
Ccxml() Construct a new ccxml object without a node.

Method Summary

Modifier and Type	Method and Description
protected boolean	canContainChild(java.lang.String tagName) Can the specified sub-tag be contained within this node?
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getVersion() Retrieve the version attribute.
java.lang.String	getXmlBase() Retrieve the xmlBase attribute.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setVersion(java.lang.String version) Set the version attribute.
void	setXmlBase(java.lang.String xmlBase) Set the xmlBase attribute.

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

addChild, addChild, appendChild, appendChild, appendDeepClone, cloneNode, compareDocumentPosition, equals, getAttribute, getAttributes, getBaseURI, getChildNodes, getChildNodes, getChildren, getDefinedAttributeNames, getFeature, getFirstChild, getFirstLevelTextContent, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeFactory, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getOwnerXmlDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttribute, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jvoicexml.xml.XmlNode

addChild, getAttribute, getChildNodes, getChildren, getNode, setAttribute

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

DEFAULT_VERSION

public static final java.lang.String DEFAULT_VERSION

Default cc xml version number.

See Also:

ATTRIBUTE_VERSION, Constant Field Values

ATTRIBUTE_VERSION

public static final java.lang.String ATTRIBUTE_VERSION

The version of CCXML of this document (required). The current version number is DEFAULT_VERSION.

See Also:

DEFAULT_VERSION, Constant Field Values

DEFAULT_XMLNS

public static final java.lang.String DEFAULT_XMLNS

Default namespace.

See Also:

ATTRIBUTE_XMLNS, Constant Field Values

ATTRIBUTE_XMLNS

public static final java.lang.String ATTRIBUTE_XMLNS

The designated namespace for CCXXML (required). The namespace for VoiceXML is defined to be DEFAULT_XMLNS

See Also:

Constant Field Values

ATTRIBUTE_XML_BASE

public static final java.lang.String ATTRIBUTE_XML_BASE

The base URI for this document as defined in XML Base, J. Marsh, editor, W3C Recommendation, June 2001. As in HTML 4.01 Specification, Dave Ragget et. al. W3C Recommendation, December 1999, a URI which all relative references within the docment take as their base.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Ccxml

public Ccxml()

Construct a new ccxml object without a node.

This is necessary for the node factory.

See Also:

CcxmlNodeFactory

Method Detail

getTagName

public java.lang.String getTagName()

Get the name of the tag for the derived node.

Returns:

name of the tag.

newInstance

public XmlNode newInstance(org.w3c.dom.Node n,
                           XmlNodeFactory<? extends XmlNode> factory)

Create a new instance for the given node.

Each XmlNode can serve as a prototype in a XmlNodeFactory to produce a collection of child nodes. Factories can then use the prototype pattern to produce new nodes.

Parameters:

n - The node to encapsulate.

factory - the factroy that calls this method.

Returns:

The new instance.

See Also:

XmlNodeFactory

getVersion

public java.lang.String getVersion()

Retrieve the version attribute.

Returns:

Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

setVersion

public void setVersion(java.lang.String version)

Set the version attribute.

Parameters:

version - Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

getXmlBase

public java.lang.String getXmlBase()

Retrieve the xmlBase attribute.

Returns:

Value of the xmlBase attribute.

See Also:

ATTRIBUTE_XML_BASE

setXmlBase

public void setXmlBase(java.lang.String xmlBase)

Set the xmlBase attribute.

Parameters:

xmlBase - Value of the xmlBase attribute.

See Also:

ATTRIBUTE_XML_BASE

canContainChild

protected boolean canContainChild(java.lang.String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class AbstractXmlNode

Parameters:

tagName - Name of child.

Returns:

True if the sub-tag is allowed on this node.

getAttributeNames

public java.util.Collection<java.lang.String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Specified by:

getAttributeNames in interface XmlNode

Overrides:

getAttributeNames in class AbstractXmlNode

Returns:

A collection of attribute names that are allowed for the node