org.jvoicexml.xml.vxml
Class Form

java.lang.Object
  org.jvoicexml.xml.AbstractXmlNode
      org.jvoicexml.xml.vxml.Form

All Implemented Interfaces:

VoiceXmlNode, XmlNode, Node

public final class Form
extends AbstractXmlNode

Forms are the key concept of VoiceXML documents. A form contains

• A set of form items, elements that are visited in the main loop of the form interpretation algorithm. Form items are dubdevided into input items thatcan be 'filled' by user input and control items that cannot.
• Declaration of non-form item variables.
• Event handlers.
• "Filled" actions, block of procedural logic that execute when certain combinations of input item variables are assigned.

Version:

$Revision: 2325 $

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

Author:

Dirk Schnelle, Steve Doyle

See Also:

VoiceXmlDocument

Field Summary

static String	ATTRIBUTE_ID Name of the id attribute.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_SCOPE Name of the scope attribute.
static String	TAG_NAME Name of the form 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

Form()
Construct a new form object without a node.

Method Summary

protected boolean	canContainChild(String tagName) Can the specified sub-tag be contained within this node?
Field	createField() Create a new field.
Var	createVar() Create a new var.
Collection<String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
String	getId() Retrieve the id attribute.
String	getScope() Retrieve the scope attribute.
String	getTagName() Get the name of the tag for the derived node.
XmlNode	newInstance(Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setId(String id) Set the id attribute.
void	setScope(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, 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 String TAG_NAME

Name of the form tag.

See Also:

Constant Field Values

ATTRIBUTE_ID

public static final String ATTRIBUTE_ID

Name of the id attribute. The id is the name of the form. If specified, the form can be referenced within the document or from another document. For instance <form id="weather">, <goto next="#weather">.

See Also:

Constant Field Values

ATTRIBUTE_SCOPE

public static final String ATTRIBUTE_SCOPE

Name of the scope attribute. The default scope of the form's grammars are active only in the form. If the scope is document, then the form grammars are active during any dialog in the same document. If the scope is document and the document is an application root document then the form grammars are active during any dialog in any document of this application. Note that the scope of individual form grammars takes precedence over the default scope; for example, in non-root documents a form with the default scope dialog, and a form grammar with the scope document, then that grammar is active in any dialog in the document.

See Also:

Constant Field Values

ATTRIBUTE_NAMES

protected static final ArrayList<String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

Form

public Form()

Construct a new form object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Method Detail

createVar

public Var createVar()

Create a new var.

Returns:

The newly created var

createField

public Field createField()

Create a new field.

Returns:

The newly created field

getId

public String getId()

Retrieve the id attribute.

Returns:

Value of the id attribute.

See Also:

ATTRIBUTE_ID

setId

public void setId(String id)

Set the id attribute.

Parameters:

id - Value of the id attribute.

See Also:

ATTRIBUTE_ID

getScope

public String getScope()

Retrieve the scope attribute.

Returns:

Value of the scope attribute.

See Also:

ATTRIBUTE_SCOPE

setScope

public void setScope(String scope)

Set the scope attribute.

Parameters:

scope - Value of the id attribute.

See Also:

ATTRIBUTE_SCOPE

getTagName

public String getTagName()

Get the name of the tag for the derived node.

Returns:

name of the tag.

newInstance

public XmlNode newInstance(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

canContainChild

protected boolean canContainChild(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 Collection<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