org.botlibre.api.knowledge

Interface Relationship

All Superinterfaces:

java.lang.Comparable<Relationship>

All Known Implementing Classes:

BasicRelationship

public interface Relationship
extends java.lang.Comparable<Relationship>

Relationship between two vertices. The relation itself is a vertex as it has an identity associated to it, and the relation may be related to other relations/vertices.

Method Summary

Modifier and Type	Method and Description
boolean	checkHashCode()
void	decrementConsciousnessLevel() Decrease the relationship's level of consciousness.
void	decrementConsciousnessLevel(int amount) Decrease the relationship's level of consciousness by the amount.
int	getAccessCount() Return the number of times the relationship has been accessed.
java.util.Date	getAccessDate() Return the date the relationship was last accessed.
int	getConsciousnessLevel() Return the relationship's level of consciousness.
float	getCorrectness() Return the fuzzy value of the certainty of the relationship's correctness.
java.util.Date	getCreationDate() Return the date the relationship was created.
java.lang.Long	getId()
int	getIndex() Return the index of the relationships in the source's relationships of that type.
Vertex	getMeta()
Vertex	getSource()
Vertex	getTarget()
Vertex	getType()
boolean	hasIndex() Return if the relationship has an index (preset order).
boolean	hasMeta()
void	incrementAccessCount() Record that the relationship was accessed, update the access time and increment the access count.
void	incrementConsciousnessLevel() Increase the relationship's level of consciousness.
void	incrementConsciousnessLevel(int amount) Increase the relationship's level of consciousness by the amount.
boolean	isInverse() Return if the relationship is inverse, i.e.
boolean	isPinned() Return if the relationship is pinned to memory, and will not be forgotten.
void	setAccessCount(int accessCount) Set the number of times the relationship has been accessed.
void	setAccessDate(java.util.Date accessDate) Set the date the relationship was last accessed.
void	setConsciousnessLevel(int consciousnessLevel) Set the relationship's level of consciousness.
void	setCorrectness(float correctness) Set the fuzzy value of the certainty of the relationship's correctness.
void	setCreationDate(java.util.Date creationDate) Set the date the relationship was created.
void	setId(java.lang.Long id) Set the relationship id.
void	setIndex(int index) Set the index of the relationships in the source's relationships of that type.
void	setMeta(Vertex meta)
void	setPinned(boolean pinned) Set if the relationship should be pinned to memory.
void	setSource(Vertex source)
void	setTarget(Vertex target)
void	setType(Vertex type)

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

java.lang.Long getId()

getSource

Vertex getSource()

getTarget

Vertex getTarget()

getType

Vertex getType()

getMeta

Vertex getMeta()

hasMeta

boolean hasMeta()

getCorrectness

float getCorrectness()

Return the fuzzy value of the certainty of the relationship's correctness. Values are between 0 and 1.

setCorrectness

void setCorrectness(float correctness)

Set the fuzzy value of the certainty of the relationship's correctness. Values are between 0 and 1.

isInverse

boolean isInverse()

Return if the relationship is inverse, i.e. know to not exist.

setId

void setId(java.lang.Long id)

Set the relationship id. The id can only be set when loading or creating a relationship.

setSource

void setSource(Vertex source)

setTarget

void setTarget(Vertex target)

setType

void setType(Vertex type)

setMeta

void setMeta(Vertex meta)

getIndex

int getIndex()

Return the index of the relationships in the source's relationships of that type.

setIndex

void setIndex(int index)

Set the index of the relationships in the source's relationships of that type.

hasIndex

boolean hasIndex()

Return if the relationship has an index (preset order).

getCreationDate

java.util.Date getCreationDate()

Return the date the relationship was created.

setCreationDate

void setCreationDate(java.util.Date creationDate)

Set the date the relationship was created.

getAccessDate

java.util.Date getAccessDate()

Return the date the relationship was last accessed.

setAccessDate

void setAccessDate(java.util.Date accessDate)

Set the date the relationship was last accessed.

getAccessCount

int getAccessCount()

Return the number of times the relationship has been accessed.

setAccessCount

void setAccessCount(int accessCount)

Set the number of times the relationship has been accessed.

incrementAccessCount

void incrementAccessCount()

Record that the relationship was accessed, update the access time and increment the access count.

incrementConsciousnessLevel

void incrementConsciousnessLevel()

Increase the relationship's level of consciousness.

incrementConsciousnessLevel

void incrementConsciousnessLevel(int amount)

Increase the relationship's level of consciousness by the amount.

decrementConsciousnessLevel

void decrementConsciousnessLevel()

Decrease the relationship's level of consciousness.

decrementConsciousnessLevel

void decrementConsciousnessLevel(int amount)

Decrease the relationship's level of consciousness by the amount.

getConsciousnessLevel

int getConsciousnessLevel()

Return the relationship's level of consciousness.

setConsciousnessLevel

void setConsciousnessLevel(int consciousnessLevel)

Set the relationship's level of consciousness.

isPinned

boolean isPinned()

Return if the relationship is pinned to memory, and will not be forgotten.

setPinned

void setPinned(boolean pinned)

Set if the relationship should be pinned to memory. Pinned relationship will not be forgotten.

checkHashCode

boolean checkHashCode()