won.bot.framework.bot.context

Interface BotContext

All Known Implementing Classes:

MemoryBotContext, MongoBotContext

public interface BotContext

Used by a bot to remember which needs and nodes and it knows. Additionally generic Java objects can be saved and retrieved.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NEED_LIST_NAME

Method Summary

Modifier and Type	Method and Description
void	addToListMap(java.lang.String collectionName, java.lang.String key, java.io.Serializable... values) 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.

Field Detail

DEFAULT_NEED_LIST_NAME

static final java.lang.String DEFAULT_NEED_LIST_NAME

See Also:

Constant Field Values

Method Detail

retrieveAllNeedUris

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

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

Returns:

isNeedKnown

boolean isNeedKnown(java.net.URI needURI)

Check if need uri is known among all stored need uris

Parameters:

needURI -

Returns:

removeNeedUriFromNamedNeedUriList

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

removeFromObjectMap a need uri from a named need uri list

Parameters:

uri -

name -

appendToNamedNeedUriList

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

add a need uri to a named need uri list

Parameters:

uri -

name -

isInNamedNeedUriList

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

getNamedNeedUriList

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

loadFromObjectMap all the need from a named need uri list

Parameters:

name -

Returns:

isNodeKnown

boolean isNodeKnown(java.net.URI wonNodeURI)

check if a node uri is known among all stored nodes

Parameters:

wonNodeURI -

Returns:

rememberNodeUri

void rememberNodeUri(java.net.URI uri)

store a node uri

Parameters:

uri -

removeNodeUri

void removeNodeUri(java.net.URI uri)

removeFromObjectMap a node uri

Parameters:

uri -

dropCollection

void dropCollection(java.lang.String collectionName)

Remove the whole collection from the bot context

Parameters:

collectionName -

saveToObjectMap

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

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.

Parameters:

collectionName -

key -

value -

loadFromObjectMap

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

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

Parameters:

collectionName -

key -

Returns:

the requested object or null if it was not found

loadObjectMap

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

Returns:

removeFromObjectMap

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

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

Parameters:

collectionName -

key -

addToListMap

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

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

Parameters:

collectionName -

key -

values -

removeFromListMap

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.

Parameters:

collectionName -

key -

values -

removeLeavesFromListMap

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.

Parameters:

collectionName -

values -

loadFromListMap

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().

Parameters:

collectionName -

Returns:

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

loadListMap

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

Parameters:

collectionName -

Returns:

removeFromListMap

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

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

Parameters:

collectionName -

key -