Choice (org.jvoicexml.xml 0.7.8 API)

java.lang.Object
- org.jvoicexml.xml.AbstractXmlNode
- - org.jvoicexml.xml.vxml.Choice

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node
```
public final class Choice
extends AbstractXmlNode
```
Define a menu item. The <choice> element serves several purposes:
- It may specify a speech grammar, defined either using a <grammar> element or automatically generated by the process described in Section 2.2.5 of http://www.w3.org/TR/2005/REC-voicexml20-20050316.
- It may specify a DTMF grammar, as discussed in Section 2.2.3 of http://www.w3.org/TR/2005/REC-voicexml20-20050316
- The contents may be used to form the <enumerate> prompt string. This is described in Section 2.2.4 of http://www.w3.org/TR/2005/REC-voicexml20-20050316
- And it specifies either an event to be thrown or the URI to go to when the choice is selected.
See Also:

Enumerate, Form, Grammar

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ATTRIBUTE_ACCEPT` Override the setting for accept in `<menu>` for this particular choice.
`static java.lang.String`	`ATTRIBUTE_DTMF` The DTMF sequence for this choice.
`static java.lang.String`	`ATTRIBUTE_EVENT` Specify an event to be thrown instead of specifying a next.
`static java.lang.String`	`ATTRIBUTE_EVENTEXPR` An ECMAScript expression evaluating to the name of the event to be thrown.
`static java.lang.String`	`ATTRIBUTE_EXPR` Specify an expression to evaluate as a URI to transition to instead of specifying a next.
`static java.lang.String`	`ATTRIBUTE_FETCHAUDIO` The URI of the audio clip to play while the fetch is being done.
`static java.lang.String`	`ATTRIBUTE_FETCHHINT` Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed.
`static java.lang.String`	`ATTRIBUTE_FETCHTIMEOUT` The interval to wait for the content to be returned before throwing an error.badfetch event.
`static java.lang.String`	`ATTRIBUTE_MAXAGE` Indicates that the document is willing to use content whose age is no greater than the specified time in seconds.
`static java.lang.String`	`ATTRIBUTE_MAXSTALE` Indicates that the document is willing to use content that has exceeded its expiration time.
`static java.lang.String`	`ATTRIBUTE_MESSAGE` A message string providing additional context about the event being thrown.
`static java.lang.String`	`ATTRIBUTE_MESSAGEEXPR` An ECMAScript expression evaluating to the message string.
`protected static java.util.ArrayList<java.lang.String>`	`ATTRIBUTE_NAMES` Supported attribute names for this node.
`static java.lang.String`	`ATTRIBUTE_NEXT` The URI of next dialog or document.
`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

Choice()
Construct a new choice object without a node.

Constructors
Constructor and Description
`Choice()` Construct a new choice object without a node.

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getEvent()` Retrieve the event attribute.
`java.lang.String`	`getEventexpr()` Retrieve the eventexpr attribute.
`java.lang.String`	`getExpr()` Retrieve the expr attribute.
`java.lang.String`	`getFetchaudio()` Retrieve the fetchaudio attribute.
`java.lang.String`	`getFetchhint()` Retrieve the fetchhint attribute.
`java.lang.String`	`getFetchtimeout()` Retrieve the fetchtimeout attribute.
`java.lang.String`	`getMaxage()` Retrieve the maxage attribute.
`java.lang.String`	`getMaxstale()` Retrieve the maxstale attribute.
`java.lang.String`	`getMessage()` Retrieve the message attribute.
`java.lang.String`	`getMessageexpr()` Retrieve the messageexpr attribute.
`java.lang.String`	`getNext()` Retrieve the next attribute.
`java.net.URI`	`getNextUri()` Retrieve the next attribute.
`java.lang.String`	`getTagName()` Get the name of the tag for the derived node.
`boolean`	`hasDtmf()` Checks if the DTMF attribute is set.
`boolean`	`isAcceptSpecified()` Checks if an accept attribute has been specified.
`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(java.lang.String dtmf)` Set the dtmf attribute.
`void`	`setEvent(java.lang.String event)` Set the event attribute.
`void`	`setEventexpr(java.lang.String eventexpr)` Set the eventexpr attribute.
`void`	`setExpr(java.lang.String expr)` Set the expr attribute.
`void`	`setFetchaudio(java.lang.String fetchaudio)` Set the fetchaudio attribute.
`void`	`setFetchhint(java.lang.String fetchhint)` Set the fetchhint attribute.
`void`	`setFetchtimeout(java.lang.String fetchtimeout)` Set the fetchtimeout attribute.
`void`	`setMaxage(java.lang.String maxage)` Set the maxage attribute.
`void`	`setMaxstale(java.lang.String maxstale)` Set the maxstale attribute.
`void`	`setMessage(java.lang.String message)` Set the message attribute.
`void`	`setMessageexpr(java.lang.String messageexpr)` Set the messageexpr attribute.
`void`	`setNext(java.lang.String next)` Sets the next attribute.
`void`	`setNext(java.net.URI uri)` Sets the next 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_DTMF
```
public static final java.lang.String ATTRIBUTE_DTMF
```
    The DTMF sequence for this choice. It is equivalent to a simple DTMF <grammar> and DTMF properties apply to recognition of the sequence. Unlike DTMF grammars, whitespace is optional: dtmf="123#" is equivalent to dtmf="1 2 3 #".
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ACCEPT
```
public static final java.lang.String ATTRIBUTE_ACCEPT
```
    Override the setting for accept in <menu> for this particular choice. When set to "exact" (the default), the text of the choice element defines the exact phrase to be recognized. When set to "approximate", the text of the choice element defines an approximate recognition phrase.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_NEXT
```
public static final java.lang.String ATTRIBUTE_NEXT
```
    The URI of next dialog or document.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_EXPR
```
public static final java.lang.String ATTRIBUTE_EXPR
```
    Specify an expression to evaluate as a URI to transition to instead of specifying a next.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_EVENT
```
public static final java.lang.String ATTRIBUTE_EVENT
```
    Specify an event to be thrown instead of specifying a next.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_EVENTEXPR
```
public static final java.lang.String ATTRIBUTE_EVENTEXPR
```
    An ECMAScript expression evaluating to the name of the event to be thrown.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_MESSAGE
```
public static final java.lang.String ATTRIBUTE_MESSAGE
```
    A message string providing additional context about the event being thrown.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_MESSAGEEXPR
```
public static final java.lang.String ATTRIBUTE_MESSAGEEXPR
```
    An ECMAScript expression evaluating to the message string.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_FETCHAUDIO
```
public static final java.lang.String ATTRIBUTE_FETCHAUDIO
```
    The URI of the audio clip to play while the fetch is being done. If not specified, the fetchaudio property is used, and if that property is not set, no audio is played during the fetch. The fetching of the audio clip is governed by the audiofetchhint, audiomaxage, audiomaxstale, and fetchtimeout properties in effect at the time of the fetch. The playing of the audio clip is governed by the fetchaudiodelay, and fetchaudiominimum properties in effect at the time of the fetch.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_FETCHTIMEOUT
```
public static final java.lang.String ATTRIBUTE_FETCHTIMEOUT
```
    The interval to wait for the content to be returned before throwing an error.badfetch event. This defaults to the fetchtimeout property.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_FETCHHINT
```
public static final java.lang.String ATTRIBUTE_FETCHHINT
```
    Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed. This defaults to the audiofetchhint property.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_MAXAGE
```
public static final java.lang.String ATTRIBUTE_MAXAGE
```
    Indicates that the document is willing to use content whose age is no greater than the specified time in seconds. The document is not willing to use stale content, unless maxstale is also provided. This defaults to the audiomaxage property.
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_MAXSTALE
```
public static final java.lang.String ATTRIBUTE_MAXSTALE
```
    Indicates that the document is willing to use content that has exceeded its expiration time. If maxstale is assigned a value, then the document is willing to accept content that has exceeded its expiration time by no more than the specified number of seconds. This defaults to the audiomaxstale property.
    
    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
  - Choice
```
public Choice()
```
    Construct a new choice 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
  - getDtmf
```
public java.lang.String getDtmf()
```
    Retrieve the dtmf attribute.
    
    Returns:
    
    Value of the dtmf attribute.
    
    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
  - hasDtmf
```
public boolean hasDtmf()
```
    Checks if the DTMF attribute is set.
    
    Returns:
    
    true if the DTMF attribute is set
    
    Since:
    
    0.7.5
    
    See Also:
    
    ATTRIBUTE_DTMF
  - isAcceptSpecified
```
public boolean isAcceptSpecified()
```
    Checks if an accept attribute has been specified.
    
    Returns:
    
    true if an accept attribute has been specified.
    
    Since:
    
    0.7.5
  - 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
  - getNext
```
public java.lang.String getNext()
```
    Retrieve the next attribute.
    
    Returns:
    
    Value of the next attribute.
    
    See Also:
    
    ATTRIBUTE_NEXT
  - getNextUri
```
public java.net.URI getNextUri()
                        throws java.net.URISyntaxException
```
    Retrieve the next attribute.
    
    Returns:
    
    Value of the next attribute.
    
    Throws:
    
    java.net.URISyntaxException - if the attribute could not be converted into a valid URI
    
    See Also:
    
    ATTRIBUTE_NEXT
  - setNext
```
public void setNext(java.lang.String next)
```
    Sets the next attribute.
    
    Parameters:
    
    next - Value of the next attribute.
    
    See Also:
    
    ATTRIBUTE_NEXT
  - setNext
```
public void setNext(java.net.URI uri)
```
    Sets the next attribute.
    
    Parameters:
    
    uri - Value of the next attribute.
    
    See Also:
    
    ATTRIBUTE_NEXT
  - getExpr
```
public java.lang.String getExpr()
```
    Retrieve the expr attribute.
    
    Returns:
    
    Value of the expr attribute.
    
    See Also:
    
    ATTRIBUTE_EXPR
  - setExpr
```
public void setExpr(java.lang.String expr)
```
    Set the expr attribute.
    
    Parameters:
    
    expr - Value of the expr attribute.
    
    See Also:
    
    ATTRIBUTE_EXPR
  - getEvent
```
public java.lang.String getEvent()
```
    Retrieve the event attribute.
    
    Returns:
    
    Value of the event attribute.
    
    See Also:
    
    ATTRIBUTE_EVENT
  - setEvent
```
public void setEvent(java.lang.String event)
```
    Set the event attribute.
    
    Parameters:
    
    event - Value of the event attribute.
    
    See Also:
    
    ATTRIBUTE_EVENT
  - getEventexpr
```
public java.lang.String getEventexpr()
```
    Retrieve the eventexpr attribute.
    
    Returns:
    
    Value of the eventexpr attribute.
    
    See Also:
    
    ATTRIBUTE_EVENTEXPR
  - setEventexpr
```
public void setEventexpr(java.lang.String eventexpr)
```
    Set the eventexpr attribute.
    
    Parameters:
    
    eventexpr - Value of the eventexpr attribute.
    
    See Also:
    
    ATTRIBUTE_EVENTEXPR
  - getMessage
```
public java.lang.String getMessage()
```
    Retrieve the message attribute.
    
    Returns:
    
    Value of the message attribute.
    
    See Also:
    
    ATTRIBUTE_MESSAGE
  - setMessage
```
public void setMessage(java.lang.String message)
```
    Set the message attribute.
    
    Parameters:
    
    message - Value of the message attribute.
    
    See Also:
    
    ATTRIBUTE_MESSAGE
  - getMessageexpr
```
public java.lang.String getMessageexpr()
```
    Retrieve the messageexpr attribute.
    
    Returns:
    
    Value of the messageexpr attribute.
    
    See Also:
    
    ATTRIBUTE_MESSAGEEXPR
  - setMessageexpr
```
public void setMessageexpr(java.lang.String messageexpr)
```
    Set the messageexpr attribute.
    
    Parameters:
    
    messageexpr - Value of the messageexpr attribute.
    
    See Also:
    
    ATTRIBUTE_MESSAGEEXPR
  - getFetchaudio
```
public java.lang.String getFetchaudio()
```
    Retrieve the fetchaudio attribute.
    
    Returns:
    
    Value of the fetchaudio attribute.
    
    See Also:
    
    ATTRIBUTE_FETCHAUDIO
  - setFetchaudio
```
public void setFetchaudio(java.lang.String fetchaudio)
```
    Set the fetchaudio attribute.
    
    Parameters:
    
    fetchaudio - Value of the fetchaudio attribute.
    
    See Also:
    
    ATTRIBUTE_FETCHAUDIO
  - getFetchhint
```
public java.lang.String getFetchhint()
```
    Retrieve the fetchhint attribute.
    
    Returns:
    
    Value of the fetchhint attribute.
    
    See Also:
    
    ATTRIBUTE_FETCHHINT
  - setFetchhint
```
public void setFetchhint(java.lang.String fetchhint)
```
    Set the fetchhint attribute.
    
    Parameters:
    
    fetchhint - Value of the fetchhint attribute.
    
    See Also:
    
    ATTRIBUTE_FETCHHINT
  - getFetchtimeout
```
public java.lang.String getFetchtimeout()
```
    Retrieve the fetchtimeout attribute.
    
    Returns:
    
    Value of the fetchtimeout attribute.
    
    See Also:
    
    ATTRIBUTE_FETCHTIMEOUT
  - setFetchtimeout
```
public void setFetchtimeout(java.lang.String fetchtimeout)
```
    Set the fetchtimeout attribute.
    
    Parameters:
    
    fetchtimeout - Value of the fetchtimeout attribute.
    
    See Also:
    
    ATTRIBUTE_FETCHTIMEOUT
  - getMaxage
```
public java.lang.String getMaxage()
```
    Retrieve the maxage attribute.
    
    Returns:
    
    Value of the maxage attribute.
    
    See Also:
    
    ATTRIBUTE_MAXAGE
  - setMaxage
```
public void setMaxage(java.lang.String maxage)
```
    Set the maxage attribute.
    
    Parameters:
    
    maxage - Value of the maxage attribute.
    
    See Also:
    
    ATTRIBUTE_MAXAGE
  - getMaxstale
```
public java.lang.String getMaxstale()
```
    Retrieve the maxstale attribute.
    
    Returns:
    
    Value of the maxstale attribute.
    
    See Also:
    
    ATTRIBUTE_MAXSTALE
  - setMaxstale
```
public void setMaxstale(java.lang.String maxstale)
```
    Set the maxstale attribute.
    
    Parameters:
    
    maxstale - Value of the maxstale attribute.
    
    See Also:
    
    ATTRIBUTE_MAXSTALE
  - 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

Class Choice

Field Summary

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.jvoicexml.xml.AbstractXmlNode

Methods inherited from class java.lang.Object

Methods inherited from interface org.jvoicexml.xml.XmlNode

Methods inherited from interface org.w3c.dom.Node

Field Detail

TAG_NAME

ATTRIBUTE_DTMF

ATTRIBUTE_ACCEPT

ATTRIBUTE_NEXT

ATTRIBUTE_EXPR

ATTRIBUTE_EVENT

ATTRIBUTE_EVENTEXPR

ATTRIBUTE_MESSAGE

ATTRIBUTE_MESSAGEEXPR

ATTRIBUTE_FETCHAUDIO

ATTRIBUTE_FETCHTIMEOUT

ATTRIBUTE_FETCHHINT

ATTRIBUTE_MAXAGE

ATTRIBUTE_MAXSTALE

ATTRIBUTE_NAMES

Constructor Detail

Choice

Method Detail

getTagName

newInstance

getDtmf

setDtmf

hasDtmf

isAcceptSpecified

getAccept

getAcceptObject

setAccept

setAccept

getNext

getNextUri

setNext

setNext

getExpr

setExpr

getEvent

setEvent

getEventexpr

setEventexpr

getMessage

setMessage

getMessageexpr

setMessageexpr

getFetchaudio

setFetchaudio

getFetchhint

setFetchhint

getFetchtimeout

setFetchtimeout

getMaxage

setMaxage

getMaxstale

setMaxstale

addText

canContainChild

getAttributeNames