org.jvoicexml.xml.vxml

Class Data

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Data

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Data
extends AbstractXmlNode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ENCTYPE The media encoding type of the submitted document.
static java.lang.String	ATTRIBUTE_FETCHAUDIO This defaults to the fetchaudio property.
static java.lang.String	ATTRIBUTE_FETCHHINT This defaults to the datafetchhint property.
static java.lang.String	ATTRIBUTE_FETCHTIMEOUT This defaults to the fetchtimeout property.
static java.lang.String	ATTRIBUTE_MAXAGE This defaults to the datamaxage property.
static java.lang.String	ATTRIBUTE_MAXSTALE This defaults to the datamaxstale property.
static java.lang.String	ATTRIBUTE_METHOD The request method: get (the default) or post.
static java.lang.String	ATTRIBUTE_NAME The name of the variable that exposes the DOM.
static java.lang.String	ATTRIBUTE_NAMELIST The list of variables to submit.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_SRC The URI specifying the location of the XML data to retrieve.
static java.lang.String	ATTRIBUTE_SRCEXPR Like src, except that the URI is dynamically determined by evaluating the given ECMAScript expression when the data needs to be fetched.
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
Data() Construct a new data 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	getEnctype() Retrieve the enctype attribute.
java.lang.String	getFetchaudio() Retrieve the fetchaudio attribute.
java.lang.String	getFetchint() Retrieve the fetchint 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.
RequestMethod	getMethod() Retrieve the method attribute.
java.lang.String	getMethodName() Retrieve the method attribute.
java.lang.String	getName() Retrieve the name attribute.
java.lang.String	getNamelist() Retrieve the namelist attribute.
TokenList	getNameListObject() Retrieve the namelist attribute as a list object.
java.lang.String	getSrc() Retrieve the src attribute.
java.lang.String	getSrcexpr() Retrieve the srcexpr attribute.
java.net.URI	getSrcUri() Retrieve the src 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	setEnctype(java.lang.String enctype) Set the enctype attribute.
void	setFetchaudio(java.lang.String fetchaudio) Set the fetchaudio attribute.
void	setFetchint(java.lang.String fetchint) Set the fetchint 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	setMethod(RequestMethod method) Set the method attribute.
void	setMethodName(java.lang.String method) Set the method attribute.
void	setName(java.lang.String name) Set the name attribute.
void	setNamelist(java.lang.String namelist) Set the namelist attribute.
void	setNameList(TokenList list) Set the namelist attribute.
void	setSrc(java.lang.String src) Set the src attribute.
void	setSrc(java.net.URI uri) Set the src attribute.
void	setSrcexpr(java.lang.String srcexpr) Set the srcexpr 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_NAME

public static final java.lang.String ATTRIBUTE_NAME

The name of the variable that exposes the DOM.

See Also:

Constant Field Values

ATTRIBUTE_SRC

public static final java.lang.String ATTRIBUTE_SRC

The URI specifying the location of the XML data to retrieve.

See Also:

Constant Field Values

ATTRIBUTE_SRCEXPR

public static final java.lang.String ATTRIBUTE_SRCEXPR

Like src, except that the URI is dynamically determined by evaluating the given ECMAScript expression when the data needs to be fetched. If srcexpr cannot be evaluated, an error.semantic event is thrown.

See Also:

Constant Field Values

ATTRIBUTE_FETCHAUDIO

public static final java.lang.String ATTRIBUTE_FETCHAUDIO

This defaults to the fetchaudio property.

See Also:

Constant Field Values

ATTRIBUTE_METHOD

public static final java.lang.String ATTRIBUTE_METHOD

The request method: get (the default) or post.

See Also:

Constant Field Values

ATTRIBUTE_ENCTYPE

public static final java.lang.String ATTRIBUTE_ENCTYPE

The media encoding type of the submitted document. The default is application/x-www-form-urlencoded. Interpreters must also support multipart/form-data and may support additional encoding types.

See Also:

Constant Field Values

ATTRIBUTE_NAMELIST

public static final java.lang.String ATTRIBUTE_NAMELIST

The list of variables to submit. By default, no variables are submitted. If a namelist is supplied, it may contain individual variable references which are submitted with the same qualification used in the namelist. Declared VoiceXML and ECMAScript variables can be referenced.

See Also:

Constant Field Values

ATTRIBUTE_FETCHHINT

public static final java.lang.String ATTRIBUTE_FETCHHINT

This defaults to the datafetchhint property.

See Also:

Constant Field Values

ATTRIBUTE_FETCHTIMEOUT

public static final java.lang.String ATTRIBUTE_FETCHTIMEOUT

This defaults to the fetchtimeout property.

See Also:

Constant Field Values

ATTRIBUTE_MAXAGE

public static final java.lang.String ATTRIBUTE_MAXAGE

This defaults to the datamaxage property.

See Also:

Constant Field Values

ATTRIBUTE_MAXSTALE

public static final java.lang.String ATTRIBUTE_MAXSTALE

This defaults to the datamaxstale 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

Data

public Data()

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

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

getSrc

public java.lang.String getSrc()

Retrieve the src attribute.

Returns:

Value of the src attribute.

See Also:

ATTRIBUTE_SRC

getSrcUri

public java.net.URI getSrcUri()
                       throws java.net.URISyntaxException

Retrieve the src attribute.

Returns:

Value of the src attribute.

Throws:

java.net.URISyntaxException - Src attribute does not denote a valid URI.

Since:

0.6

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(java.lang.String src)

Set the src attribute.

Parameters:

src - Value of the src attribute.

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(java.net.URI uri)

Set the src attribute.

Parameters:

uri - URI of the src attribute.

See Also:

ATTRIBUTE_SRC

getSrcexpr

public java.lang.String getSrcexpr()

Retrieve the srcexpr attribute.

Returns:

Value of the srcexpr attribute.

See Also:

ATTRIBUTE_SRCEXPR

setSrcexpr

public void setSrcexpr(java.lang.String srcexpr)

Set the srcexpr attribute.

Parameters:

srcexpr - Value of the srcexpr attribute.

See Also:

ATTRIBUTE_SRCEXPR

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

getMethodName

public java.lang.String getMethodName()

Retrieve the method attribute.

Returns:

Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

getMethod

public RequestMethod getMethod()

Retrieve the method attribute.

Returns:

Value of the method attribute.

Since:

0.7

See Also:

ATTRIBUTE_METHOD

setMethodName

public void setMethodName(java.lang.String method)

Set the method attribute.

Parameters:

method - Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

setMethod

public void setMethod(RequestMethod method)

Set the method attribute.

Parameters:

method - Value of the method attribute.

Since:

0.7

See Also:

ATTRIBUTE_METHOD

getEnctype

public java.lang.String getEnctype()

Retrieve the enctype attribute.

Returns:

Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

setEnctype

public void setEnctype(java.lang.String enctype)

Set the enctype attribute.

Parameters:

enctype - Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

getNamelist

public java.lang.String getNamelist()

Retrieve the namelist attribute.

Returns:

Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

setNamelist

public void setNamelist(java.lang.String namelist)

Set the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

getNameListObject

public TokenList getNameListObject()

Retrieve the namelist attribute as a list object.

Returns:

Value of the namelist attribute as a list.

Since:

0.7.1

See Also:

getNamelist()

setNameList

public void setNameList(TokenList list)

Set the namelist attribute.

Parameters:

list - Value of the namelist attribute.

Since:

0.7.1

See Also:

ATTRIBUTE_NAMELIST, setNamelist(String)

getFetchint

public java.lang.String getFetchint()

Retrieve the fetchint attribute.

Returns:

Value of the fetchint attribute.

See Also:

ATTRIBUTE_FETCHHINT

setFetchint

public void setFetchint(java.lang.String fetchint)

Set the fetchint attribute.

Parameters:

fetchint - Value of the fetchint 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