org.speakright.core.flows
Class PromptFlow

java.lang.Object
  org.speakright.core.FlowBase
      org.speakright.core.flows.PromptFlow

All Implemented Interfaces:

java.io.Serializable, IFlow

Direct Known Subclasses:

App.CharacterDescription, BaseSROSayDate, TestNesting.OptionalFlow, TestNesting.RepeatFlow, TestRender.PlayOnceFlow, TestRender.YouSaidFlow, TestRender.ZFlow, TestSerialization.PFlow, TestWebServlet2.PFlow

public class PromptFlow
extends FlowBase

A flow that plays one or more prompts. Note that type and sub-indexes are ignored here. We have a list of prompts that get rendered separately, each with their own conditions applied.

Author:

Ian Rae

See Also:

Serialized Form

Field Summary

protected java.util.ArrayList<Prompt>

m_promptL

Constructor Summary

PromptFlow()

PromptFlow(java.lang.String ptext)
Careful -- param is the prompt text, not the name!

PromptFlow(java.lang.String name, java.lang.String ptext)

Method Summary

void	addPrompt(java.lang.String ptext) Adds additional prompt.
boolean	bargeIn() gets the bargein flag for the first prompt.
IFlowRenderer	createRenderer() Create the type-specific renderer
Prompt	firstPrompt() By default a PromptFlow has a single prompt.
void	setBargeIn(boolean b) sets the bargein flag for the first prompt.

Methods inherited from class org.speakright.core.FlowBase

execute, executionCount, fixupGrammar, fixupPrompt, getFirst, getNext, getSubFlowAfter, log, logError, name, onBegin, onCatch, onComplete, onDisconnect, onEnd, onNoInput, onPlatformError, onTransferFailed, onValidateFailed, promptGroup, setExecutionCount, setName, setPromptGroup, shouldExecute, validateInput

Methods inherited from class java.lang.Object

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

Field Detail

m_promptL

protected java.util.ArrayList<Prompt> m_promptL

Constructor Detail

PromptFlow

public PromptFlow()

PromptFlow

public PromptFlow(java.lang.String ptext)

Careful -- param is the prompt text, not the name!

Parameters:

ptext - prompt text

PromptFlow

public PromptFlow(java.lang.String name,
                  java.lang.String ptext)

Method Detail

bargeIn

public boolean bargeIn()

gets the bargein flag for the first prompt. If you've added additional prompts, you need to get/set their bargein flags yourself.

Returns:

bargein flag for the first prompt

setBargeIn

public void setBargeIn(boolean b)

sets the bargein flag for the first prompt. If you've added additional prompts, you need to get/set their bargein flags yourself.

Parameters:

b - bargeIn

firstPrompt

public Prompt firstPrompt()

By default a PromptFlow has a single prompt.

Returns:

returns the first propt.

addPrompt

public void addPrompt(java.lang.String ptext)

Adds additional prompt.

Parameters:

ptext - prompt text, such as "Here is some music {willie.wav}"

createRenderer

public IFlowRenderer createRenderer()

Create the type-specific renderer

Specified by:

createRenderer in interface IFlow

Overrides:

createRenderer in class FlowBase