org.jvoicexml.xml.vxml

Class Prompt

java.lang.Object

org.jvoicexml.xml.AbstractXmlNode

org.jvoicexml.xml.vxml.Prompt

All Implemented Interfaces:

TextContainer, VoiceXmlNode, XmlNode, org.w3c.dom.Node

public final class Prompt
extends AbstractXmlNode
implements TextContainer

A <prompt> element controls the output of synthesized speech and prerecorded audio. Conceptually, prompts are instaneously queued for play, so interpretation proceeds until the user needs to provide an input. At this point, the prompts are played, and the system waits for user input. Once the input is received from the speech recognition subsystem (or the DTMF recognizer), interpretation proceeds.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_BARGEIN Control whether the user can interrupt a prompt.
static java.lang.String	ATTRIBUTE_BARGEINTYPE Sets the type of bargein to be BARGEIN_TYPE_SPEECH or BARGEIN_TYPE_HOTWORD.
static java.lang.String	ATTRIBUTE_COND An expression that must evaluate to true after conversion to boolean in order for the prompt to be played.
static java.lang.String	ATTRIBUTE_COUNT A number that allows you to emit different prompts if the user is doing something repeatedly.
protected static java.util.ArrayList<java.lang.String>	ATTRIBUTE_NAMES Supported attribute names for this node.
static java.lang.String	ATTRIBUTE_TIMEOUT The timeout that will be used for the following user input.
static java.lang.String	ATTRIBUTE_XML_BASE Declares the base URI from which relative URIs in the prompt are resloved.
static java.lang.String	ATTRIBUTE_XML_LANG The laanguage identifier for the prompt.
static java.lang.String	TAG_NAME Name of the prompt 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
Prompt() Construct a new prompt object without a node.

Method Summary

Modifier and Type	Method and Description
Text	addText(java.lang.String text) Creates a new text within this prompt.
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	getBargein() Retrieve the bargein attribute.
BargeInType	getBargeintype() Retrieve the bargeintype attribute.
java.lang.String	getBargeintypeName() Retrieve the bargeintype attribute.
java.lang.String	getCond() Retrieve the cond attribute.
java.lang.String	getCount() Retrieve the count attribute.
int	getCountAsInt() Retrieve the count attribute.
java.lang.String	getTagName() Get the name of the tag for the derived node.
java.lang.String	getTimeout() Retrieve the timeout attribute.
long	getTimeoutAsMsec() Retrieves the timeout attribute as msec.
java.lang.String	getXmlBase() Retrieve the xml:base attribute.
java.net.URI	getXmlBaseUri() Retrieves the xml:base attribute as an URI.
java.lang.String	getXmlLang() Retrieve the xml:lang attribute.
java.util.Locale	getXmlLangObject() Retrieve the xml:lang attribute.
boolean	isBargein() Checks if barge-in is enabled.
XmlNode	newInstance(org.w3c.dom.Node n, XmlNodeFactory<? extends XmlNode> factory) Create a new instance for the given node.
void	setBargein(boolean bargein) Set the bargein attribute.
void	setBargein(java.lang.String bargein) Set the bargein attribute.
void	setBargeintype(BargeInType bargeintype) Set the bargeintype attribute.
void	setBargeintype(java.lang.String bargeintype) Set the bargeintype attribute.
void	setCond(java.lang.String cond) Set the cond attribute.
void	setCount(int count) Set the count attribute.
void	setCount(java.lang.String count) Set the count attribute.
void	setTimeout(java.lang.String timeout) Set the timeout attribute.
void	setXmlBase(java.lang.String xmlBase) Set the xml:base attribute.
void	setXmlBase(java.net.URI xmlBase) Sets the xml:base attribute.
void	setXmlLang(java.util.Locale locale) Set the xml:lang attribute.
void	setXmlLang(java.lang.String xmlLang) Set the xml:lang 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.TextContainer

getNodeFactory

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 prompt tag.

See Also:

Constant Field Values

ATTRIBUTE_BARGEIN

public static final java.lang.String ATTRIBUTE_BARGEIN

Control whether the user can interrupt a prompt. This defaults to the value of the bargein property.

See Also:

Constant Field Values

ATTRIBUTE_BARGEINTYPE

public static final java.lang.String ATTRIBUTE_BARGEINTYPE

Sets the type of bargein to be BARGEIN_TYPE_SPEECH or BARGEIN_TYPE_HOTWORD. This defaults to the value of the bargein property.

See Also:

BargeInType.SPEECH, BargeInType.HOTWORD, 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 prompt to be played. Default is true.

See Also:

Constant Field Values

ATTRIBUTE_COUNT

public static final java.lang.String ATTRIBUTE_COUNT

A number that allows you to emit different prompts if the user is doing something repeatedly. If omitted, it defaults to 1.

See Also:

Constant Field Values

ATTRIBUTE_TIMEOUT

public static final java.lang.String ATTRIBUTE_TIMEOUT

The timeout that will be used for the following user input. The default is a Time Designation. The default noinput timeout is platform specific.

See Also:

Constant Field Values

ATTRIBUTE_XML_LANG

public static final java.lang.String ATTRIBUTE_XML_LANG

The laanguage identifier for the prompt. If omitted, it defaults to the value specified in the document's xml:lang attribute.

See Also:

Constant Field Values

ATTRIBUTE_XML_BASE

public static final java.lang.String ATTRIBUTE_XML_BASE

Declares the base URI from which relative URIs in the prompt are resloved. This base declaration has precedence over the <vxml> base URI declaration. If a local decalration is omitted, the value is inherited down the document hierarchie.

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

Prompt

public Prompt()

Construct a new prompt object without a node.

This is necessary for the node factory.

See Also:

VoiceXmlNodeFactory

Method Detail

getBargein

public java.lang.String getBargein()

Retrieve the bargein attribute.

Returns:

Value of the bargein attribute.

See Also:

ATTRIBUTE_BARGEIN

setBargein

public void setBargein(java.lang.String bargein)

Set the bargein attribute.

Parameters:

bargein - Value of the bargein attribute.

See Also:

ATTRIBUTE_BARGEIN

isBargein

public boolean isBargein()

Checks if barge-in is enabled.

Returns:

true if barge-in is enabled.

Since:

0.5

setBargein

public void setBargein(boolean bargein)

Set the bargein attribute.

Parameters:

bargein - Value of the bargein attribute.

Since:

0.5

See Also:

ATTRIBUTE_BARGEIN

getBargeintypeName

public java.lang.String getBargeintypeName()

Retrieve the bargeintype attribute.

Returns:

Value of the bargeintype attribute.

See Also:

ATTRIBUTE_BARGEINTYPE

setBargeintype

public void setBargeintype(java.lang.String bargeintype)

Set the bargeintype attribute.

Parameters:

bargeintype - Value of the bargein attribute.

See Also:

ATTRIBUTE_BARGEIN

getBargeintype

public BargeInType getBargeintype()

Retrieve the bargeintype attribute.

Returns:

Value of the bargeintype attribute.

Since:

0.5

See Also:

ATTRIBUTE_BARGEINTYPE

setBargeintype

public void setBargeintype(BargeInType bargeintype)

Set the bargeintype attribute.

Parameters:

bargeintype - Value of the bargein attribute.

Since:

0.5

See Also:

ATTRIBUTE_BARGEIN

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

getCount

public java.lang.String getCount()

Retrieve the count attribute.

Returns:

Value of the count attribute.

See Also:

ATTRIBUTE_COUNT

setCount

public void setCount(java.lang.String count)

Set the count attribute.

Parameters:

count - Value of the count attribute.

See Also:

ATTRIBUTE_COUNT

getCountAsInt

public int getCountAsInt()

Retrieve the count attribute.

Returns:

Value of the count attribute.

See Also:

ATTRIBUTE_COUNT

setCount

public void setCount(int count)

Set the count attribute.

Parameters:

count - Value of the count attribute.

See Also:

ATTRIBUTE_COUNT

getTimeout

public java.lang.String getTimeout()

Retrieve the timeout attribute.

Returns:

Value of the timeout attribute.

See Also:

ATTRIBUTE_TIMEOUT

getTimeoutAsMsec

public long getTimeoutAsMsec()

Retrieves the timeout attribute as msec.

Returns:

number of milliseconds, -1 if the value can not be converted to a number.

Since:

0.6

setTimeout

public void setTimeout(java.lang.String timeout)

Set the timeout attribute.

Parameters:

timeout - Value of the count attribute.

See Also:

ATTRIBUTE_TIMEOUT

getXmlLang

public java.lang.String getXmlLang()

Retrieve the xml:lang attribute.

Returns:

Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

setXmlLang

public void setXmlLang(java.lang.String xmlLang)

Set the xml:lang attribute.

Parameters:

xmlLang - Value of the xml:lang attribute.

See Also:

ATTRIBUTE_XML_LANG

setXmlLang

public void setXmlLang(java.util.Locale locale)

Set the xml:lang attribute.

Parameters:

locale - Value of the xml:lang attribute.

Since:

0.7.1

See Also:

ATTRIBUTE_XML_LANG

getXmlLangObject

public java.util.Locale getXmlLangObject()

Retrieve the xml:lang attribute.

Returns:

Value of the xml:lang attribute.

Since:

0.7.1

See Also:

ATTRIBUTE_XML_LANG

getXmlBase

public java.lang.String getXmlBase()

Retrieve the xml:base attribute.

Returns:

Value of the xml:base attribute.

See Also:

ATTRIBUTE_XML_BASE

getXmlBaseUri

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

Retrieves the xml:base attribute as an URI.

Returns:

Value of the xml:base attribute.

Throws:

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

Since:

0.6

See Also:

ATTRIBUTE_XML_BASE

setXmlBase

public void setXmlBase(java.lang.String xmlBase)

Set the xml:base attribute.

Parameters:

xmlBase - Value of the xml:base attribute.

See Also:

ATTRIBUTE_XML_BASE

setXmlBase

public void setXmlBase(java.net.URI xmlBase)

Sets the xml:base attribute.

Parameters:

xmlBase - Value of the xml:base attribute.

Since:

0.6

See Also:

ATTRIBUTE_XML_BASE

getTagName

public java.lang.String getTagName()

Get the name of the tag for the derived node.

Specified by:

getTagName in interface XmlNode

Returns:

name of the tag.

addText

public Text addText(java.lang.String text)

Creates a new text within this prompt. If the last child node already is a text node the given trimmed text is appended to that node.

Specified by:

addText in interface TextContainer

Parameters:

text - The text to be added.

Returns:

The new created text.

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.

Specified by:

newInstance in interface XmlNode

Parameters:

n - The node to encapsulate.

factory - the factroy that calls this method.

Returns:

The new instance.

See Also:

XmlNodeFactory

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