won.bot.framework.bot.context

Class MemoryBotContext

java.lang.Object

won.bot.framework.bot.context.MemoryBotContext

All Implemented Interfaces:

BotContext

public class MemoryBotContext
extends java.lang.Object
implements BotContext

In memory context implementation using nested maps. This is the default implementation of the bot context.

Field Summary

Fields inherited from interface won.bot.framework.bot.context.BotContext

DEFAULT_NEED_LIST_NAME

Constructor Summary

Constructors

Constructor and Description
MemoryBotContext()

Method Summary

Modifier and Type	Method and Description
void	addToListMap(java.lang.String collectionName, java.lang.String key, java.io.Serializable... value) Add one or more arbitrary objects to a list at a specific key in the collection.
void	appendToNamedNeedUriList(java.net.URI uri, java.lang.String name) add a need uri to a named need uri list
void	dropCollection(java.lang.String collectionName) Remove the whole collection from the bot context
java.util.List<java.net.URI>	getNamedNeedUriList(java.lang.String name) loadFromObjectMap all the need from a named need uri list
boolean	isInNamedNeedUriList(java.net.URI uri, java.lang.String name)
boolean	isNeedKnown(java.net.URI needURI) Check if need uri is known among all stored need uris
boolean	isNodeKnown(java.net.URI wonNodeURI) check if a node uri is known among all stored nodes
java.util.List<java.lang.Object>	loadFromListMap(java.lang.String collectionName, java.lang.String key) Retrieve all objects from one collection at one key previously added using addToListMap().
java.lang.Object	loadFromObjectMap(java.lang.String collectionName, java.lang.String key) Retrieve an object from a collection previously added using saveToObjectMap().
java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	loadListMap(java.lang.String collectionName) Retrieve a copy of the whole object list map in a collection
java.util.Map<java.lang.String,java.lang.Object>	loadObjectMap(java.lang.String collectionName) Retrieve a copy of the whole object map of the collection
void	rememberNodeUri(java.net.URI uri) store a node uri
void	removeFromListMap(java.lang.String collectionName, java.lang.String key) Remove all object in the list at a specific map key in the collection
void	removeFromListMap(java.lang.String collectionName, java.lang.String key, java.io.Serializable... values) Remove one or more arbitrary objects from the list at a specific key in the collection.
void	removeFromObjectMap(java.lang.String collectionName, java.lang.String key) Remove an object saved at a specific map key in the collection
void	removeLeavesFromListMap(java.lang.String collectionName, java.io.Serializable... values) Remove one or more arbitrary objects from the list for all keys in the collection.
void	removeNeedUriFromNamedNeedUriList(java.net.URI uri, java.lang.String name) removeFromObjectMap a need uri from a named need uri list
void	removeNodeUri(java.net.URI uri) removeFromObjectMap a node uri
java.util.Set<java.net.URI>	retrieveAllNeedUris() Return a set of all known need uris stored in all named need uri lists
void	saveToObjectMap(java.lang.String collectionName, java.lang.String key, java.io.Serializable value) Put an arbitrary single object in the context.

Methods inherited from class java.lang.Object

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

Constructor Detail

MemoryBotContext

public MemoryBotContext()

Method Detail

retrieveAllNeedUris

public java.util.Set<java.net.URI> retrieveAllNeedUris()

Description copied from interface: BotContext

Return a set of all known need uris stored in all named need uri lists

Specified by:

retrieveAllNeedUris in interface BotContext

Returns:

isNeedKnown

public boolean isNeedKnown(java.net.URI needURI)

Description copied from interface: BotContext

Check if need uri is known among all stored need uris

Specified by:

isNeedKnown in interface BotContext

Returns:

removeNeedUriFromNamedNeedUriList

public void removeNeedUriFromNamedNeedUriList(java.net.URI uri,
                                              java.lang.String name)

Description copied from interface: BotContext

removeFromObjectMap a need uri from a named need uri list

Specified by:

removeNeedUriFromNamedNeedUriList in interface BotContext

appendToNamedNeedUriList

public void appendToNamedNeedUriList(java.net.URI uri,
                                     java.lang.String name)

Description copied from interface: BotContext

add a need uri to a named need uri list

Specified by:

appendToNamedNeedUriList in interface BotContext

isInNamedNeedUriList

public boolean isInNamedNeedUriList(java.net.URI uri,
                                    java.lang.String name)

Specified by:

isInNamedNeedUriList in interface BotContext

getNamedNeedUriList

public java.util.List<java.net.URI> getNamedNeedUriList(java.lang.String name)

Description copied from interface: BotContext

loadFromObjectMap all the need from a named need uri list

Specified by:

getNamedNeedUriList in interface BotContext

Returns:

isNodeKnown

public boolean isNodeKnown(java.net.URI wonNodeURI)

Description copied from interface: BotContext

check if a node uri is known among all stored nodes

Specified by:

isNodeKnown in interface BotContext

Returns:

rememberNodeUri

public void rememberNodeUri(java.net.URI uri)

Description copied from interface: BotContext

store a node uri

Specified by:

rememberNodeUri in interface BotContext

removeNodeUri

public void removeNodeUri(java.net.URI uri)

Description copied from interface: BotContext

removeFromObjectMap a node uri

Specified by:

removeNodeUri in interface BotContext

dropCollection

public void dropCollection(java.lang.String collectionName)

Description copied from interface: BotContext

Remove the whole collection from the bot context

Specified by:

dropCollection in interface BotContext

saveToObjectMap

public void saveToObjectMap(java.lang.String collectionName,
                            java.lang.String key,
                            java.io.Serializable value)

Description copied from interface: BotContext

Put an arbitrary single object in the context. If there exists already an object at the specified key then replace that object by the new one.

Specified by:

saveToObjectMap in interface BotContext

loadFromObjectMap

public final java.lang.Object loadFromObjectMap(java.lang.String collectionName,
                                                java.lang.String key)

Description copied from interface: BotContext

Retrieve an object from a collection previously added using saveToObjectMap().

Specified by:

loadFromObjectMap in interface BotContext

Returns:

the requested object or null if it was not found

loadObjectMap

public java.util.Map<java.lang.String,java.lang.Object> loadObjectMap(java.lang.String collectionName)

Description copied from interface: BotContext

Retrieve a copy of the whole object map of the collection

Specified by:

loadObjectMap in interface BotContext

Returns:

removeFromObjectMap

public final void removeFromObjectMap(java.lang.String collectionName,
                                      java.lang.String key)

Description copied from interface: BotContext

Remove an object saved at a specific map key in the collection

Specified by:

removeFromObjectMap in interface BotContext

addToListMap

public void addToListMap(java.lang.String collectionName,
                         java.lang.String key,
                         java.io.Serializable... value)

Description copied from interface: BotContext

Add one or more arbitrary objects to a list at a specific key in the collection.

Specified by:

addToListMap in interface BotContext

removeFromListMap

public void removeFromListMap(java.lang.String collectionName,
                              java.lang.String key,
                              java.io.Serializable... values)

Description copied from interface: BotContext

Remove one or more arbitrary objects from the list at a specific key in the collection.

Specified by:

removeFromListMap in interface BotContext

removeLeavesFromListMap

public void removeLeavesFromListMap(java.lang.String collectionName,
                                    java.io.Serializable... values)

Description copied from interface: BotContext

Remove one or more arbitrary objects from the list for all keys in the collection.

Specified by:

removeLeavesFromListMap in interface BotContext

loadFromListMap

public java.util.List<java.lang.Object> loadFromListMap(java.lang.String collectionName,
                                                        java.lang.String key)

Description copied from interface: BotContext

Retrieve all objects from one collection at one key previously added using addToListMap().

Specified by:

loadFromListMap in interface BotContext

Returns:

all objects from one collection or an empty collection if no objects are in there

loadListMap

public java.util.Map<java.lang.String,java.util.List<java.lang.Object>> loadListMap(java.lang.String collectionName)

Description copied from interface: BotContext

Retrieve a copy of the whole object list map in a collection

Specified by:

loadListMap in interface BotContext

Returns:

removeFromListMap

public void removeFromListMap(java.lang.String collectionName,
                              java.lang.String key)

Description copied from interface: BotContext

Remove all object in the list at a specific map key in the collection

Specified by:

removeFromListMap in interface BotContext