org.jvoicexml.xml.vxml

Class Goto

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Goto

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Goto
extends AbstractXmlNode

Go to another dialog in the same or different document.

The <goto> element is used to:

• transition to another form item in the current form,
• transition to another dialog in the current document, or
• transition to another document.

To transition to another form item, use the nextitem attribute, or the expritem attribute if the form item name is computed using an ECMAScript expression:

<goto nextitem="ssn_confirm"/>
<goto expritem="(type==12)? 'ssn_confirm' : 'reject'"/>

To go to another dialog in the same document, use next (or expr) with only a URI fragment:

<goto next="#another_dialog"/>
<goto expr="'#' + 'another_dialog'"/>

To transition to another document, use next (or expr) with a URI:

<goto next="http://flight.example.com/reserve_seat"/>
<goto next="./special_lunch#wants_vegan"/>

The URI may be absolute or relative to the current document. You may specify the starting dialog in the next document using a fragment that corresponds to the value of the id attribute of a dialog. If no fragment is specified, the first dialog in that document is chosen.

See Also:

Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_EXPR An ECMAScript expression that yields the URI.
static java.lang.String	ATTRIBUTE_EXPRITEM An ECMAScript expression that yields the name of the next form item to visit.
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.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_NEXT The URI to which to transition.
static java.lang.String	ATTRIBUTE_NEXTITEM The name of the next form item to visit in the current form.
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
Goto() Construct a new goto object without a node.

Method Summary

Modifier and Type	Method and Description
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	getExpr() Retrieve the expr attribute.
java.lang.String	getExpritem() Retrieve the expritem 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	getNext() Retrieve the next attribute.
java.lang.String	getNextitem() Retrieve the nextitem attribute.
java.net.URI	getNextUri() Retrieve the next 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	setExpr(java.lang.String expr) Set the expr attribute.
void	setExpritem(java.lang.String expritem) Set the expritem 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	setNext(java.lang.String next) Set the next attribute.
void	setNext(java.net.URI uri) Set the next attribute.
void	setNextitem(java.lang.String nextitem) Set the nextitem 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_NEXT

public static final java.lang.String ATTRIBUTE_NEXT

The URI to which to transition.

See Also:

Constant Field Values

ATTRIBUTE_EXPR

public static final java.lang.String ATTRIBUTE_EXPR

An ECMAScript expression that yields the URI.

See Also:

Constant Field Values

ATTRIBUTE_NEXTITEM

public static final java.lang.String ATTRIBUTE_NEXTITEM

The name of the next form item to visit in the current form.

See Also:

Constant Field Values

ATTRIBUTE_EXPRITEM

public static final java.lang.String ATTRIBUTE_EXPRITEM

An ECMAScript expression that yields the name of the next form item to visit.

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

Goto

public Goto()

Construct a new goto 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

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)

Set the next attribute.

Parameters:

next - Value of the next attribute.

See Also:

ATTRIBUTE_NEXT

setNext

public void setNext(java.net.URI uri)

Set 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

getNextitem

public java.lang.String getNextitem()

Retrieve the nextitem attribute.

Returns:

Value of the nextitem attribute.

See Also:

ATTRIBUTE_NEXTITEM

setNextitem

public void setNextitem(java.lang.String nextitem)

Set the nextitem attribute.

Parameters:

nextitem - Value of the nextitem attribute.

See Also:

ATTRIBUTE_NEXTITEM

getExpritem

public java.lang.String getExpritem()

Retrieve the expritem attribute.

Returns:

Value of the expritem attribute.

See Also:

ATTRIBUTE_EXPRITEM

setExpritem

public void setExpritem(java.lang.String expritem)

Set the expritem attribute.

Parameters:

expritem - Value of the expritem attribute.

See Also:

ATTRIBUTE_EXPRITEM

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

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