org.botlibre.knowledge

Class BasicMemory

java.lang.Object

org.botlibre.knowledge.BasicMemory

All Implemented Interfaces:

Memory

Direct Known Subclasses:

DatabaseMemory, MicroMemory, SerializedMemory, XMLMemory

public class BasicMemory
extends java.lang.Object
implements Memory

Defines a set of networks that make up a knowledge base. Defines long term, short term and flash networks. Basic implementation to allow subclasses to avoid defining some of the basic stuff, Note this basic implementation is not persistent.

Constructor Summary

Constructors

Constructor and Description
BasicMemory()

Method Summary

Modifier and Type	Method and Description
void	abort() Reset the short term and active memories.
Vertex	addActiveMemory(Vertex vertex) Add the sensory data to the active memory.
void	addListener(MemoryEventListener listener) Add the memory listener.
void	awake() Load any properties and init.
int	cacheSize()
void	clearProperties(java.lang.String propertySet)
void	createMemory(java.lang.String database) Create a memory database.
void	createMemory(java.lang.String database, boolean isSchema) Create a memory database.
void	createMemoryFromTemplate(java.lang.String database, boolean templateIsSchema, java.lang.String template, boolean isSchema) Create a memory database.
void	createMemoryFromTemplate(java.lang.String database, java.lang.String template) Create a memory database.
void	deleteMemory() Delete all content from the database.
void	destroyMemory(java.lang.String database) Destroy the database.
void	destroyMemory(java.lang.String database, boolean isSchema) Destroy the database.
void	fastRestore(java.lang.String database, boolean isSchema) This implementation does not support persistence.
Vertex	find(Vertex source, Vertex id) Self API Lookup an object by id.
Vertex	findInstances(Vertex source, Vertex type) Self API Search all instances of the class type.
Vertex	findInstances(Vertex source, Vertex type, Vertex date) Self API Search all instances of the class type, created after the date.
Vertex	findReferences(Vertex source, Vertex target) Self API Search what references the object.
Vertex	findReferencesBy(Vertex source, Vertex target, Vertex type) Self API Search what references the object by the relationship.
void	freeMemory()
java.util.List<Vertex>	getActiveMemory() Active memory represents the last sensory state.
Bot	getBot() Return Bot.
java.util.List<MemoryEventListener>	getListeners()
Network	getLongTermMemory() Represents the persisted memory (or cache there of).
java.lang.String	getMemoryName() Return the current connected database name.
java.util.Map<java.lang.String,java.lang.String>	getProperties()
java.lang.String	getProperty(java.lang.String property) Return the property setting.
Network	getShortTermMemory() Represents a non-committed transactional memory.
void	importMemory(java.lang.String location) Allow import of another memory location.
void	initialize(java.util.Map<java.lang.String,java.lang.Object> properties) Initialize any configurable settings from the properties.
void	initMemory()
void	loadProperties(java.lang.String propertySet)
Network	newMemory() Return an isolated transactional memory.
void	pool() Reset state when instance is pooled.
void	removeListener(MemoryEventListener listener)
java.lang.String	removeProperty(java.lang.String property) Remove the property setting.
void	restore() This implementation does not support persistence.
void	restore(java.lang.String database, boolean isSchema) This implementation does not support persistence.
void	save() Merge the short term memory into the long term and clears the short term.
void	setActiveMemory(java.util.List<Vertex> activeMemory)
void	setBot(Bot bot) Set Bot.
void	setLongTermMemory(Network longTermMemory)
void	setProperties(java.util.Map<java.lang.String,java.lang.String> properties)
java.lang.String	setProperty(java.lang.String property, java.lang.String value) Save the property setting.
void	setShortTermMemory(Network shortTermMemory)
void	shutdown() Shutdown the memory.
void	switchMemory(java.lang.String location) Allow switching to another memory location.
void	switchMemory(java.lang.String location, boolean isSchema) Allow switching to another memory location.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicMemory

public BasicMemory()

Method Detail

initMemory

public void initMemory()

getMemoryName

public java.lang.String getMemoryName()

Return the current connected database name.

Specified by:

getMemoryName in interface Memory

getProperty

public java.lang.String getProperty(java.lang.String property)

Return the property setting.

Specified by:

getProperty in interface Memory

setProperty

public java.lang.String setProperty(java.lang.String property,
                                    java.lang.String value)

Save the property setting.

Specified by:

setProperty in interface Memory

removeProperty

public java.lang.String removeProperty(java.lang.String property)

Remove the property setting.

Specified by:

removeProperty in interface Memory

getProperties

public java.util.Map<java.lang.String,java.lang.String> getProperties()

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> properties)

getBot

public Bot getBot()

Return Bot.

Specified by:

getBot in interface Memory

setBot

public void setBot(Bot bot)

Set Bot.

Specified by:

setBot in interface Memory

initialize

public void initialize(java.util.Map<java.lang.String,java.lang.Object> properties)

Initialize any configurable settings from the properties.

Specified by:

initialize in interface Memory

awake

public void awake()

Load any properties and init.

Specified by:

awake in interface Memory

loadProperties

public void loadProperties(java.lang.String propertySet)

Specified by:

loadProperties in interface Memory

clearProperties

public void clearProperties(java.lang.String propertySet)

Specified by:

clearProperties in interface Memory

getActiveMemory

public java.util.List<Vertex> getActiveMemory()

Active memory represents the last sensory state.

Specified by:

getActiveMemory in interface Memory

addActiveMemory

public Vertex addActiveMemory(Vertex vertex)

Add the sensory data to the active memory. Register the vertex in the short-term memory and return the registered version.

Specified by:

addActiveMemory in interface Memory

getShortTermMemory

public Network getShortTermMemory()

Represents a non-committed transactional memory. Helps to define a learn scope and local context.

Specified by:

getShortTermMemory in interface Memory

newMemory

public Network newMemory()

Return an isolated transactional memory. Can be used by senses or sub-conscious thought for concurrent processing.

Specified by:

newMemory in interface Memory

getLongTermMemory

public Network getLongTermMemory()

Represents the persisted memory (or cache there of).

Specified by:

getLongTermMemory in interface Memory

setActiveMemory

public void setActiveMemory(java.util.List<Vertex> activeMemory)

setShortTermMemory

public void setShortTermMemory(Network shortTermMemory)

setLongTermMemory

public void setLongTermMemory(Network longTermMemory)

save

public void save()

Merge the short term memory into the long term and clears the short term. This is similar to a transactional commit. The changes should also be persisted, as the long term should always just be a cache of the storage. This implementation does not support persistence.

Specified by:

save in interface Memory

restore

public void restore()

This implementation does not support persistence.

Specified by:

restore in interface Memory

fastRestore

public void fastRestore(java.lang.String database,
                        boolean isSchema)

This implementation does not support persistence.

Specified by:

fastRestore in interface Memory

restore

public void restore(java.lang.String database,
                    boolean isSchema)

This implementation does not support persistence.

Specified by:

restore in interface Memory

createMemory

public void createMemory(java.lang.String database)

Create a memory database.

Specified by:

createMemory in interface Memory

createMemory

public void createMemory(java.lang.String database,
                         boolean isSchema)

Create a memory database.

Specified by:

createMemory in interface Memory

createMemoryFromTemplate

public void createMemoryFromTemplate(java.lang.String database,
                                     java.lang.String template)

Create a memory database.

Specified by:

createMemoryFromTemplate in interface Memory

createMemoryFromTemplate

public void createMemoryFromTemplate(java.lang.String database,
                                     boolean templateIsSchema,
                                     java.lang.String template,
                                     boolean isSchema)

Create a memory database.

Specified by:

createMemoryFromTemplate in interface Memory

destroyMemory

public void destroyMemory(java.lang.String database)

Destroy the database.

Specified by:

destroyMemory in interface Memory

destroyMemory

public void destroyMemory(java.lang.String database,
                          boolean isSchema)

Destroy the database.

Specified by:

destroyMemory in interface Memory

deleteMemory

public void deleteMemory()

Delete all content from the database.

Specified by:

deleteMemory in interface Memory

importMemory

public void importMemory(java.lang.String location)

Allow import of another memory location.

Specified by:

importMemory in interface Memory

switchMemory

public void switchMemory(java.lang.String location)

Allow switching to another memory location.

Specified by:

switchMemory in interface Memory

switchMemory

public void switchMemory(java.lang.String location,
                         boolean isSchema)

Allow switching to another memory location.

Specified by:

switchMemory in interface Memory

shutdown

public void shutdown()

Shutdown the memory.

Specified by:

shutdown in interface Memory

pool

public void pool()

Reset state when instance is pooled.

Specified by:

pool in interface Memory

abort

public void abort()

Reset the short term and active memories. Revert to the long term state.

Specified by:

abort in interface Memory

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getListeners

public java.util.List<MemoryEventListener> getListeners()

addListener

public void addListener(MemoryEventListener listener)

Add the memory listener. It will be notified of any new active memory.

Specified by:

addListener in interface Memory

removeListener

public void removeListener(MemoryEventListener listener)

Specified by:

removeListener in interface Memory

cacheSize

public int cacheSize()

Specified by:

cacheSize in interface Memory

freeMemory

public void freeMemory()

Specified by:

freeMemory in interface Memory

findReferencesBy

public Vertex findReferencesBy(Vertex source,
                               Vertex target,
                               Vertex type)

Self API Search what references the object by the relationship. Memory.findReferencesBy(#conversation, #instantiation)

findReferences

public Vertex findReferences(Vertex source,
                             Vertex target)

Self API Search what references the object. Memory.findReferences(#cool)

findInstances

public Vertex findInstances(Vertex source,
                            Vertex type)

Self API Search all instances of the class type. Memory.findInstances(type)

findInstances

public Vertex findInstances(Vertex source,
                            Vertex type,
                            Vertex date)

Self API Search all instances of the class type, created after the date. Memory.findInstances(type, date)

find

public Vertex find(Vertex source,
                   Vertex id)

Self API Lookup an object by id. Memory.find(id)