org.jvoicexml.xml.ccxml
Class Goto

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.ccxml.CcxmlNode
          org.jvoicexml.xml.ccxml.Goto

All Implemented Interfaces:

XmlWritable, Node

public final class Goto
extends CcxmlNode

<fetch>, in conjunction with <goto>, is used to transfer execution to a different CCXML document in a multi-document CCXML application. The <fetch> tells the platform to find, load, and parse a given CCXML document. After the fetch completes, the CCXML application can then issue a <goto> to execute the now-fetched document.

Version:

$Revision: 1.4 $

Copyright © 2005 JVoiceXML group - http://jvoicexml.sourceforge.net/

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_FETCHID An ECMAScript expression which returns the fetch identifier of a completed fetch request acquired either in a fetch with the fetchid attribute, or from the fetchid attribute of a fetch.done event.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
private static Set<String>	CHILD_TAGS Valid child tags for this node.
static String	TAG_NAME Name of the tag.

Fields inherited from class org.jvoicexml.xml.XmlNode

node

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

Goto()
Construct a new goto object without a node.

Goto(Node node)
Construct a new goto object.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getFetchid() Retrieve the fetchid attribute.
String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(Node n) Create a new instance for the given node.
void	setFetchid(String fetchid) Set the fetchid attribute.

Methods inherited from class org.jvoicexml.xml.ccxml.CcxmlNode

getChildNodes, getFirstChild, getLastChild, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.jvoicexml.xml.XmlNode

addChild, appendChild, cloneNode, compareDocumentPosition, getAttribute, getAttributes, getBaseURI, getChildNodes, getFeature, getLocalName, getNamespaceURI, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getPrefix, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setAttribute, setNodeValue, setPrefix, setTextContent, setUserData, toString, writeChildrenXml, writeXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TAG_NAME

public static final String TAG_NAME

Name of the tag.

See Also:

Constant Field Values

ATTRIBUTE_FETCHID

public static final String ATTRIBUTE_FETCHID

An ECMAScript expression which returns the fetch identifier of a completed fetch request acquired either in a fetch with the fetchid attribute, or from the fetchid attribute of a fetch.done event. If the attribute value is invalid, an error.semantic event will be thrown.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

CHILD_TAGS

private static final Set<String> CHILD_TAGS

Valid child tags 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

Goto

Goto(Node node)

Construct a new goto object.

Parameters:

node - The encapsulated node.

Method Detail

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in class XmlNode

Returns:

name of the tag.

newInstance

public XmlNode newInstance(Node n)

Create a new instance for the given node.

Specified by:

newInstance in class XmlNode

Parameters:

n - The node to encapsulate.

Returns:

The new instance.

getFetchid

public String getFetchid()

Retrieve the fetchid attribute.

Returns:

Value of the fetchid attribute.

See Also:

ATTRIBUTE_FETCHID

setFetchid

public void setFetchid(String fetchid)

Set the fetchid attribute.

Parameters:

fetchid - Value of the fetchid attribute.

See Also:

ATTRIBUTE_FETCHID

canContainChild

protected boolean canContainChild(String tagName)

Can the specified sub-tag be contained within this node?

Specified by:

canContainChild in class XmlNode

Parameters:

tagName - Name of child.

Returns:

True if the sub-tag is allowed on this node.

getAttributeNames

public Collection<String> getAttributeNames()

Returns a collection of permitted attribute names for the node.

Overrides:

getAttributeNames in class XmlNode

Returns:

A collection of attribute names that are allowed for the node