org.jvoicexml.interpreter.formitem

Class FieldFormItem

java.lang.Object

org.jvoicexml.interpreter.formitem.FieldFormItem

All Implemented Interfaces:

CatchContainer, DialogConstruct, EventCountable, FormItem, FormItemLocalExecutableTagContainer, FormItemVisitable, GrammarContainer, InputItem, PromptCountable

public final class FieldFormItem
extends java.lang.Object

An input item whose value is obtained via ASR or DTMF grammars.

Constructor Summary

Constructors

Constructor and Description
FieldFormItem() Constructs a new object as a template.
FieldFormItem(VoiceXmlInterpreterContext context, org.jvoicexml.xml.VoiceXmlNode voiceNode) Creates a new field input item.

Method Summary

Modifier and Type	Method and Description
void	accept(FormItemVisitor visitor) Execute the specific method of the visitor.
protected void	addCustomGrammars(java.util.Collection<org.jvoicexml.xml.srgs.Grammar> grammars) Adds custom grammars of the grammar container.
void	addGrammar(GrammarDocument document) Adds the given converted grammar to the list of converted grammars for this grammar container.
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.util.Collection<org.jvoicexml.xml.vxml.Filled>	getFilledElements() Gets all nested <filled> elements.
java.lang.Object	getFormItemVariable() Retrieves the form item variable.
java.util.Collection<GrammarDocument>	getGrammarDocuments() Retrieves the list of converted grammars.
java.util.Collection<org.jvoicexml.xml.srgs.Grammar>	getGrammars() Get all nested definitions of a <grammar>.
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.
protected java.lang.String	getShadowVarContainerName() Retrieves the name of the corresponding shadow var container name.
java.lang.String	getSlot() Retrieves the slot of the related field in mixed initiative dialogs.
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.
int	setFormItemVariable(RecognitionResult result) Sets the form item variable with values from the given recognition result.
int	setFormItemVariable(java.lang.String utterance) Sets the form item variable with values from the given utterance.
void	setOptionConverter(OptionConverter optionConverter) Sets the option converter to use for the conversion of <option tags into a grammar.

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.InputItem

getFilledElements

Methods inherited from interface org.jvoicexml.interpreter.CatchContainer

getCatchElements

Methods inherited from interface org.jvoicexml.interpreter.FormItem

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

Methods inherited from interface org.jvoicexml.interpreter.PromptCountable

getName, getNode, getPromptCount, incrementPromptCount, resetPromptCount

Methods inherited from interface org.jvoicexml.interpreter.EventCountable

getEventCount, incrementEventCounter, resetEventCounter

Constructor Detail

FieldFormItem

public FieldFormItem()

Constructs a new object as a template.

FieldFormItem

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

Creates a new field input 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 Field.

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

setOptionConverter

public void setOptionConverter(OptionConverter optionConverter)

Sets the option converter to use for the conversion of <option tags into a grammar.

Parameters:

optionConverter - the option converter

Since:

0.7.6

accept

public void accept(FormItemVisitor visitor)
            throws JVoiceXMLEvent

Execute the specific method of the visitor.

Parameters:

visitor - The visitor to use.

Throws:

JVoiceXMLEvent - Error or event visiting the form item.

setFormItemVariable

public int setFormItemVariable(RecognitionResult result)
                        throws SemanticError

Sets the form item variable with values from the given recognition result.

Parameters:

result - the observed recognition result

Returns:

0 if the variable was set successfully

Throws:

SemanticError - error passing the values to the scripting engine

Since:

0.7.6

setFormItemVariable

public int setFormItemVariable(java.lang.String utterance)
                        throws SemanticError

Sets the form item variable with values from the given utterance.

Parameters:

utterance - the observed utterance

Returns:

0 if the variable was set successfully

Throws:

SemanticError - error passing the values to the scripting engine

Since:

0.7.7

setFormItemVariable

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

Sets the value of the form item variable. Sets also the shadow variables.

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

addCustomGrammars

protected void addCustomGrammars(java.util.Collection<org.jvoicexml.xml.srgs.Grammar> grammars)

Adds custom grammars of the grammar container.

Parameters:

grammars - already found grammars

getSlot

public java.lang.String getSlot()

Retrieves the slot of the related field in mixed initiative dialogs.

Returns:

the slot if defined, the name otherwise.

Since:

0.7.2

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.

Returns:

true if the form item is modal.

getGrammarDocuments

public java.util.Collection<GrammarDocument> getGrammarDocuments()

Retrieves the list of converted grammars.

Specified by:

getGrammarDocuments in interface GrammarContainer

Returns:

list of converted grammars

addGrammar

public void addGrammar(GrammarDocument document)

Adds the given converted grammar to the list of converted grammars for this grammar container.

Specified by:

addGrammar in interface GrammarContainer

Parameters:

document - the processed grammar document

getGrammars

public final java.util.Collection<org.jvoicexml.xml.srgs.Grammar> getGrammars()

Get all nested definitions of a <grammar>.

Specified by:

getGrammars in interface GrammarContainer

Returns:

Collection of all nested <grammar> tags.

incrementEventCounter

public final 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 final void resetEventCounter()

Reset the event counter.

Specified by:

resetEventCounter in interface EventCountable

getPromptCount

public final int getPromptCount()

Retrieves the value of the prompt counter.

Specified by:

getPromptCount in interface PromptCountable

Returns:

Value of the prompt counter.

incrementPromptCount

public final void incrementPromptCount()

Increments the prompt counter.

Specified by:

incrementPromptCount in interface PromptCountable

resetPromptCount

public final void resetPromptCount()

Resets the prompt counter.

Specified by:

resetPromptCount in interface PromptCountable

getEventCount

public final 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.

getShadowVarContainerName

protected final java.lang.String getShadowVarContainerName()

Retrieves the name of the corresponding shadow var container name.

Returns:

Name of the shadow var container.

Since:

0.3.1

getFilledElements

public final java.util.Collection<org.jvoicexml.xml.vxml.Filled> getFilledElements()

Gets all nested <filled> elements.

Specified by:

getFilledElements in interface InputItem

Returns:

Collection about all nested <filled> tags.

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

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.