org.jvoicexml.xml.vxml

Class Foreach

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Foreach

All Implemented Interfaces:

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

public final class Foreach
extends AbstractXmlNode
implements TextContainer

A foreach node.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ARRAY An ECMAScript expression that must evaluate to an array; otherwise, an error.semantic event is thrown.
static java.lang.String	ATTRIBUTE_ITEM The variable that stores each array item upon each iteration of the loop.
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
Foreach() Construct a new foreach object without a node.

Method Summary

Modifier and Type	Method and Description
Text	addText(java.lang.String text) Creates a new text within this prompt.
protected boolean	canContainChild(java.lang.String tagName) Can the specified sub-tag be contained within this node?
java.lang.String	getArray() Retrieve the array attribute.
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getItem() Retrieve the item 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	setArray(java.lang.String array) Set the array attribute.
void	setItem(java.lang.String item) Set the item 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_ITEM

public static final java.lang.String ATTRIBUTE_ITEM

The variable that stores each array item upon each iteration of the loop. A new variable will be declared if it is not already defined within the parent's scope.

See Also:

Constant Field Values

ATTRIBUTE_ARRAY

public static final java.lang.String ATTRIBUTE_ARRAY

An ECMAScript expression that must evaluate to an array; otherwise, an error.semantic event is thrown.

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

Foreach

public Foreach()

Construct a new foreach object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Method 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.

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

getItem

public java.lang.String getItem()

Retrieve the item attribute.

Returns:

Value of the item attribute.

See Also:

ATTRIBUTE_ITEM

setItem

public void setItem(java.lang.String item)

Set the item attribute.

Parameters:

item - Value of the item attribute.

See Also:

ATTRIBUTE_ITEM

getArray

public java.lang.String getArray()

Retrieve the array attribute.

Returns:

Value of the array attribute.

See Also:

ATTRIBUTE_ARRAY

setArray

public void setArray(java.lang.String array)

Set the array attribute.

Parameters:

array - Value of the array attribute.

See Also:

ATTRIBUTE_ARRAY

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

addText

public Text addText(java.lang.String text)

Creates a new text within this prompt. 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.