org.botlibre.api.knowledge

Interface Network

All Known Implementing Classes:

AbstractNetwork, BasicNetwork, DatabaseNetwork, DatabaseReadOnlyNetwork

public interface Network

An interconnected set of vertices, representing and knowledge-space. Define methods for creating, removing and finding vertices.

Method Summary

Modifier and Type	Method and Description
void	addVertex(Vertex vertex) Register the vertex with the network.
void	associateCaseInsensitivity(java.lang.String word, Vertex meaning) Associate alternative cases of the word with the meaning.
void	associateCaseInsensitivity(Vertex word) Associate alternative cases of the word with the meaning, type, tense, etc..
void	checkReduction(Vertex sentence) Check if the sentence has been reduced, if not, then reduce.
void	clear() Clear all vertices from the network.
int	countAll() Return count of all vertices.
int	countAllLike(java.lang.String filter) Return count of vertices matching the filter.
Vertex	createAnonymousSpeaker() Create a new anonymous speaker.
Vertex	createFormula(java.lang.String text) Compile the forumla response.
Vertex	createFragment(java.lang.String text) Tokenize the text into its words and create a vertex representation of the sentence fragment.
Vertex	createInstance(Primitive type) Create a new instance of the type.
Vertex	createInstance(Vertex type) Create a new instance of the type.
Vertex	createMeta(Relationship relationship) Return the relationship meta vertex.
Vertex	createName(java.lang.String name) Find or create the speaker with the name.
Vertex	createNewObject(java.lang.String name) Create the word, and a new meaning.
Vertex	createObject(java.lang.String name) Create the word, and its meaning.
Vertex	createParagraph(java.lang.String text) Tokenize the paragraph into its sentences and create a vertex representation.
Vertex	createParagraph(Vertex sentence) Convert the sentence to a paragraph if it has multiple phrases.
Vertex	createPattern(java.lang.String text) Tokenize the sentence pattern into its words and wildcrads, and create a vertex representation.
Vertex	createPattern(java.lang.String text, SelfCompiler compiler) Tokenize the sentence pattern into its words and wildcrads, and create a vertex representation.
Vertex	createPrimitive(java.lang.String name) Create the primitive and associate the word to it.
Vertex	createSentence(java.lang.String text) Tokenize the sentence into its words and create a vertex representation.
Vertex	createSentence(java.lang.String text, boolean generated) Tokenize the sentence into its words and create a vertex representation.
Vertex	createSentence(java.lang.String text, boolean generated, boolean reduced) Tokenize the sentence into its words and create a vertex representation.
Vertex	createSentence(java.lang.String text, boolean generated, boolean reduced, boolean whitespace) Tokenize the sentence into its words and create a vertex representation.
Vertex	createSpeaker(java.lang.String name) Find or create the speaker with the name.
Vertex	createTemplate(java.lang.String text) Compile the template response.
Vertex	createTemporyVertex() Create a temporary, non-persistent vertex.
Vertex	createTimestamp() Create a timestamp based on the current nanos.
Vertex	createUniqueSpeaker(Primitive id, Primitive type, java.lang.String name) Find or create the speaker from the unique id.
Vertex	createVertex() Create a new vertex in this network, assign the id.
Vertex	createVertex(java.lang.Object data) Create a new vertex in this network with the data.
Vertex	createVertex(Vertex vertex) Return the matching registered vertex, or register if missing.
Vertex	createWord(java.lang.String text) Tokenize the text into its words and create a vertex representation of the word or compound word.
int	executeNativeQuery(java.lang.String sql) Execute and commit the native query.
int	executeQuery(java.lang.String jpql) Execute and commit the update query.
java.util.List<Vertex>	findAll() Return all vertices.
java.util.List<Vertex>	findAll(int pageSize, int page) Return all vertices.
java.util.List<Vertex>	findAllInstances(Vertex type, Vertex relationship, java.util.Calendar start) Find all relationships related to the vertex or of the vertex type.
java.util.List<Vertex>	findAllLike(java.lang.String filter) Return all vertices matching the filter.
java.util.List<Vertex>	findAllLike(java.lang.String filter, int pageSize, int page) Return all vertices matching the filter.
java.util.List	findAllQuery(java.lang.String query) Return all vertices matching the query.
java.util.List	findAllQuery(java.lang.String query, int max) Return all vertices matching the query.
java.util.List	findAllQuery(java.lang.String query, java.util.Map parameters, int pageSize, int page) Return all vertices matching the query.
java.util.List<Relationship>	findAllRelationshipsTo(Vertex vertex) Find all relationships related to the vertex or of the vertex relationship type.
java.util.List<Relationship>	findAllRelationshipsTo(Vertex vertex, Vertex type) Find all relationships related to the vertex by the type.
java.util.List<Relationship>	findAllRelationshipsTo(Vertex vertex, Vertex type, java.util.Date date) Find all relationships related to the vertex by the type.
Vertex	findByData(java.lang.Object data) Return the vertex with the given data.
Vertex	findById(java.lang.Number id) Return the vertex with the given id.
Vertex	findByName(java.lang.String name) Return the vertex with the given name.
java.util.List	findByNativeQuery(java.lang.String sql, java.lang.Class type, int max) Execute the native query.
Data	findData(Data data) Return the lob data.
Bot	getBot() Return the associated Bot instance.
javax.persistence.criteria.CriteriaBuilder	getCriteriaBuilder() Return a query builder.
Network	getParent() Return the parent network.
void	importMerge(Vertex source, java.util.Map<Vertex,Vertex> identitySet) Merge the vertex into this network from an import.
boolean	isReadOnly()
void	merge(Network network) Merge the vertices and relations of the network into the source network.
void	merge(Vertex source) Merge the vertex into this network.
void	removeProperty(java.lang.String propertyName) Remove the property setting to the current transaction.
void	removeRelationship(Relationship relationship) Remove the relationship from the network.
void	removeVertex(Vertex vertex) Remove the vertex from the network.
void	removeVertexAndReferences(Vertex vertex) Remove the vertex and all references to it from the network.
void	resume() Resume after a merge/save.
void	save() Merge the memory into the long term.
void	saveProperty(java.lang.String propertyName, java.lang.String value, boolean startup) Save the property setting to the current transaction.
java.util.List	search(javax.persistence.criteria.CriteriaQuery criteria, int page, int max) Execute the criteria query.
void	setBot(Bot Bot) Set the associated Bot instance.
void	setParent(Network parent) Set the parent network.
int	size() Return the total number of vertices stored.

Method Detail

resume

void resume()

Resume after a merge/save.

save

void save()

Merge the memory into the long 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.

isReadOnly

boolean isReadOnly()

createVertex

Vertex createVertex()

Create a new vertex in this network, assign the id.

createTemporyVertex

Vertex createTemporyVertex()

Create a temporary, non-persistent vertex.

addVertex

void addVertex(Vertex vertex)

Register the vertex with the network.

createVertex

Vertex createVertex(Vertex vertex)

Return the matching registered vertex, or register if missing.

createVertex

Vertex createVertex(java.lang.Object data)

Create a new vertex in this network with the data. If a vertex with the data already exists, then it is return as the data must be unique. If new a new vertex is created and a unique id assigned.

createMeta

Vertex createMeta(Relationship relationship)

Return the relationship meta vertex.

createTimestamp

Vertex createTimestamp()

Create a timestamp based on the current nanos.

removeVertexAndReferences

void removeVertexAndReferences(Vertex vertex)

Remove the vertex and all references to it from the network.

removeVertex

void removeVertex(Vertex vertex)

Remove the vertex from the network. Note that the vertex must be no longer referenced by any other vertex in the network.

removeRelationship

void removeRelationship(Relationship relationship)

Remove the relationship from the network. Note that the relationship must be no longer referenced by any other vertex in the network.

findAll

java.util.List<Vertex> findAll()

Return all vertices.

findAll

java.util.List<Vertex> findAll(int pageSize,
                               int page)

Return all vertices.

findAllLike

java.util.List<Vertex> findAllLike(java.lang.String filter)

Return all vertices matching the filter.

findAllLike

java.util.List<Vertex> findAllLike(java.lang.String filter,
                                   int pageSize,
                                   int page)

Return all vertices matching the filter.

findAllQuery

java.util.List findAllQuery(java.lang.String query)

Return all vertices matching the query.

findAllQuery

java.util.List findAllQuery(java.lang.String query,
                            java.util.Map parameters,
                            int pageSize,
                            int page)

Return all vertices matching the query.

countAll

int countAll()

Return count of all vertices.

countAllLike

int countAllLike(java.lang.String filter)

Return count of vertices matching the filter.

findAllQuery

java.util.List findAllQuery(java.lang.String query,
                            int max)

Return all vertices matching the query.

findByNativeQuery

java.util.List findByNativeQuery(java.lang.String sql,
                                 java.lang.Class type,
                                 int max)

Execute the native query.

executeNativeQuery

int executeNativeQuery(java.lang.String sql)

Execute and commit the native query.

executeQuery

int executeQuery(java.lang.String jpql)

Execute and commit the update query.

findAllInstances

java.util.List<Vertex> findAllInstances(Vertex type,
                                        Vertex relationship,
                                        java.util.Calendar start)

Find all relationships related to the vertex or of the vertex type.

getCriteriaBuilder

javax.persistence.criteria.CriteriaBuilder getCriteriaBuilder()

Return a query builder.

search

java.util.List search(javax.persistence.criteria.CriteriaQuery criteria,
                      int page,
                      int max)

Execute the criteria query.

findAllRelationshipsTo

java.util.List<Relationship> findAllRelationshipsTo(Vertex vertex)

Find all relationships related to the vertex or of the vertex relationship type.

findAllRelationshipsTo

java.util.List<Relationship> findAllRelationshipsTo(Vertex vertex,
                                                    Vertex type)

Find all relationships related to the vertex by the type.

findAllRelationshipsTo

java.util.List<Relationship> findAllRelationshipsTo(Vertex vertex,
                                                    Vertex type,
                                                    java.util.Date date)

Find all relationships related to the vertex by the type.

findByData

Vertex findByData(java.lang.Object data)

Return the vertex with the given data.

findData

Data findData(Data data)

Return the lob data.

findByName

Vertex findByName(java.lang.String name)

Return the vertex with the given name.

findById

Vertex findById(java.lang.Number id)

Return the vertex with the given id.

getParent

Network getParent()

Return the parent network. A network is essentially a nested-transactional sub-graph of the parent.

setParent

void setParent(Network parent)

Set the parent network. A network is essentially a nested-transactional sub-graph of the parent.

merge

void merge(Network network)

Merge the vertices and relations of the network into the source network.

merge

void merge(Vertex source)

Merge the vertex into this network.

importMerge

void importMerge(Vertex source,
                 java.util.Map<Vertex,Vertex> identitySet)

Merge the vertex into this network from an import. This is used from importing another memory.

size

int size()

Return the total number of vertices stored.

associateCaseInsensitivity

void associateCaseInsensitivity(Vertex word)

Associate alternative cases of the word with the meaning, type, tense, etc..

associateCaseInsensitivity

void associateCaseInsensitivity(java.lang.String word,
                                Vertex meaning)

Associate alternative cases of the word with the meaning.

clear

void clear()

Clear all vertices from the network.

createInstance

Vertex createInstance(Primitive type)

Create a new instance of the type.

createInstance

Vertex createInstance(Vertex type)

Create a new instance of the type.

createWord

Vertex createWord(java.lang.String text)

Tokenize the text into its words and create a vertex representation of the word or compound word.

createFragment

Vertex createFragment(java.lang.String text)

Tokenize the text into its words and create a vertex representation of the sentence fragment.

createSentence

Vertex createSentence(java.lang.String text)

Tokenize the sentence into its words and create a vertex representation.

createPattern

Vertex createPattern(java.lang.String text,
                     SelfCompiler compiler)

Tokenize the sentence pattern into its words and wildcrads, and create a vertex representation.

createPattern

Vertex createPattern(java.lang.String text)

Tokenize the sentence pattern into its words and wildcrads, and create a vertex representation.

createFormula

Vertex createFormula(java.lang.String text)

Compile the forumla response.

createTemplate

Vertex createTemplate(java.lang.String text)

Compile the template response.

createSentence

Vertex createSentence(java.lang.String text,
                      boolean generated)

Tokenize the sentence into its words and create a vertex representation.

createSentence

Vertex createSentence(java.lang.String text,
                      boolean generated,
                      boolean reduced)

Tokenize the sentence into its words and create a vertex representation.

createSentence

Vertex createSentence(java.lang.String text,
                      boolean generated,
                      boolean reduced,
                      boolean whitespace)

Tokenize the sentence into its words and create a vertex representation.

createParagraph

Vertex createParagraph(Vertex sentence)

Convert the sentence to a paragraph if it has multiple phrases.

createParagraph

Vertex createParagraph(java.lang.String text)

Tokenize the paragraph into its sentences and create a vertex representation.

createObject

Vertex createObject(java.lang.String name)

Create the word, and its meaning. If the word or meaning exist, use the existing one.

createPrimitive

Vertex createPrimitive(java.lang.String name)

Create the primitive and associate the word to it.

createNewObject

Vertex createNewObject(java.lang.String name)

Create the word, and a new meaning.

createAnonymousSpeaker

Vertex createAnonymousSpeaker()

Create a new anonymous speaker.

createSpeaker

Vertex createSpeaker(java.lang.String name)

Find or create the speaker with the name.

createUniqueSpeaker

Vertex createUniqueSpeaker(Primitive id,
                           Primitive type,
                           java.lang.String name)

Find or create the speaker from the unique id.

createName

Vertex createName(java.lang.String name)

Find or create the speaker with the name.

checkReduction

void checkReduction(Vertex sentence)

Check if the sentence has been reduced, if not, then reduce.

saveProperty

void saveProperty(java.lang.String propertyName,
                  java.lang.String value,
                  boolean startup)

Save the property setting to the current transaction.

removeProperty

void removeProperty(java.lang.String propertyName)

Remove the property setting to the current transaction.

getBot

Bot getBot()

Return the associated Bot instance.

setBot

void setBot(Bot Bot)

Set the associated Bot instance.