org.jvoicexml.xml.vxml

Class Field

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Field

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Field
extends AbstractXmlNode

A <field> specifies an form input item to be gathered from the user.

See Also:

Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_COND An expression that must evaluate to true after conversion to boolean in order for the form item to be visited.
static java.lang.String	ATTRIBUTE_EXPR The initial value of the form item variable; default is ECMAScript undefined.
static java.lang.String	ATTRIBUTE_MODAL If this is false (the default) all active grammars are turned on while collecting this field.
static java.lang.String	ATTRIBUTE_NAME The form item variable in the dialog scope that will hold the result.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_SLOT The name of the grammar slot used to populate the variable (if it is absent, it defaults to the variable name).
static java.lang.String	ATTRIBUTE_TYPE The type of field, i.e., the name of a builtin grammar type.
static java.lang.String	TAG_NAME Name of the field 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
Field() Construct a new field object without a node.
Field(org.w3c.dom.Node node) Constructs a new field object.

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.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getCond() Retrieve the cond attribute.
java.lang.String	getExpr() Retrieve the expr attribute.
java.lang.String	getModal() Retrieve the modal attribute.
java.lang.String	getName() Retrieve the name attribute.
java.lang.String	getSlot() Retrieve the slot attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getType() Retrieve the type attribute.
boolean	isModal() Checks if this field is modal.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setCond(java.lang.String cond) Set the cond attribute.
void	setExpr(java.lang.String expr) Set the expr attribute.
void	setModal(boolean modal) Set the modal attribute.
void	setModal(java.lang.String modal) Set the modal attribute.
void	setName(java.lang.String name) Set the name attribute.
void	setSlot(java.lang.String slot) Set the slot attribute.
void	setType(java.lang.String type) Set the type 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 field tag.

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

The form item variable in the dialog scope that will hold the result.

See Also:

Constant Field Values

ATTRIBUTE_EXPR

public static final java.lang.String ATTRIBUTE_EXPR

The initial value of the form item variable; default is ECMAScript undefined. If initialized to a value, then the form item will not be visited unless the form item variable is cleared.

See Also:

Constant Field Values

ATTRIBUTE_COND

public static final java.lang.String ATTRIBUTE_COND

An expression that must evaluate to true after conversion to boolean in order for the form item to be visited. The form item can also be visited if the attribute is not specified.

See Also:

Constant Field Values

ATTRIBUTE_TYPE

public static final java.lang.String ATTRIBUTE_TYPE

The type of field, i.e., the name of a builtin grammar type. Platform support for builtin grammar types is optional. If the specified builtin type is not supported by the platform, an error.unsupported.builtin event is thrown.

See Also:

Constant Field Values

ATTRIBUTE_SLOT

public static final java.lang.String ATTRIBUTE_SLOT

The name of the grammar slot used to populate the variable (if it is absent, it defaults to the variable name). This attribute is useful in the case where the grammar format being used has a mechanism for returning sets of slot/value pairs and the slot names differ from the form item variable names.

See Also:

Constant Field Values

ATTRIBUTE_MODAL

public static final java.lang.String ATTRIBUTE_MODAL

If this is false (the default) all active grammars are turned on while collecting this field. If this is true, then only the field's grammars are enabled: all others are temporarily disabled.

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

Field

public Field()

Construct a new field object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Field

public Field(org.w3c.dom.Node node)

Constructs a new field object.

Parameters:

node - The encapsulated node.

Method Detail

getName

public java.lang.String getName()

Retrieve the name attribute.

Returns:

Value of the name attribute.

See Also:

ATTRIBUTE_NAME

setName

public void setName(java.lang.String name)

Set the name attribute.

Parameters:

name - Value of the name attribute.

See Also:

ATTRIBUTE_NAME

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

getCond

public java.lang.String getCond()

Retrieve the cond attribute.

Returns:

Value of the cond attribute.

See Also:

ATTRIBUTE_COND

setCond

public void setCond(java.lang.String cond)

Set the cond attribute.

Parameters:

cond - Value of the cond attribute.

See Also:

ATTRIBUTE_COND

getType

public java.lang.String getType()

Retrieve the type attribute.

Returns:

Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

setType

public void setType(java.lang.String type)

Set the type attribute.

Parameters:

type - Value of the type attribute.

See Also:

ATTRIBUTE_TYPE

getSlot

public java.lang.String getSlot()

Retrieve the slot attribute.

Returns:

Value of the slot attribute.

See Also:

ATTRIBUTE_SLOT

setSlot

public void setSlot(java.lang.String slot)

Set the slot attribute.

Parameters:

slot - Value of the slot attribute.

See Also:

ATTRIBUTE_SLOT

getModal

public java.lang.String getModal()

Retrieve the modal attribute.

Returns:

Value of the modal attribute.

See Also:

ATTRIBUTE_MODAL

isModal

public boolean isModal()

Checks if this field is modal.

Returns:

true if the field is modal.

Since:

0.6

setModal

public void setModal(java.lang.String modal)

Set the modal attribute.

Parameters:

modal - Value of the modal attribute.

See Also:

ATTRIBUTE_MODAL

setModal

public void setModal(boolean modal)

Set the modal attribute.

Parameters:

modal - Value of the modal attribute.

Since:

0.6

See Also:

ATTRIBUTE_MODAL

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

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