org.jvoicexml.xml.ssml

Class SayAs

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.ssml.SayAs

All Implemented Interfaces:

SsmlNode, TextContainer, VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class SayAs
extends AbstractXmlNode
implements VoiceXmlNode, TextContainer

The say-as element allows the author to indicate information on the type of text construct contained within the element and to help specify the level of detail for rendering the contained text.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_DETAIL Optional attribute that indicates the level of detail to be read aloud or rendered.
static java.lang.String	ATTRIBUTE_FORMAT Provides hints on the precise formatting of the contained text for content types that may have ambiguous formats.
static java.lang.String	ATTRIBUTE_INTERPRET_AS indicates the content type of the contained text construct.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
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
SayAs() Construct a new say-as object without a node.

Method Summary

Modifier and Type	Method and Description
Text	addText(java.lang.String text) Creates a new text within this node.
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	getDetail() Retrieve the detail attribute.
java.lang.String	getFormat() Retrieve the format attribute.
java.lang.String	getInterpretAs() Retrieve the interpret-as attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setDetail(java.lang.String detail) Set the detail attribute.
void	setFormat(java.lang.String format) Set the format attribute.
void	setInterpretAs(java.lang.String interpretAs) Set the interpret-as 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.TextContainer

getNodeFactory

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

ATTRIBUTE_INTERPRET_AS

public static final java.lang.String ATTRIBUTE_INTERPRET_AS

indicates the content type of the contained text construct.

See Also:

Constant Field Values

ATTRIBUTE_FORMAT

public static final java.lang.String ATTRIBUTE_FORMAT

Provides hints on the precise formatting of the contained text for content types that may have ambiguous formats.

See Also:

Constant Field Values

ATTRIBUTE_DETAIL

public static final java.lang.String ATTRIBUTE_DETAIL

Optional attribute that indicates the level of detail to be read aloud or rendered.

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

SayAs

public SayAs()

Construct a new say-as object without a node.

This is necessary for the node factory.

See Also:

SsmlNodeFactory

Method Detail

getInterpretAs

public java.lang.String getInterpretAs()

Retrieve the interpret-as attribute.

Returns:

Value of the interpret-as attribute.

See Also:

ATTRIBUTE_INTERPRET_AS

setInterpretAs

public void setInterpretAs(java.lang.String interpretAs)

Set the interpret-as attribute.

Parameters:

interpretAs - Value of the interpretAs attribute.

See Also:

ATTRIBUTE_INTERPRET_AS

getFormat

public java.lang.String getFormat()

Retrieve the format attribute.

Returns:

Value of the format attribute.

See Also:

ATTRIBUTE_FORMAT

setFormat

public void setFormat(java.lang.String format)

Set the format attribute.

Parameters:

format - Value of the format attribute.

See Also:

ATTRIBUTE_FORMAT

getDetail

public java.lang.String getDetail()

Retrieve the detail attribute.

Returns:

Value of the detail attribute.

See Also:

ATTRIBUTE_DETAIL

setDetail

public void setDetail(java.lang.String detail)

Set the detail attribute.

Parameters:

detail - Value of the detail attribute.

See Also:

ATTRIBUTE_DETAIL

getTagName

public java.lang.String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in interface XmlNode

Returns:

name of the tag.

addText

public Text addText(java.lang.String text)

Creates a new text within this node. If the last child node already is a text node the given trimmed text is appended to that node.

Specified by:

addText in interface TextContainer

Parameters:

text - The text to be added.

Returns:

The new created text.

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.

Specified by:

newInstance in interface XmlNode

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