org.jvoicexml.xml.vxml

Class Vxml

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Vxml

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Vxml
extends AbstractXmlNode

A VoiceXML document is primarily composed of top-level elements called dialogs. There are two types of dialogs: forms and menus. A document may also have <meta> and <metadata> elements, <var> and <script> elements, <catch> elements, <property> elements and <link> elements.

See Also:

VoiceXmlDocument, Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_APPLICATION The URI of this document's application root document, if any.
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 VoiceXML 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_XML_LANG The language identifier for this document.
static java.lang.String	ATTRIBUTE_XMLNS The designated namespace for VoiceXXML (required).
static java.lang.String	DEFAULT_VERSION Default Voice XML version number.
static java.lang.String	DEFAULT_XMLNS Default namespace.
static java.lang.String	TAG_NAME Name of the VXML 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
Vxml() Construct a new vxml object without a node.
Vxml(org.w3c.dom.Node node) Construct a new vxml object.

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.lang.String	getApplication() Retrieves the application attribute.
java.net.URI	getApplicationUri() Retrieves the application attribute.
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.util.Map<java.lang.String,Form>	getFormMap() Get all forms in this document as a map with the name of the form being key.
java.util.List<Form>	getForms() Retrieves a list of all forms in this document.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.util.Map<java.lang.String,Var>	getVarMap() Get all VAR tags in this document as a map with the name of the var being key.
java.lang.String	getVersion() Retrieve the version attribute.
java.lang.String	getXmlBase() Retrieves the xml:base attribute.
java.net.URI	getXmlBaseUri() Retrieves the xml:base attribute as an URI.
java.lang.String	getXmlLang() Retrieve the xml:lang attribute.
java.util.Locale	getXmlLangObject() Retrieve the xml:lang attribute.
java.lang.String	getXmlns() Retrieves the xmlns attribute.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setApplication(java.lang.String application) Sets the application attribute.
void	setApplication(java.net.URI application) Sets the application attribute.
void	setVersion(java.lang.String version) Sets the version attribute.
void	setXmlBase(java.lang.String xmlBase) Sets the xml:base attribute.
void	setXmlBase(java.net.URI xmlBase) Sets the xml:base attribute.
void	setXmlLang(java.util.Locale locale) Set the xml:lang attribute.
void	setXmlLang(java.lang.String xmlLang) Set the xml:lang attribute.
void	setXmlns(java.lang.String xmlns) Sets the xmlns 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 VXML tag.

See Also:

Constant Field Values

DEFAULT_VERSION

public static final java.lang.String DEFAULT_VERSION

Default Voice XML version number.

See Also:

ATTRIBUTE_VERSION, Constant Field Values

ATTRIBUTE_VERSION

public static final java.lang.String ATTRIBUTE_VERSION

The version of VoiceXML 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 VoiceXXML (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 document take as their base.

See Also:

Constant Field Values

ATTRIBUTE_XML_LANG

public static final java.lang.String ATTRIBUTE_XML_LANG

The language identifier for this document. If omitted the value is a platform-specific default.

See Also:

Constant Field Values

ATTRIBUTE_APPLICATION

public static final java.lang.String ATTRIBUTE_APPLICATION

The URI of this document's application root document, if any.

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

Vxml

public Vxml()

Construct a new vxml object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Vxml

public Vxml(org.w3c.dom.Node node)

Construct a new vxml object.

Parameters:

node - The encapsulated node.

Method Detail

getForms

public java.util.List<Form> getForms()

Retrieves a list of all forms in this document.

Returns:

list of all forms

Since:

0.7.6

getFormMap

public java.util.Map<java.lang.String,Form> getFormMap()

Get all forms in this document as a map with the name of the form being key.

Returns:

Map with all named forms.

getVarMap

public java.util.Map<java.lang.String,Var> getVarMap()

Get all VAR tags in this document as a map with the name of the var being key.

Returns:

Map with all named VAR tags.

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)

Sets the version attribute.

Parameters:

version - Value of the version attribute.

Since:

0.7

See Also:

ATTRIBUTE_VERSION

getXmlns

public java.lang.String getXmlns()

Retrieves the xmlns attribute.

Returns:

Value of the xmlns attribute.

See Also:

ATTRIBUTE_XMLNS

setXmlns

public void setXmlns(java.lang.String xmlns)

Sets the xmlns attribute.

Parameters:

xmlns - Value of the xmlns attribute.

See Also:

ATTRIBUTE_XMLNS

getXmlBase

public java.lang.String getXmlBase()

Retrieves the xml:base attribute.

Returns:

Value of the xml:base attribute.

See Also:

ATTRIBUTE_XML_BASE

getXmlBaseUri

public java.net.URI getXmlBaseUri()
                           throws java.net.URISyntaxException

Retrieves the xml:base attribute as an URI.

Returns:

Value of the xml:base attribute.

Throws:

java.net.URISyntaxException - Value is not a valid URI.

Since:

0.6

See Also:

ATTRIBUTE_XML_BASE

setXmlBase

public void setXmlBase(java.lang.String xmlBase)

Sets the xml:base attribute.

Parameters:

xmlBase - Value of the xml:base attribute.

See Also:

ATTRIBUTE_XML_BASE

setXmlBase

public void setXmlBase(java.net.URI xmlBase)

Sets the xml:base attribute.

Parameters:

xmlBase - Value of the xml:base attribute.

Since:

0.6

See Also:

ATTRIBUTE_XML_BASE

getXmlLang

public java.lang.String getXmlLang()

Retrieve the xml:lang attribute.

Returns:

Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

getXmlLangObject

public java.util.Locale getXmlLangObject()

Retrieve the xml:lang attribute.

Returns:

Value of the xml:lang attribute.

Since:

0.7.1

See Also:

ATTRIBUTE_XML_LANG

setXmlLang

public void setXmlLang(java.lang.String xmlLang)

Set the xml:lang attribute.

Parameters:

xmlLang - Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

setXmlLang

public void setXmlLang(java.util.Locale locale)

Set the xml:lang attribute.

Parameters:

locale - Value of the xml:lang attribute.

Since:

0.7.1

See Also:

ATTRIBUTE_XML_LANG

getApplication

public java.lang.String getApplication()

Retrieves the application attribute.

Returns:

Value of the application attribute.

See Also:

ATTRIBUTE_APPLICATION

getApplicationUri

public java.net.URI getApplicationUri()
                               throws java.net.URISyntaxException

Retrieves the application attribute.

Returns:

Value of the application attribute.

Throws:

java.net.URISyntaxException - value is not a valid URI.

Since:

0.6

See Also:

ATTRIBUTE_APPLICATION

setApplication

public void setApplication(java.lang.String application)

Sets the application attribute.

Parameters:

application - Value of the application attribute.

See Also:

ATTRIBUTE_XML_LANG

setApplication

public void setApplication(java.net.URI application)

Sets the application attribute.

Parameters:

application - Value of the application attribute.

Since:

0.6

See Also:

ATTRIBUTE_XML_LANG

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

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