org.jvoicexml.xml.ssml
Class Desc

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.vxml.VoiceXmlNode
          org.jvoicexml.xml.ssml.Desc

All Implemented Interfaces:

XmlWritable, Node

public final class Desc
extends VoiceXmlNode

The desc element can only occur within the content of the audio element. When the audio source referenced in audio is not speech, e.g. audio wallpaper or sonicon punctuation, it should contain a desc element whose textual content is a description of the audio source (e.g. "door slamming").

Version:

$Revision: 1.5 $

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

Author:

Steve Doyle

See Also:

Audio

Field Summary

protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_XML_LANG Used to indicate that the content of the element is in a different language from that of the content surrounding the element.
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

Desc()
Construct a new desc object without a node.

Desc(Node node)
Construct a new desc object.

Method Summary

Text	addText(String text) Create a new text within this block.
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	getXmlLang() Retrieve the xml:lang attribute.
VoiceXmlNode	newInstance(Node n) Create a new instance for the given node.
void	setXmlLang(String xmlLang) Set the xml:lang attribute.

Methods inherited from class org.jvoicexml.xml.vxml.VoiceXmlNode

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

ATTRIBUTE_XML_LANG

public static final String ATTRIBUTE_XML_LANG

Used to indicate that the content of the element is in a different language from that of the content surrounding the element.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Desc

public Desc()

Construct a new desc object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Desc

Desc(Node node)

Construct a new desc 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 VoiceXmlNode 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.

getXmlLang

public String getXmlLang()

Retrieve the xml:lang attribute.

Returns:

Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

setXmlLang

public void setXmlLang(String xmlLang)

Set the xml:lang attribute.

Parameters:

xmlLang - Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

addText

public Text addText(String text)

Create a new text within this block.

Parameters:

text - The text to be added.

Returns:

The new created text.

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