org.jvoicexml.xml.vxml

Class ObjectTag

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.ObjectTag

All Implemented Interfaces:

VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class ObjectTag
extends AbstractXmlNode

Interact with a custom extension.

A VoiceXML implementation platform may expose platform-specific functionality for use by a VoiceXML application via the <object> element. The <object> element makes direct use of its own content during initialization (e.g. <param> child element) and execution. As a result, <object> content cannot be treated as alternative content. Notice that like other input items, <object> has prompts and catch elements. It may also have <filled> actions.

See Also:

Filled, Param

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_ARCHIVE A space-separated list of URIs for archives containing resources relevant to the object, which may include the resources specified by the classid and data attributes.
static java.lang.String	ATTRIBUTE_CLASSID The URI specifying the location of the object's implementation.
static java.lang.String	ATTRIBUTE_CODEBASE The base path used to resolve relative URIs specified by classid, data, and archive.
static java.lang.String	ATTRIBUTE_CODETYPE The content type of data expected when downloading the object specified by classid.
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_DATA The URI specifying the location of the object's data.
static java.lang.String	ATTRIBUTE_EXPR The initial value of the form item variable; default is ECMAScript undefined.
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.
static java.lang.String	ATTRIBUTE_NAME When the object is evaluated, it sets this variable to an ECMAScript value whose type is defined by the object.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_TYPE The content type of the data specified by the data attribute.
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
ObjectTag() Construct a new object object without a node.

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.lang.String	getArchive() Retrieve the archive attribute.
java.util.Collection<java.net.URI>	getArchiveUris() Retrieves the URIs of the archive attribute.
java.util.Collection<java.lang.String>	getAttributeNames() Returns a collection of permitted attribute names for the node.
java.lang.String	getClassid() Retrieve the classid attribute.
java.net.URI	getClassidUri() Retrieves the classid attribute as an URI.
java.lang.String	getCodebase() Retrieve the codebase attribute.
java.lang.String	getCodetype() Retrieve the codetype attribute.
java.lang.String	getCond() Retrieve the cond attribute.
java.lang.String	getData() Retrieve the data attribute.
java.net.URI	getDataUri() Retrieve the data attribute.
java.lang.String	getExpr() Retrieve the expr 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	getName() Retrieve the name attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getType() Retrieve the type attribute.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setArchive(java.util.Collection<java.net.URI> uris) Sets the archive URIs.
void	setArchive(java.lang.String archive) Set the archive attribute.
void	setClassid(java.lang.Class<?> classid) Set the classid attribute to method://" + classid.getName().
void	setClassid(java.lang.Class<?> classid, java.lang.String method) Set the classid attribute to method://" + classid.getName() if the method name is null and to method://" + classid.getName() + "#" + method if a method is specified.
void	setClassid(java.lang.String classid) Set the classid attribute.
void	setClassid(java.net.URI classid) Set the classid attribute.
void	setCodebase(java.lang.String codebase) Set the codebase attribute.
void	setCodetype(java.lang.String codetype) Set the codetype attribute.
void	setCond(java.lang.String cond) Set the cond attribute.
void	setData(java.lang.String data) Set the data attribute.
void	setData(java.net.URI data) Set the data attribute.
void	setExpr(java.lang.String expr) Set the expr 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	setName(java.lang.String name) Set the name 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 tag.

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

When the object is evaluated, it sets this variable to an ECMAScript value whose type is defined by the object.

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.

See Also:

Constant Field Values

ATTRIBUTE_CLASSID

public static final java.lang.String ATTRIBUTE_CLASSID

The URI specifying the location of the object's implementation. The URI conventions are platform-dependent.

See Also:

Constant Field Values

ATTRIBUTE_CODEBASE

public static final java.lang.String ATTRIBUTE_CODEBASE

The base path used to resolve relative URIs specified by classid, data, and archive. It defaults to the base URI of the current document.

See Also:

Constant Field Values

ATTRIBUTE_CODETYPE

public static final java.lang.String ATTRIBUTE_CODETYPE

The content type of data expected when downloading the object specified by classid. When absent it defaults to the value of the type attribute.

See Also:

Constant Field Values

ATTRIBUTE_DATA

public static final java.lang.String ATTRIBUTE_DATA

The URI specifying the location of the object's data. If it is a relative URI, it is interpreted relative to the codebase attribute.

See Also:

Constant Field Values

ATTRIBUTE_TYPE

public static final java.lang.String ATTRIBUTE_TYPE

The content type of the data specified by the data attribute.

See Also:

Constant Field Values

ATTRIBUTE_ARCHIVE

public static final java.lang.String ATTRIBUTE_ARCHIVE

A space-separated list of URIs for archives containing resources relevant to the object, which may include the resources specified by the classid and data attributes. URIs which are relative are interpreted relative to the codebase attribute.

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_NAMES

protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES

Supported attribute names for this node.

Constructor Detail

ObjectTag

public ObjectTag()

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

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

getClassid

public java.lang.String getClassid()

Retrieve the classid attribute.

Returns:

Value of the classid attribute.

See Also:

ATTRIBUTE_CLASSID

getClassidUri

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

Retrieves the classid attribute as an URI.

Returns:

Value of the classid attribute.

Throws:

java.net.URISyntaxException - Value is not a valid URI.

Since:

0.6

See Also:

ATTRIBUTE_CLASSID

setClassid

public void setClassid(java.lang.String classid)

Set the classid attribute.

Parameters:

classid - Value of the classid attribute.

See Also:

ATTRIBUTE_CLASSID

setClassid

public void setClassid(java.lang.Class<?> classid)

Set the classid attribute to method://" + classid.getName().

Parameters:

classid - Class to call.

Since:

0.6

See Also:

ATTRIBUTE_CLASSID

setClassid

public void setClassid(java.lang.Class<?> classid,
                       java.lang.String method)

Set the classid attribute to method://" + classid.getName() if the method name is null and to method://" + classid.getName() + "#" + method if a method is specified.

Parameters:

classid - Class to call.

method - name of the method to call.

Since:

0.6

See Also:

ATTRIBUTE_CLASSID

setClassid

public void setClassid(java.net.URI classid)

Set the classid attribute.

Parameters:

classid - Value of the classid attribute.

Since:

0.6

See Also:

ATTRIBUTE_CLASSID

getCodebase

public java.lang.String getCodebase()

Retrieve the codebase attribute.

Returns:

Value of the codebase attribute.

See Also:

ATTRIBUTE_CODEBASE

setCodebase

public void setCodebase(java.lang.String codebase)

Set the codebase attribute.

Parameters:

codebase - Value of the codebase attribute.

See Also:

ATTRIBUTE_CODEBASE

getCodetype

public java.lang.String getCodetype()

Retrieve the codetype attribute.

Returns:

Value of the codetype attribute.

See Also:

ATTRIBUTE_CODETYPE

setCodetype

public void setCodetype(java.lang.String codetype)

Set the codetype attribute.

Parameters:

codetype - Value of the codetype attribute.

See Also:

ATTRIBUTE_CODETYPE

getData

public java.lang.String getData()

Retrieve the data attribute.

Returns:

Value of the data attribute.

See Also:

ATTRIBUTE_DATA

getDataUri

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

Retrieve the data attribute.

Returns:

Value of the data attribute.

Throws:

java.net.URISyntaxException - The data does not denote a valid URI.

See Also:

ATTRIBUTE_DATA

setData

public void setData(java.lang.String data)

Set the data attribute.

Parameters:

data - Value of the data attribute.

See Also:

ATTRIBUTE_DATA

setData

public void setData(java.net.URI data)

Set the data attribute.

Parameters:

data - Value of the data attribute.

See Also:

ATTRIBUTE_DATA

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

getArchive

public java.lang.String getArchive()

Retrieve the archive attribute.

Returns:

Value of the archive attribute.

See Also:

ATTRIBUTE_ARCHIVE

getArchiveUris

public java.util.Collection<java.net.URI> getArchiveUris()
                                                  throws java.net.URISyntaxException

Retrieves the URIs of the archive attribute.

Returns:

URIs of the archive attributes, null if there are no URIs defined.

Throws:

java.net.URISyntaxException - if one of the entries is no valid URI.

Since:

0.7.3

setArchive

public void setArchive(java.lang.String archive)

Set the archive attribute.

Parameters:

archive - Value of the archive attribute.

See Also:

ATTRIBUTE_ARCHIVE

setArchive

public void setArchive(java.util.Collection<java.net.URI> uris)

Sets the archive URIs.

Parameters:

uris - archive UIRs.

Since:

0.7.3

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

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