org.jvoicexml.xml.vxml
Class Data

java.lang.Object
  org.jvoicexml.xml.XmlNode
      org.jvoicexml.xml.vxml.VoiceXmlNode
          org.jvoicexml.xml.vxml.Data

All Implemented Interfaces:

XmlWritable, Node

public final class Data
extends VoiceXmlNode

Version:

$Revision: 1.5 $

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

Author:

Steve Doyle

Field Summary

static String	ATTRIBUTE_ENCTYPE The media encoding type of the submitted document.
static String	ATTRIBUTE_FETCHAUDIO This defaults to the fetchaudio property.
static String	ATTRIBUTE_FETCHINT This defaults to the datafetchhint property.
static String	ATTRIBUTE_FETCHTIMEOUT This defaults to the fetchtimeout property.
static String	ATTRIBUTE_MAXAGE This defaults to the datamaxage property.
static String	ATTRIBUTE_MAXSTALE This defaults to the datamaxstale property.
static String	ATTRIBUTE_METHOD The request method: get (the default) or post.
static String	ATTRIBUTE_NAME The name of the variable that exposes the DOM.
static String	ATTRIBUTE_NAMELIST The list of variables to submit.
protected static ArrayList<String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static String	ATTRIBUTE_SRC The URI specifying the location of the XML data to retrieve.
static 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.
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

Data()
Construct a new data object without a node.

Data(Node node)
Construct a new data 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	getEnctype() Retrieve the enctype attribute.
String	getFetchaudio() Retrieve the fetchaudio attribute.
String	getFetchint() Retrieve the fetchint attribute.
String	getFetchtimeout() Retrieve the fetchtimeout attribute.
String	getMaxage() Retrieve the maxage attribute.
String	getMaxstale() Retrieve the maxstale attribute.
String	getMethod() Retrieve the method attribute.
String	getName() Retrieve the name attribute.
String	getNamelist() Retrieve the namelist attribute.
String	getSrc() Retrieve the src attribute.
String	getSrcexpr() Retrieve the srcexpr 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	setEnctype(String enctype) Set the enctype attribute.
void	setFetchaudio(String fetchaudio) Set the fetchaudio attribute.
void	setFetchint(String fetchint) Set the fetchint attribute.
void	setFetchtimeout(String fetchtimeout) Set the fetchtimeout attribute.
void	setMaxage(String maxage) Set the maxage attribute.
void	setMaxstale(String maxstale) Set the maxstale attribute.
void	setMethod(String method) Set the method attribute.
void	setName(String name) Set the name attribute.
void	setNamelist(String namelist) Set the namelist attribute.
void	setSrc(String src) Set the src attribute.
void	setSrcexpr(String srcexpr) Set the srcexpr attribute.

Methods inherited from class org.jvoicexml.xml.vxml.VoiceXmlNode

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_NAME

public static final String ATTRIBUTE_NAME

The name of the variable that exposes the DOM.

See Also:

Constant Field Values

ATTRIBUTE_SRC

public static final String ATTRIBUTE_SRC

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

See Also:

Constant Field Values

ATTRIBUTE_SRCEXPR

public static final 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 String ATTRIBUTE_FETCHAUDIO

This defaults to the fetchaudio property.

See Also:

Constant Field Values

ATTRIBUTE_METHOD

public static final String ATTRIBUTE_METHOD

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

See Also:

Constant Field Values

ATTRIBUTE_ENCTYPE

public static final 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 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_FETCHINT

public static final String ATTRIBUTE_FETCHINT

This defaults to the datafetchhint property.

See Also:

Constant Field Values

ATTRIBUTE_FETCHTIMEOUT

public static final String ATTRIBUTE_FETCHTIMEOUT

This defaults to the fetchtimeout property.

See Also:

Constant Field Values

ATTRIBUTE_MAXAGE

public static final String ATTRIBUTE_MAXAGE

This defaults to the datamaxage property.

See Also:

Constant Field Values

ATTRIBUTE_MAXSTALE

public static final String ATTRIBUTE_MAXSTALE

This defaults to the datamaxstale property.

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

Data

public Data()

Construct a new data object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Data

Data(Node node)

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

getName

public String getName()

Retrieve the name attribute.

Returns:

Value of the name attribute.

See Also:

ATTRIBUTE_NAME

setName

public void setName(String name)

Set the name attribute.

Parameters:

name - Value of the name attribute.

See Also:

ATTRIBUTE_NAME

getSrc

public String getSrc()

Retrieve the src attribute.

Returns:

Value of the src attribute.

See Also:

ATTRIBUTE_SRC

setSrc

public void setSrc(String src)

Set the src attribute.

Parameters:

src - Value of the src attribute.

See Also:

ATTRIBUTE_SRC

getSrcexpr

public String getSrcexpr()

Retrieve the srcexpr attribute.

Returns:

Value of the srcexpr attribute.

See Also:

ATTRIBUTE_SRCEXPR

setSrcexpr

public void setSrcexpr(String srcexpr)

Set the srcexpr attribute.

Parameters:

srcexpr - Value of the srcexpr attribute.

See Also:

ATTRIBUTE_SRCEXPR

getFetchaudio

public String getFetchaudio()

Retrieve the fetchaudio attribute.

Returns:

Value of the fetchaudio attribute.

See Also:

ATTRIBUTE_FETCHAUDIO

setFetchaudio

public void setFetchaudio(String fetchaudio)

Set the fetchaudio attribute.

Parameters:

fetchaudio - Value of the fetchaudio attribute.

See Also:

ATTRIBUTE_FETCHAUDIO

getMethod

public String getMethod()

Retrieve the method attribute.

Returns:

Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

setMethod

public void setMethod(String method)

Set the method attribute.

Parameters:

method - Value of the method attribute.

See Also:

ATTRIBUTE_METHOD

getEnctype

public String getEnctype()

Retrieve the enctype attribute.

Returns:

Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

setEnctype

public void setEnctype(String enctype)

Set the enctype attribute.

Parameters:

enctype - Value of the enctype attribute.

See Also:

ATTRIBUTE_ENCTYPE

getNamelist

public String getNamelist()

Retrieve the namelist attribute.

Returns:

Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

setNamelist

public void setNamelist(String namelist)

Set the namelist attribute.

Parameters:

namelist - Value of the namelist attribute.

See Also:

ATTRIBUTE_NAMELIST

getFetchint

public String getFetchint()

Retrieve the fetchint attribute.

Returns:

Value of the fetchint attribute.

See Also:

ATTRIBUTE_FETCHINT

setFetchint

public void setFetchint(String fetchint)

Set the fetchint attribute.

Parameters:

fetchint - Value of the fetchint attribute.

See Also:

ATTRIBUTE_FETCHINT

getFetchtimeout

public String getFetchtimeout()

Retrieve the fetchtimeout attribute.

Returns:

Value of the fetchtimeout attribute.

See Also:

ATTRIBUTE_FETCHTIMEOUT

setFetchtimeout

public void setFetchtimeout(String fetchtimeout)

Set the fetchtimeout attribute.

Parameters:

fetchtimeout - Value of the fetchtimeout attribute.

See Also:

ATTRIBUTE_FETCHTIMEOUT

getMaxage

public String getMaxage()

Retrieve the maxage attribute.

Returns:

Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

setMaxage

public void setMaxage(String maxage)

Set the maxage attribute.

Parameters:

maxage - Value of the maxage attribute.

See Also:

ATTRIBUTE_MAXAGE

getMaxstale

public String getMaxstale()

Retrieve the maxstale attribute.

Returns:

Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

setMaxstale

public void setMaxstale(String maxstale)

Set the maxstale attribute.

Parameters:

maxstale - Value of the maxstale attribute.

See Also:

ATTRIBUTE_MAXSTALE

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