org.botlibre.knowledge

Class AbstractNetwork

java.lang.Object

org.botlibre.knowledge.AbstractNetwork

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Network

Direct Known Subclasses:

BasicNetwork, DatabaseNetwork

public abstract class AbstractNetwork
extends java.lang.Object
implements Network, java.lang.Cloneable, java.io.Serializable

An interconnected set of vertices, representing and knowledge-space. Basic implementation to allow subclasses to avoid defining some of the basic stuff.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SIZE
static int	MAX_TEXT Define max text size for data value.

Constructor Summary

Constructors

Constructor and Description
AbstractNetwork(boolean isShortTerm)

Method Summary

Modifier and Type	Method and Description
abstract 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, types, conjugations.
void	checkReduction(Vertex sentence) Check if the sentence has been reduced, if not, then reduce.
AbstractNetwork	clone() Return a copy of the network.
Vertex	createAnonymousSpeaker() Create a new anonymous speaker.
Vertex	createFormula(java.lang.String code) Compile the forumla response.
Vertex	createFragment(java.lang.String text) Tokenize the fragment into its words and create a vertex representation.
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 text) Create the word as a 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 reduction) Tokenize the sentence into its words and create a vertex representation.
Vertex	createSentence(java.lang.String text, boolean generated, boolean reduction, 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 code) 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 and creation date.
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 returned as the data must be unique.
Vertex	createVertex(Vertex source) Create a new vertex from the source.
Vertex	createWord(java.lang.String text) Tokenize the text into its words and create a vertex representation of the word or compound word.
Bot	getBot() Return the associated Bot instance.
java.util.Map<java.lang.Object,Vertex>	getVerticesByData()
void	importMerge(Vertex source, java.util.Map<Vertex,Vertex> identitySet) Merge the vertex into this network from an import.
Vertex	importVertex(Vertex source, java.util.Map<Vertex,Vertex> identitySet) Find the vertex matching the source, or create a new one.
boolean	isReadOnly()
boolean	isShortTerm()
void	merge(Network network) Merge the vertices and relations of the network into this network.
void	merge(Vertex sourceVertex) Merge the vertex into this network.
void	parseFragment(Vertex fragment, java.lang.String text, boolean generated, boolean whitespace) Tokenize the fragment into its words and create a vertex representation.
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	saveProperty(java.lang.String propertyName, java.lang.String value, boolean startup) Save the property setting to the current transaction.
void	setBot(Bot bot) Set the associated Bot instance.
void	setShortTerm(boolean isShortTerm)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.botlibre.api.knowledge.Network

clear, countAll, countAllLike, executeNativeQuery, executeQuery, findAll, findAll, findAllInstances, findAllLike, findAllLike, findAllQuery, findAllQuery, findAllQuery, findAllRelationshipsTo, findAllRelationshipsTo, findAllRelationshipsTo, findByData, findById, findByName, findByNativeQuery, findData, getCriteriaBuilder, getParent, removeVertex, removeVertexAndReferences, resume, save, search, setParent, size

Field Detail

MAX_TEXT

public static final int MAX_TEXT

Define max text size for data value.

See Also:

Constant Field Values

MAX_SIZE

public static int MAX_SIZE

Constructor Detail

AbstractNetwork

public AbstractNetwork(boolean isShortTerm)

Method Detail

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface Network

getVerticesByData

public java.util.Map<java.lang.Object,Vertex> getVerticesByData()

saveProperty

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

Save the property setting to the current transaction.

Specified by:

saveProperty in interface Network

removeProperty

public void removeProperty(java.lang.String propertyName)

Remove the property setting to the current transaction.

Specified by:

removeProperty in interface Network

clone

public AbstractNetwork clone()

Return a copy of the network.

Overrides:

clone in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addVertex

public abstract void addVertex(Vertex vertex)

Description copied from interface: Network

Register the vertex with the network.

Specified by:

addVertex in interface Network

createVertex

public Vertex createVertex()

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

Specified by:

createVertex in interface Network

createTemporyVertex

public Vertex createTemporyVertex()

Create a temporary, non-persistent vertex.

Specified by:

createTemporyVertex in interface Network

createVertex

public Vertex createVertex(Vertex source)

Create a new vertex from the source. The source is from another network.

Specified by:

createVertex in interface Network

createVertex

public 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 returned as the data must be unique.

Specified by:

createVertex in interface Network

merge

public void merge(Network network)

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

Specified by:

merge in interface Network

merge

public void merge(Vertex sourceVertex)

Merge the vertex into this network.

Specified by:

merge in interface Network

importVertex

public Vertex importVertex(Vertex source,
                           java.util.Map<Vertex,Vertex> identitySet)

Find the vertex matching the source, or create a new one. This is used from importing another memory.

importMerge

public 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.

Specified by:

importMerge in interface Network

removeRelationship

public 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.

Specified by:

removeRelationship in interface Network

createMeta

public Vertex createMeta(Relationship relationship)

Return the relationship meta vertex.

Specified by:

createMeta in interface Network

createInstance

public Vertex createInstance(Primitive type)

Create a new instance of the type.

Specified by:

createInstance in interface Network

createInstance

public Vertex createInstance(Vertex type)

Create a new instance of the type.

Specified by:

createInstance in interface Network

createWord

public Vertex createWord(java.lang.String text)

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

Specified by:

createWord in interface Network

createName

public Vertex createName(java.lang.String text)

Create the word as a name.

Specified by:

createName in interface Network

associateCaseInsensitivity

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

Associate alternative cases of the word with the meaning.

Specified by:

associateCaseInsensitivity in interface Network

associateCaseInsensitivity

public void associateCaseInsensitivity(Vertex word)

Associate alternative cases of the word with the meaning, types, conjugations.

Specified by:

associateCaseInsensitivity in interface Network

createParagraph

public Vertex createParagraph(Vertex sentence)

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

Specified by:

createParagraph in interface Network

createParagraph

public Vertex createParagraph(java.lang.String text)

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

Specified by:

createParagraph in interface Network

createSentence

public Vertex createSentence(java.lang.String text)

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

Specified by:

createSentence in interface Network

createPattern

public Vertex createPattern(java.lang.String text)

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

Specified by:

createPattern in interface Network

createPattern

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

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

Specified by:

createPattern in interface Network

createSentence

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

Tokenize the sentence into its words and create a vertex representation. If the sentence was generated, then don't add prev/next.

Specified by:

createSentence in interface Network

createSentence

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

Tokenize the sentence into its words and create a vertex representation. If the sentence was generated, then don't add prev/next.

Specified by:

createSentence in interface Network

createTemplate

public Vertex createTemplate(java.lang.String code)

Compile the template response.

Specified by:

createTemplate in interface Network

createFormula

public Vertex createFormula(java.lang.String code)

Compile the forumla response.

Specified by:

createFormula in interface Network

createSentence

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

Tokenize the sentence into its words and create a vertex representation. If the sentence was generated, then don't add prev/next.

Specified by:

createSentence in interface Network

checkReduction

public void checkReduction(Vertex sentence)

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

Specified by:

checkReduction in interface Network

createFragment

public Vertex createFragment(java.lang.String text)

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

Specified by:

createFragment in interface Network

parseFragment

public void parseFragment(Vertex fragment,
                          java.lang.String text,
                          boolean generated,
                          boolean whitespace)

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

createObject

public Vertex createObject(java.lang.String name)

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

Specified by:

createObject in interface Network

createPrimitive

public Vertex createPrimitive(java.lang.String name)

Create the primitive and associate the word to it.

Specified by:

createPrimitive in interface Network

createNewObject

public Vertex createNewObject(java.lang.String name)

Create the word, and a new meaning.

Specified by:

createNewObject in interface Network

createSpeaker

public Vertex createSpeaker(java.lang.String name)

Find or create the speaker with the name.

Specified by:

createSpeaker in interface Network

createUniqueSpeaker

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

Find or create the speaker from the unique id.

Specified by:

createUniqueSpeaker in interface Network

createAnonymousSpeaker

public Vertex createAnonymousSpeaker()

Create a new anonymous speaker.

Specified by:

createAnonymousSpeaker in interface Network

createTimestamp

public Vertex createTimestamp()

Create a timestamp based on the current nanos.

Specified by:

createTimestamp in interface Network

getBot

public Bot getBot()

Return the associated Bot instance.

Specified by:

getBot in interface Network

setBot

public void setBot(Bot bot)

Set the associated Bot instance.

Specified by:

setBot in interface Network

isShortTerm

public boolean isShortTerm()

setShortTerm

public void setShortTerm(boolean isShortTerm)