io.spokestack.spokestack.dialogue

Class InMemoryConversationData

java.lang.Object

io.spokestack.spokestack.dialogue.InMemoryConversationData

All Implemented Interfaces:

ConversationData

public class InMemoryConversationData
extends Object
implements ConversationData

A simple data store for conversation data that resides in memory and lasts only as long as the dialogue manager holding it.

Formats values for both display and synthesis using String.valueOf(Object).

Nested Class Summary

Nested classes/interfaces inherited from interface io.spokestack.spokestack.dialogue.ConversationData

ConversationData.Format

Constructor Summary

Constructors

Constructor and Description
InMemoryConversationData() Create a new in-memory conversation data store.

Method Summary

Modifier and Type	Method and Description
Object	get(String key) Get the raw object stored at key.
String	getFormatted(String key, ConversationData.Format mode) Get a version of the data stored at key suitable for inserting into the conversation.
void	set(String key, Object value) Store an object under the specified key.

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryConversationData

public InMemoryConversationData()

Create a new in-memory conversation data store.

Method Detail

set

public void set(String key,
                Object value)

Description copied from interface: ConversationData

Store an object under the specified key.

Note that since this API is used by Spokestack to store data provided by the user during voice interactions, key should not begin with an underscore (_) unless intentionally overriding a key set by the dialogue manager.

Specified by:

set in interface ConversationData

Parameters:

key - The key under which value will be available.

value - Data to store for use by the conversation.

get

public Object get(String key)

Description copied from interface: ConversationData

Get the raw object stored at key. This method is only used by the dialogue system during DialoguePolicy.dump(ConversationData) to retrieve original slot values for use in cross-session persistence.

Specified by:

get in interface ConversationData

Parameters:

key - The key whose original object should be returned.

Returns:

The object stored at key, or null if key is not found in the data.

getFormatted

public String getFormatted(String key,
                           ConversationData.Format mode)

Description copied from interface: ConversationData

Get a version of the data stored at key suitable for inserting into the conversation.

Full objects are stored by the API, but the dialogue manager needs formatted strings to use for prompts. The simplest implementation is to call Object.toString() on the stored object, but custom formatting logic can be supplied as needed.

Occasionally an object (for example, a date) might require different formatting for use in a synthesized voice response than for use in a text-based interface, so a formatting mode is also required.

Specified by:

getFormatted in interface ConversationData

Parameters:

key - The key of the data to be retrieved.

mode - The data's destination, either text or voice.

Returns:

A version of the data stored at key suitable for use in the specified medium.