org.jvoicexml.xml.ccxml
Class Ccxml

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.ccxml.CcxmlNode
          org.jvoicexml.xml.ccxml.Ccxml

All Implemented Interfaces:

XmlWritable, Node

public final class Ccxml
extends CcxmlNode

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.

Version:

$Revision: 1.5 $

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

Author:

Steve Doyle

Field Summary

protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_VERSION The version of CCXML of this document (required).
static String	ATTRIBUTE_XML_BASE The base URI for this document as defined in XML Base, J.
static String	ATTRIBUTE_XMLNS The designated namespace for CCXXML (required).
private static Set<String>	CHILD_TAGS Valid child tags for this node.
static String	DEFAULT_VERSION Default cc xml version number.
static String	DEFAULT_XMLNS Default namespace.
static String	TAG_NAME Name of the tag.

Fields inherited from class org.jvoicexml.xml.XmlNode

node

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

Ccxml()
Construct a new ccxml object without a node.

Ccxml(Node node)
Construct a new ccxml object.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getTagName() Get the name of the tag for the derived node.
String	getVersion() Retrieve the version attribute.
String	getXmlBase() Retrieve the xmlBase attribute.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	setVersion(String version) Set the version attribute.
void	setXmlBase(String xmlBase) Set the xmlBase attribute.

Methods inherited from class org.jvoicexml.xml.ccxml.CcxmlNode

getChildNodes, getFirstChild, getLastChild, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.jvoicexml.xml.XmlNode

addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getLocalName, getNamespaceURI, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString, writeChildrenXml, writeXml

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

DEFAULT_VERSION

public static final String DEFAULT_VERSION

Default cc xml version number.

See Also:

ATTRIBUTE_VERSION, Constant Field Values

ATTRIBUTE_VERSION

public static final 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 String DEFAULT_XMLNS

Default namespace.

See Also:

ATTRIBUTE_XMLNS, Constant Field Values

ATTRIBUTE_XMLNS

public static final 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 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 ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

CHILD_TAGS

private static final Set<String> CHILD_TAGS

Valid child tags 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:

VoiceXmlNodeFactory

Ccxml

Ccxml(Node node)

Construct a new ccxml object.

Parameters:

node - The encapsulated node.

Method Detail

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in class XmlNode

Returns:

name of the tag.

newInstance

public XmlNode newInstance(Node n)

Create a new instance for the given node.

Specified by:

newInstance in class XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

getVersion

public String getVersion()

Retrieve the version attribute.

Returns:

Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

setVersion

public void setVersion(String version)

Set the version attribute.

Parameters:

version - Value of the version attribute.

See Also:

ATTRIBUTE_VERSION

getXmlBase

public String getXmlBase()

Retrieve the xmlBase attribute.

Returns:

Value of the xmlBase attribute.

See Also:

ATTRIBUTE_XML_BASE

setXmlBase

public void setXmlBase(String xmlBase)

Set the xmlBase attribute.

Parameters:

xmlBase - Value of the xmlBase attribute.

See Also:

ATTRIBUTE_XML_BASE

canContainChild

protected boolean canContainChild(String tagName)

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

Specified by:

canContainChild in class XmlNode

Parameters:

tagName - Name of child.

Returns:

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

getAttributeNames

public Collection<String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Overrides:

getAttributeNames in class XmlNode

Returns:

A collection of attribute names that are allowed for the node