org.jvoicexml.xml.vxml

Class Script

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Script

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Script
extends AbstractXmlNode

Specify a block of ECMAScript client-side scripting logic.

A <script> element may occur in the <vxml> and <form> elements, or in executable content (in <filled>, <if>,<block>, <catch>, or the short forms of <catch>). Scripts in the <vxml> element are evaluated just after the document is loaded, along with the <var> elements, in document order. Scripts in the <form> element are evaluated in document order, along with <var> elements and form item variables, each time execution moves into the <form> element. A <script> element in executable content is executed, like other executable elements, as it is encountered.

See Also:

Form, Filled, Vxml, If, Block, Catch, Var

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_CHARSET The character encoding of the script designated by src.
static java.lang.String	ATTRIBUTE_FETCHHINT Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed.
static java.lang.String	ATTRIBUTE_FETCHTIMEOUT The interval to wait for the content to be returned before throwing an error.badfetch event.
static java.lang.String	ATTRIBUTE_MAXAGE Indicates that the document is willing to use content whose age is no greater than the specified time in seconds.
static java.lang.String	ATTRIBUTE_MAXSTALE Indicates that the document is willing to use content that has exceeded its expiration time.
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 script, if it is external.
static java.lang.String	ATTRIBUTE_SRCEXPR Equivalent to src, except that the URI is dynamically determined by evaluating the given ECMAScript expression.
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
Script() Construct a new script object without a node.

Method Summary

Modifier and Type	Method and Description
XmlCDataSection	addCdata(java.lang.String data) Create a new text within this node.
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	getCharset() Retrieve the charset attribute.
java.lang.String	getFetchhint() Retrieve the fetchhint 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.
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	setCharset(java.lang.String charset) Set the charset attribute.
void	setFetchhint(java.lang.String fetchhint) Set the fetchhint 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	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_SRC

public static final java.lang.String ATTRIBUTE_SRC

The URI specifying the location of the script, if it is external.

See Also:

Constant Field Values

ATTRIBUTE_CHARSET

public static final java.lang.String ATTRIBUTE_CHARSET

The character encoding of the script designated by src. UTF-8 and UTF-16 encodings of ISO/IEC 10646 must be supported (as in XML) and other encodings may be supported. The default value is UTF-8.

See Also:

Constant Field Values

ATTRIBUTE_FETCHTIMEOUT

public static final java.lang.String ATTRIBUTE_FETCHTIMEOUT

The interval to wait for the content to be returned before throwing an error.badfetch event. This defaults to the fetchtimeout property.

See Also:

Constant Field Values

ATTRIBUTE_FETCHHINT

public static final java.lang.String ATTRIBUTE_FETCHHINT

Defines when the interpreter context should retrieve content from the server. prefetch indicates a file may be downloaded when the page is loaded, whereas safe indicates a file that should only be downloaded when actually needed. This defaults to the audiofetchhint property.

See Also:

Constant Field Values

ATTRIBUTE_MAXAGE

public static final java.lang.String ATTRIBUTE_MAXAGE

Indicates that the document is willing to use content whose age is no greater than the specified time in seconds. The document is not willing to use stale content, unless maxstale is also provided. This defaults to the audiomaxage property.

See Also:

Constant Field Values

ATTRIBUTE_MAXSTALE

public static final java.lang.String ATTRIBUTE_MAXSTALE

Indicates that the document is willing to use content that has exceeded its expiration time. If maxstale is assigned a value, then the document is willing to accept content that has exceeded its expiration time by no more than the specified number of seconds. This defaults to the audiomaxstale property.

See Also:

Constant Field Values

ATTRIBUTE_SRCEXPR

public static final java.lang.String ATTRIBUTE_SRCEXPR

Equivalent to src, except that the URI is dynamically determined by evaluating the given ECMAScript expression. The expression must be evaluated each time the script needs to be executed. If srcexpr cannot be evaluated, an error.semantic event is thrown.

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

Script

public Script()

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

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 - Value of the src attribute.

See Also:

ATTRIBUTE_SRC

getCharset

public java.lang.String getCharset()

Retrieve the charset attribute.

Returns:

Value of the charset attribute.

See Also:

ATTRIBUTE_CHARSET

setCharset

public void setCharset(java.lang.String charset)

Set the charset attribute.

Parameters:

charset - Value of the charset attribute.

See Also:

ATTRIBUTE_CHARSET

getFetchhint

public java.lang.String getFetchhint()

Retrieve the fetchhint attribute.

Returns:

Value of the fetchhint attribute.

See Also:

ATTRIBUTE_FETCHHINT

setFetchhint

public void setFetchhint(java.lang.String fetchhint)

Set the fetchhint attribute.

Parameters:

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

getSrcexpr

public java.lang.String getSrcexpr()

Retrieve the srcexpr attribute.

Returns:

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

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.

addCdata

public XmlCDataSection addCdata(java.lang.String data)

Create a new text within this node.

Parameters:

data - The data to be added.

Returns:

The new created CDATA section.

Since:

0.6

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