org.jvoicexml.xml.vxml

Class Menu

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Menu

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Menu
extends AbstractXmlNode

A dialog for choosing amongst alternative destinations.

This identifies the menu, and determines the scope of its grammars.

See Also:

Goto, Submit, Choice

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ACCEPT When set to "exact" (the default), the text of the choice elements in the menu defines the exact phrase to be recognized.
static java.lang.String	ATTRIBUTE_DTMF When set to true, the first nine choices that have not explicitly specified a value for the dtmf attribute are given the implicit ones "1", "2", etc.
static java.lang.String	ATTRIBUTE_ID The identifier of the menu.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_SCOPE The menu's grammar scope.
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
Menu() Construct a new menu object without a node.

Method Summary

Modifier and Type	Method and Description
Text	addText(java.lang.String text) Create a new text within this node.
protected boolean	canContainChild(java.lang.String tagName) Can the specified sub-tag be contained within this node?
java.lang.String	getAccept() Retrieve the accept attribute.
AcceptType	getAcceptObject() Retrieve the accept attribute.
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getDtmf() Retrieve the dtmf attribute.
java.lang.String	getId() Retrieve the id attribute.
java.lang.String	getScope() Retrieve the scope attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
boolean	isDtmf() Checks if the DTMF attribute is set.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setAccept(AcceptType accept) Set the accept attribute.
void	setAccept(java.lang.String accept) Set the accept attribute.
void	setDtmf(boolean enable) Set the dtmf attribute.
void	setDtmf(java.lang.String dtmf) Set the dtmf attribute.
void	setId(java.lang.String id) Set the id attribute.
void	setScope(java.lang.String scope) Set the scope 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 tag.

See Also:

Constant Field Values

ATTRIBUTE_ID

public static final java.lang.String ATTRIBUTE_ID

The identifier of the menu. It allows the menu to be the target of a <goto> or a <submit>.

See Also:

Constant Field Values

ATTRIBUTE_SCOPE

public static final java.lang.String ATTRIBUTE_SCOPE

The menu's grammar scope. If it is dialog (the default), the menu's grammars are only active when the user transitions into the menu. If the scope is document, its grammars are active over the whole document (or if the menu is in the application root document, any loaded document in the application).

See Also:

Constant Field Values

ATTRIBUTE_DTMF

public static final java.lang.String ATTRIBUTE_DTMF

When set to true, the first nine choices that have not explicitly specified a value for the dtmf attribute are given the implicit ones "1", "2", etc. Remaining choices that have not explicitly specified a value for the dtmf attribute will not be assigned DTMF values (and thus cannot be matched via a DTMF keypress). If there are choices which have specified their own DTMF sequences to be something other than "*", "#", or "0", an error.badfetch will be thrown. The default is false.

See Also:

Constant Field Values

ATTRIBUTE_ACCEPT

public static final java.lang.String ATTRIBUTE_ACCEPT

When set to "exact" (the default), the text of the choice elements in the menu defines the exact phrase to be recognized. When set to "approximate", the text of the choice elements defines an approximate recognition phrase. Each <choice> can override this setting.

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

Menu

public Menu()

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

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

getId

public java.lang.String getId()

Retrieve the id attribute.

Returns:

Value of the id attribute.

See Also:

ATTRIBUTE_ID

setId

public void setId(java.lang.String id)

Set the id attribute.

Parameters:

id - Value of the id attribute.

See Also:

ATTRIBUTE_ID

getScope

public java.lang.String getScope()

Retrieve the scope attribute.

Returns:

Value of the scope attribute.

See Also:

ATTRIBUTE_SCOPE

setScope

public void setScope(java.lang.String scope)

Set the scope attribute.

Parameters:

scope - Value of the scope attribute.

See Also:

ATTRIBUTE_SCOPE

getDtmf

public java.lang.String getDtmf()

Retrieve the dtmf attribute.

Returns:

Value of the dtmf attribute.

See Also:

ATTRIBUTE_DTMF

isDtmf

public boolean isDtmf()

Checks if the DTMF attribute is set.

Returns:

true if the DTMF attribute is set to true.

See Also:

ATTRIBUTE_DTMF

setDtmf

public void setDtmf(java.lang.String dtmf)

Set the dtmf attribute.

Parameters:

dtmf - Value of the dtmf attribute.

See Also:

ATTRIBUTE_DTMF

setDtmf

public void setDtmf(boolean enable)

Set the dtmf attribute.

Parameters:

enable - true if DTMF generation should be enables.

See Also:

ATTRIBUTE_DTMF

getAccept

public java.lang.String getAccept()

Retrieve the accept attribute.

Returns:

Value of the accept attribute.

See Also:

ATTRIBUTE_ACCEPT

getAcceptObject

public AcceptType getAcceptObject()

Retrieve the accept attribute.

Returns:

Value of the accept attribute.

Since:

0.7.5

See Also:

ATTRIBUTE_ACCEPT

setAccept

public void setAccept(java.lang.String accept)

Set the accept attribute.

Parameters:

accept - Value of the accept attribute.

See Also:

ATTRIBUTE_ACCEPT

setAccept

public void setAccept(AcceptType accept)

Set the accept attribute.

Parameters:

accept - Value of the accept attribute.

Since:

0.7.5

See Also:

ATTRIBUTE_ACCEPT

addText

public Text addText(java.lang.String text)

Create a new text within this node.

Parameters:

text - The text to be added.

Returns:

The new created text.

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