org.jvoicexml.interpreter.formitem

Class InitialFormItem

java.lang.Object

org.jvoicexml.interpreter.formitem.InitialFormItem

All Implemented Interfaces:

CatchContainer, ControlItem, DialogConstruct, EventCountable, FormItem, FormItemLocalExecutableTagContainer, FormItemVisitable, PromptCountable

public final class InitialFormItem
extends java.lang.Object
implements CatchContainer, PromptCountable, EventCountable

This element controls the initial interaction in a mixed initiative form. Its prompts should be written to encourage the user to say something matching a form level grammar. When at least one input item variable is filled as a result of recognition during an <initial> element, the form item variable of <initial> becomes true, thus removing it as an alternative for the FIA.

Constructor Summary

Constructors

Constructor and Description
InitialFormItem() Constructs a new object as a template.
InitialFormItem(VoiceXmlInterpreterContext context, org.jvoicexml.xml.VoiceXmlNode voiceNode) Create a new initial form item.

Method Summary

Modifier and Type	Method and Description
void	accept(FormItemVisitor visitor) Execute the specific method of the visitor.
boolean	evaluateCondition() An expression to evaluate in conjunction with the test of the form item variable.
java.lang.Object	evaluateExpression(DataModel model) Retrieves the evaluated expr attribute.
java.util.Collection<org.jvoicexml.xml.vxml.AbstractCatchElement>	getCatchElements() Retrieves all nested catch elements.
protected VoiceXmlInterpreterContext	getContext() Retrieves the current VoiceXmlInterpreterContext.
int	getEventCount(java.lang.String type) Retrieve the counter for the given event type.
java.lang.Object	getFormItemVariable() Retrieves the form item variable.
java.util.Collection<org.jvoicexml.xml.VoiceXmlNode>	getLocalExecutableTags() Retrieves the nested tags that have to be executed locally.
java.lang.String	getName() Retrieves the name of this FormItem..
org.jvoicexml.xml.VoiceXmlNode	getNode() Retrieves the encapsulated VoiceXmlNode.
java.lang.String	getNodeTagName() Retrieves the tag name of the encapsulated node.
int	getPromptCount() Retrieves the value of the prompt counter.
void	incrementEventCounter(JVoiceXMLEvent event) Increment counters for all events that have the same name as the given event or have a name that is a prefix of the given event.
void	incrementPromptCount() Increments the prompt counter.
void	init(DataModel model) Initializes this form item.
boolean	isModal() Checks if this form item is modal.
boolean	isSelectable() Guard conditions, which governs whether or not this form item can be selected by the form interpretation algorithm.
org.jvoicexml.interpreter.formitem.AbstractFormItem	newInstance(VoiceXmlInterpreterContext ctx, org.jvoicexml.xml.VoiceXmlNode voiceNode) Factory method to create a new instance from a template.
void	resetEventCounter() Reset the event counter.
void	resetPromptCount() Resets the prompt counter.
int	setFormItemVariable(java.lang.Object value) Sets the value of the form item variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jvoicexml.interpreter.CatchContainer

getCatchElements

Methods inherited from interface org.jvoicexml.interpreter.FormItem

evaluateCondition, evaluateExpression, getFormItemVariable, getName, getNode, getNodeTagName, isSelectable, setFormItemVariable

Methods inherited from interface org.jvoicexml.interpreter.PromptCountable

getName, getNode

Constructor Detail

InitialFormItem

public InitialFormItem()

Constructs a new object as a template.

InitialFormItem

public InitialFormItem(VoiceXmlInterpreterContext context,
                       org.jvoicexml.xml.VoiceXmlNode voiceNode)
                throws java.lang.IllegalArgumentException

Create a new initial form item.

Parameters:

context - The current VoiceXmlInterpreterContext.

voiceNode - The corresponding xml node in the VoiceXML document.

Throws:

java.lang.IllegalArgumentException - if the given node is not a Initial

Method Detail

newInstance

public org.jvoicexml.interpreter.formitem.AbstractFormItem newInstance(VoiceXmlInterpreterContext ctx,
                                                                       org.jvoicexml.xml.VoiceXmlNode voiceNode)

Factory method to create a new instance from a template.

Parameters:

ctx - The current VoiceXmlInterpreterContext.

voiceNode - The corresponding XML node in the VoiceXML document.

Returns:

created form item

accept

public void accept(FormItemVisitor visitor)
            throws JVoiceXMLEvent

Execute the specific method of the visitor.

Specified by:

accept in interface FormItemVisitable

Parameters:

visitor - The visitor to use.

Throws:

JVoiceXMLEvent - Error or event visiting the form item.

isModal

public boolean isModal()

Checks if this form item is modal. This causes all grammars to be disabled except the ones defined in the current form item.

Specified by:

isModal in interface FormItem

Returns:

true if the form item is modal.

getPromptCount

public int getPromptCount()

Retrieves the value of the prompt counter.

Specified by:

getPromptCount in interface PromptCountable

Returns:

Value of the prompt counter.

incrementPromptCount

public void incrementPromptCount()

Increments the prompt counter.

Specified by:

incrementPromptCount in interface PromptCountable

resetPromptCount

public void resetPromptCount()

Resets the prompt counter.

Specified by:

resetPromptCount in interface PromptCountable

getEventCount

public int getEventCount(java.lang.String type)

Retrieve the counter for the given event type.

Specified by:

getEventCount in interface EventCountable

Parameters:

type - Event type.

Returns:

Count for the given event type.

incrementEventCounter

public void incrementEventCounter(JVoiceXMLEvent event)

Increment counters for all events that have the same name as the given event or have a name that is a prefix of the given event.

Specified by:

incrementEventCounter in interface EventCountable

Parameters:

event - Event to increment.

resetEventCounter

public void resetEventCounter()

Reset the event counter.

Specified by:

resetEventCounter in interface EventCountable

init

public void init(DataModel model)
          throws SemanticError,
                 BadFetchError

Initializes this form item.

Specified by:

init in interface FormItem

Parameters:

model - the employed data model

Throws:

SemanticError - error initializing this form item

BadFetchError - error initializing this form item

getFormItemVariable

public final java.lang.Object getFormItemVariable()

Retrieves the form item variable.

Each form has an associated form item variable. which by default is set to null when the form is entered. This form item variable will contain the result of interpreting the form item. An input item's form variable can be given a name using the name attribute or left nameless in which case an internal name is generated.

Specified by:

getFormItemVariable in interface FormItem

Returns:

retrieves the value of the associated variable in the DataModel

setFormItemVariable

public int setFormItemVariable(java.lang.Object value)
                        throws SemanticError

Sets the value of the form item variable.

Specified by:

setFormItemVariable in interface FormItem

Parameters:

value - new value for the form item variable.

Returns:

0 if setting the form item variable was successful

Throws:

SemanticError - error setting the value

getName

public final java.lang.String getName()

Retrieves the name of this FormItem..

Specified by:

getName in interface FormItem

Returns:

Name of a dialog scoped form item variable.

evaluateExpression

public final java.lang.Object evaluateExpression(DataModel model)
                                          throws SemanticError

Retrieves the evaluated expr attribute.

Specified by:

evaluateExpression in interface FormItem

Parameters:

model - the data model to use for evaluation

Returns:

evaluated expression of the expr attribute.

Throws:

SemanticError - error evaluating the expr attribute.

evaluateCondition

public boolean evaluateCondition()
                          throws SemanticError

An expression to evaluate in conjunction with the test of the form item variable. If absent, this defaults to true, or in the case of <initial>, a test to see if any input item variable has been filled in.

Specified by:

evaluateCondition in interface FormItem

Returns:

true if the cond attribute of the form item evaluates to true.

Throws:

SemanticError - error evaluating the cond attribute.

isSelectable

public boolean isSelectable()
                     throws SemanticError

Guard conditions, which governs whether or not this form item can be selected by the form interpretation algorithm.

This default guard condition just tests to see if the form item variable has a value. If it does, this form item will not be visited.

Specified by:

isSelectable in interface FormItem

Returns:

true if the form item's variable has no value.

Throws:

SemanticError - error evaluating the cond condition.

See Also:

FormItem.getFormItemVariable()

getNode

public final org.jvoicexml.xml.VoiceXmlNode getNode()

Retrieves the encapsulated VoiceXmlNode.

Specified by:

getNode in interface FormItem

Returns:

Related VoiceXmlNode.

getNodeTagName

public final java.lang.String getNodeTagName()

Retrieves the tag name of the encapsulated node.

Specified by:

getNodeTagName in interface FormItem

Returns:

tag name of the encapsulated node.

getContext

protected final VoiceXmlInterpreterContext getContext()

Retrieves the current VoiceXmlInterpreterContext.

Returns:

the current VoiceXmlInterpreterContext.

getCatchElements

public java.util.Collection<org.jvoicexml.xml.vxml.AbstractCatchElement> getCatchElements()

Retrieves all nested catch elements.

Returns:

all nested catch elements

getLocalExecutableTags

public java.util.Collection<org.jvoicexml.xml.VoiceXmlNode> getLocalExecutableTags()

Retrieves the nested tags that have to be executed locally.

Specified by:

getLocalExecutableTags in interface FormItemLocalExecutableTagContainer

Returns:

local executable tags.