public final class Link extends AbstractXmlNode
A <link> element may have one or more grammars which are
scoped to the element containing the <link>. A "scope"
attribute on the element containing the <link> has no
effect on the scope of the <link> grammars (for example,
when a <link> is contained in a
<form> with scope="document", the
<link> grammars are scoped to the form, not to the
document). Grammar elements contained in the <link> are
not permitted to specify scope. When one of these grammars is matched, the
link activates, and either:
<goto>),
or<throw>).
The <link> element can be a child of
<vxml>,<form>, or of the form
items <field> and <initial>. A
link at the <vxml> level has grammars that are active
throughout the document. A link at the <form> level has
grammars active while the user is in that form. If an application root
document has a document-level link, its grammars are active no matter what
document of the application is being executed.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ATTRIBUTE_DTMF
The DTMF sequence for this link.
|
static java.lang.String |
ATTRIBUTE_EVENT
The event to throw when the user matches one of the link grammars.
|
static java.lang.String |
ATTRIBUTE_EVENTEXPR
An ECMAScript expression evaluating to the name of the event to throw
when the user matches one of the link grammars.
|
static java.lang.String |
ATTRIBUTE_EXPR
Like next, except that the URI is dynamically determined by evaluating
the given ECMAScript expression.
|
static java.lang.String |
ATTRIBUTE_FETCHAUDIO
The URI of the audio clip to play while the fetch is being done.
|
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_MESSAGE
A message string providing additional context about the event being
thrown.
|
static java.lang.String |
ATTRIBUTE_MESSAGEEXPR
An ECMAScript expression evaluating to the message string.
|
protected static java.util.ArrayList<java.lang.String> |
ATTRIBUTE_NAMES
Supported attribute names for this node.
|
static java.lang.String |
ATTRIBUTE_NEXT
The URI to go to.
|
static java.lang.String |
TAG_NAME
Name of the tag.
|
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 and Description |
|---|
Link()
Construct a new link object without a node.
|
| 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 |
getDtmf()
Retrieve the dtmf attribute.
|
java.lang.String |
getEvent()
Retrieve the event attribute.
|
java.lang.String |
getEventexpr()
Retrieve the eventexpr attribute.
|
java.lang.String |
getExpr()
Retrieve the expr attribute.
|
java.lang.String |
getFetchaudio()
Retrieve the fetchaudio 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 |
getMessage()
Retrieve the message attribute.
|
java.lang.String |
getMessageexpr()
Retrieve the messageexpr attribute.
|
java.lang.String |
getNext()
Retrieve the next 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 |
setDtmf(java.lang.String dtmf)
Set the dtmf attribute.
|
void |
setEvent(java.lang.String event)
Set the event attribute.
|
void |
setEventexpr(java.lang.String eventexpr)
Set the eventexpr attribute.
|
void |
setExpr(java.lang.String expr)
Set the expr attribute.
|
void |
setFetchaudio(java.lang.String fetchaudio)
Set the fetchaudio 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 |
setMessage(java.lang.String message)
Set the message attribute.
|
void |
setMessageexpr(java.lang.String messageexpr)
Set the messageexpr attribute.
|
void |
setNext(java.lang.String next)
Set the next attribute.
|
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, toStringclone, finalize, getClass, notify, notifyAll, wait, wait, waitaddChild, getAttribute, getChildNodes, getChildren, getNode, setAttributeappendChild, 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, setUserDatapublic static final java.lang.String TAG_NAME
public static final java.lang.String ATTRIBUTE_NEXT
public static final java.lang.String ATTRIBUTE_EXPR
public static final java.lang.String ATTRIBUTE_EVENT
public static final java.lang.String ATTRIBUTE_EVENTEXPR
public static final java.lang.String ATTRIBUTE_MESSAGE
public static final java.lang.String ATTRIBUTE_MESSAGEEXPR
public static final java.lang.String ATTRIBUTE_DTMF
<grammar> and DTMF properties apply to recognition
of the sequence. Unlike DTMF grammars, whitespace is optional:
dtmf="123#" is equivalent to dtmf="1 2 3 #". The attribute can be used
at the same time as other <grammar>s: the link is
activated when user input matches a link grammar or the DTMF sequence.public static final java.lang.String ATTRIBUTE_FETCHAUDIO
public static final java.lang.String ATTRIBUTE_FETCHTIMEOUT
public static final java.lang.String ATTRIBUTE_FETCHHINT
public static final java.lang.String ATTRIBUTE_MAXAGE
public static final java.lang.String ATTRIBUTE_MAXSTALE
protected static final java.util.ArrayList<java.lang.String> ATTRIBUTE_NAMES
public Link()
This is necessary for the node factory.
VoiceXmlNodeFactorypublic java.lang.String getTagName()
public XmlNode newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory)
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.
n - The node to encapsulate.factory - the factroy that calls this method.XmlNodeFactorypublic java.lang.String getNext()
ATTRIBUTE_NEXTpublic void setNext(java.lang.String next)
next - Value of the next attribute.ATTRIBUTE_NEXTpublic java.lang.String getExpr()
ATTRIBUTE_EXPRpublic void setExpr(java.lang.String expr)
expr - Value of the expr attribute.ATTRIBUTE_EXPRpublic java.lang.String getEvent()
ATTRIBUTE_EVENTpublic void setEvent(java.lang.String event)
event - Value of the event attribute.ATTRIBUTE_EVENTpublic java.lang.String getEventexpr()
ATTRIBUTE_EVENTEXPRpublic void setEventexpr(java.lang.String eventexpr)
eventexpr - Value of the eventexpr attribute.ATTRIBUTE_EVENTEXPRpublic java.lang.String getMessage()
ATTRIBUTE_MESSAGEpublic void setMessage(java.lang.String message)
message - Value of the message attribute.ATTRIBUTE_MESSAGEpublic java.lang.String getMessageexpr()
ATTRIBUTE_MESSAGEEXPRpublic void setMessageexpr(java.lang.String messageexpr)
messageexpr - Value of the messageexpr attribute.ATTRIBUTE_MESSAGEEXPRpublic java.lang.String getDtmf()
ATTRIBUTE_DTMFpublic void setDtmf(java.lang.String dtmf)
dtmf - Value of the dtmf attribute.ATTRIBUTE_DTMFpublic java.lang.String getFetchaudio()
ATTRIBUTE_FETCHAUDIOpublic void setFetchaudio(java.lang.String fetchaudio)
fetchaudio - Value of the fetchaudio attribute.ATTRIBUTE_FETCHAUDIOpublic java.lang.String getFetchhint()
ATTRIBUTE_FETCHHINTpublic void setFetchhint(java.lang.String fetchhint)
fetchhint - Value of the fetchhint attribute.ATTRIBUTE_FETCHHINTpublic java.lang.String getFetchtimeout()
ATTRIBUTE_FETCHTIMEOUTpublic void setFetchtimeout(java.lang.String fetchtimeout)
fetchtimeout - Value of the fetchtimeout attribute.ATTRIBUTE_FETCHTIMEOUTpublic java.lang.String getMaxage()
ATTRIBUTE_MAXAGEpublic void setMaxage(java.lang.String maxage)
maxage - Value of the maxage attribute.ATTRIBUTE_MAXAGEpublic java.lang.String getMaxstale()
ATTRIBUTE_MAXSTALEpublic void setMaxstale(java.lang.String maxstale)
maxstale - Value of the maxstale attribute.ATTRIBUTE_MAXSTALEprotected boolean canContainChild(java.lang.String tagName)
canContainChild in class AbstractXmlNodetagName - Name of child.public java.util.Collection<java.lang.String> getAttributeNames()
getAttributeNames in interface XmlNodegetAttributeNames in class AbstractXmlNode