gov.nasa.arc.brahms.vm.api.components
Interface IWorldState

public interface IWorldState

Each Brahms virtual machine has one world state component. The world state component in the virtual machine is responsible for maintaining the fact set. All agents and objects share the same fact set. The fact set defines the state of the world by means of object attribute values and object relations. The facts in the world are the states in the world that can be detected by agents and objects (active instances). The objects also use the facts in the world to reason with. The preconditions defined for the work of an object are evaluated based on facts instead of beliefs as with agents. The world state is responsible for distributing the fact to all the agents and objects in the virtual machine. In a simulation environment the world state posts the fact on the agents or objects event queues. The assertion of the fact in the world state and the distribution of this fact to all agents and objects must happen synchronously. In simulation mode agents or objects are not allowed to process their event queues until they received the new fact. In an intelligent agent environment the new fact immediately triggers the reasoning process for an object if the fact is relevant for the work of the object. The fact set as defined in the world state is also used to initialize agents and objects that are dynamically loaded during a simulation or intelligent agent session.

Version:

$Revision: 1.8 $ $Date: 2009/11/29 21:46:36 $ $Author: rnado $

Author:

Ron van Hoof

Method Summary

void	addFactRelationConcept(IConcept lhsConcept, java.lang.String relationName, IConcept rhsConcept, IContext ctx) Adds a concept as a value of a named relation for a concept by asserting a new fact into the world state.
void	assertFact(IFact fact, IContext ctx) Schedules the assertion of the specified fact into the world state including the distribution of the fact to all agents and objects.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, boolean value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, byte value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, char value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, double value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, float value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IConcept value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, int value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, boolean value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, byte value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, char value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, double value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, float value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, IConcept value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, int value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, IUnknown value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, long value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, java.lang.Object value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, java.io.Serializable value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, short value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, java.lang.String value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IUnknown value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, long value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.lang.Object value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.io.Serializable value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, short value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.lang.String value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, boolean value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, byte value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, char value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, double value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, float value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, IConcept value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, int value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, IUnknown value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, long value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, java.lang.Object value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, java.io.Serializable value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, short value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, java.lang.String value) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IRelation relation, IConcept rhsConcept, int truthValue) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFact(IConcept lhsConcept, IRelation relation, IUnknown rhsConcept, int truthValue) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
boolean	getFactAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName) Retrieves a boolean value for an attribute of a concept from a fact in the world state
boolean	getFactAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a boolean value for a collection attribute of a concept at a given integer index from a fact in the world state
boolean	getFactAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a boolean value for a collection attribute of a concept at a given String key from a fact in the world state
byte	getFactAttributeByte(IConcept lhsConcept, java.lang.String attributeName) Retrieves a byte value for an attribute of a concept from a fact in the world state
byte	getFactAttributeByte(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a byte value for a collection attribute of a concept at a given integer index from a fact in the world state
byte	getFactAttributeByte(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a byte value for a collection attribute of a concept at a given String key from a fact in the world state
char	getFactAttributeChar(IConcept lhsConcept, java.lang.String attributeName) Retrieves a char value for an attribute of a concept from a fact in the world state
char	getFactAttributeChar(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a char value for a collection attribute of a concept at a given integer index from a fact in the world state
char	getFactAttributeChar(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a char value for a collection attribute of a concept at a given String key from a fact in the world state
IConcept	getFactAttributeConcept(IConcept lhsConcept, java.lang.String attributeName) Retrieves an IConcept value for an attribute of a concept from a fact in the world state
IConcept	getFactAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves an IConcept value for a collection attribute of a concept at a given integer index from a fact in the world state
IConcept	getFactAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves an IConcept value for a collection attribute of a concept at a given String key from a fact in the world state
double	getFactAttributeDouble(IConcept lhsConcept, java.lang.String attributeName) Retrieves a double value for an attribute of a concept from a fact in the world state
double	getFactAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a double value for a collection attribute of a concept at a given integer index from a fact in the world state
double	getFactAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a double value for a collection attribute of a concept at a given String key from a fact in the world state
float	getFactAttributeFloat(IConcept lhsConcept, java.lang.String attributeName) Retrieves a float value for an attribute of a concept from a fact in the world state
float	getFactAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a float value for a collection attribute of a concept at a given integer index from a fact in the world state
float	getFactAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a float value for a collection attribute of a concept at a given String key from a fact in the world state
int	getFactAttributeInt(IConcept lhsConcept, java.lang.String attributeName) Retrieves an int value for an attribute of a concept from a fact in the world state
int	getFactAttributeInt(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves an int value for a collection attribute of a concept at a given integer index from a fact in the world state
int	getFactAttributeInt(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves an int value for a collection attribute of a concept at a given String key from a fact in the world state
java.io.Serializable	getFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName) Retrieves a Java Serializable value for an attribute of a concept from a fact in the world state
java.io.Serializable	getFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a Serializable value for a collection attribute of a concept at a given integer index from a fact in the world state
java.io.Serializable	getFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a Serializable value for a collection attribute of a concept at a given String key from a fact in the world state
long	getFactAttributeLong(IConcept lhsConcept, java.lang.String attributeName) Retrieves a long value for an attribute of a concept from a fact in the world state
long	getFactAttributeLong(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a long value for a collection attribute of a concept at a given integer index from a fact in the world state
long	getFactAttributeLong(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a long value for a collection attribute of a concept at a given String key from a fact in the world state
java.util.Map<java.lang.Object,java.lang.Object>	getFactAttributeMap(IConcept lhsConcept, java.lang.String attributeName, boolean includeUnknown) Returns a Map representing the values for a map attribute of a concept from facts in the world state Entries with values of unknown are included in the returned Map if the includeUnknown parameter is true.
short	getFactAttributeShort(IConcept lhsConcept, java.lang.String attributeName) Retrieves a short value for an attribute of a concept from a fact in the world state
short	getFactAttributeShort(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a short value for a collection attribute of a concept at a given integer index from a fact in the world state
short	getFactAttributeShort(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a short value for a collection attribute of a concept at a given String key from a fact in the world state
java.util.SortedMap<java.lang.Object,java.lang.Object>	getFactAttributeSortedMap(IConcept lhsConcept, java.lang.String attributeName, boolean includeUnknown) Returns a sorted Map representing the values for a map attribute of a concept from facts in the world state Entries with values of unknown are included in the returned Map if the includeUnknown parameter is true.
java.lang.String	getFactAttributeString(IConcept lhsConcept, java.lang.String attributeName) Retrieves a String value for an attribute of a concept from a fact in the world state The attribute's Brahms type may be either string or symbol.
java.lang.String	getFactAttributeString(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves a String value for a collection attribute of a concept at a given integer index from a fact in the world state The Brahms type of the value may be either string or symbol.
java.lang.String	getFactAttributeString(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves a String value for a collection attribute of a concept at a given String key from a fact in the world state The Brahms type of the value may be either string or symbol.
java.lang.Object	getFactAttributeValue(IConcept lhsConcept, java.lang.String attributeName) Retrieves the value for an attribute of a concept from a fact in the world state Returns null if there is no corresponding fact in the world state.
java.lang.Object	getFactAttributeValue(IConcept lhsConcept, java.lang.String attributeName, int index) Retrieves the value for a collection attribute of a concept at a given integer index from a fact in the world state Returns null if there is no corresponding fact in the world state.
java.lang.Object	getFactAttributeValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key) Retrieves the value for a collection attribute of a concept at a given String key from a fact in the world state Returns null if there is no corresponding fact in the world state.
IFact	getFactForIndex(IConcept lhsConcept, IAttribute lhsAttribute, int lhsCollectionIndex, int relop, IContext ctx) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
IFact	getFactForIndex(IConcept lhsConcept, IAttribute lhsAttribute, java.lang.String lhsCollectionIndex, int relop, IContext ctx) Find the fact using the specified parameters and return the fact if found, null if the fact was not found.
java.util.List<IConcept>	getFactRelationConcepts(IConcept lhsConcept, java.lang.String relationName) Retrieves a list of concepts that are related to a given concept by a named relation by inspecting the facts in the current world state.
java.util.Enumeration	getFacts() Returns a list of all the facts in the world state's fact set.
java.util.Enumeration	getFacts(IAttribute attribute) Returns a list of all the facts that have the specified attribute regardless of the lhs concept, relational operator and right hand side value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute) Returns a list of all the facts that have the specified concept and attribute on their left hand side regardless of their relational operator or value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop) Returns a list of all the facts that have the specified concept and attribute on their left hand side and that use the specified relational operator.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, boolean value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, byte value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, char value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, double value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, float value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IConcept value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, int value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, IUnknown value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, long value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.lang.Object value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.io.Serializable value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, short value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IAttribute lhsAttribute, int relop, java.lang.String value) Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value.
java.util.Enumeration	getFacts(IConcept lhsConcept, IRelation relation) Returns a list of all the facts that have the specified left hand side concept and relation regardless of their right hand side concept.
java.util.Enumeration	getFacts(IConcept lhsConcept, IRelation relation, int truthValue) Returns a list of all the facts that have the specified left hand side concept, relation and truth value regardless of their right hand side concept.
java.util.Enumeration	getFacts(IRelation relation) Returns a list of all the facts that have the specified relation regardless of their left and right hand side concept.
java.util.Enumeration	getFacts(IRelation relation, IConcept rhsConcept, int truthValue) Returns a list of all the facts that have the specified relation and right hand side concept, and truth value regardless of their left hand side concept.
java.util.Enumeration	getFacts(IRelation relation, IUnknown rhsConcept, int truthValue) Returns a list of all the facts that have the specified relation, as right hand side 'unknown', and the specified truth value regardless of their left hand side concept.
boolean	hasFactAttributeAnyValue(IConcept lhsConcept, java.lang.String attributeName, boolean includeUnknown) Tests whether a concept has any value for a named attribute based on the facts in the world state.
boolean	hasFactAttributeAnyValue(IConcept lhsConcept, java.lang.String attributeName, int index, boolean includeUnknown) Tests whether a concept has any value for a named collection attribute at a given integer index based on the facts in the world state.
boolean	hasFactAttributeAnyValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, boolean includeUnknown) Tests whether a concept has any value for a named collection attribute at a given String key based on the facts in the world state.
boolean	hasFactAttributeValue(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.Object value) Tests whether a concept has a specified value for a named collection attribute at an int index based on the facts in the world state.
boolean	hasFactAttributeValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.Object value) Tests whether a concept has a specified value for a named attribute based on the facts in the world state.
boolean	hasFactAttributeValue(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.Object value) Tests whether a concept has a specified value for a named collection attribute at a String key based on the facts in the world state.
boolean	hasFactRelationAnyValue(IConcept lhsConcept, java.lang.String relationName, boolean includeUnknown) Tests whether there are any true facts for a given concept and named relation in the current world state.
boolean	hasFactRelationValue(IConcept lhsConcept, java.lang.String relationName, java.lang.Object value) Tests whether a concept is related to a value by a named relation by inspecting the facts in the current world state.
java.util.List<IConcept>	removeAllFactRelationValues(IConcept lhsConcept, java.lang.String relationName, IContext ctx) Removes any existing concepts as values of a named relation for a concept by retracting facts from the world state.
void	removeFactRelationConcept(IConcept lhsConcept, java.lang.String relationName, IConcept rhsConcept, IContext ctx) Removes a concept as a value of a named relation for a concept by retracting the corresponding fact from the world state.
void	retractFact(IFact fact, IContext ctx) Schedules the retraction of the specified fact from the world state including the notification of the retraction to all agents and objects.
void	setFactAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, boolean value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified boolean value for a named attribute
void	setFactAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, int index, boolean value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified boolean value for a named collection attribute at an int index
void	setFactAttributeBoolean(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, boolean value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified boolean value for a named collection attribute at a String key
void	setFactAttributeByte(IConcept lhsConcept, java.lang.String attributeName, byte value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified byte value for a named attribute
void	setFactAttributeByte(IConcept lhsConcept, java.lang.String attributeName, int index, byte value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified byte value for a named collection attribute at an int index
void	setFactAttributeByte(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, byte value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified byte value for a named collection attribute at a String key
void	setFactAttributeChar(IConcept lhsConcept, java.lang.String attributeName, char value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified char value for a named attribute
void	setFactAttributeChar(IConcept lhsConcept, java.lang.String attributeName, int index, char value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified char value for a named collection attribute at an int index
void	setFactAttributeChar(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, char value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified char value for a named collection attribute at a String key
void	setFactAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, IConcept value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified IConcept value for a named attribute
void	setFactAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, int index, IConcept value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified IConcept value for a named collection attribute at an int index
void	setFactAttributeConcept(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IConcept value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified IConcept value for a named collection attribute at a String key
void	setFactAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, double value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified double value for a named attribute
void	setFactAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, int index, double value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified double value for a named collection attribute at an int index
void	setFactAttributeDouble(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, double value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified double value for a named collection attribute at a String key
void	setFactAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, float value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified float value for a named attribute
void	setFactAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, int index, float value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified float value for a named collection attribute at an int index
void	setFactAttributeFloat(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, float value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified float value for a named collection attribute at a String key
void	setFactAttributeInt(IConcept lhsConcept, java.lang.String attributeName, int value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified int value for a named attribute
void	setFactAttributeInt(IConcept lhsConcept, java.lang.String attributeName, int index, int value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified int value for a named collection attribute at an int index
void	setFactAttributeInt(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, int value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified int value for a named collection attribute at a String key
void	setFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.Object value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Object value for a named collection attribute at an int index
void	setFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, int index, java.io.Serializable value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Serializable value for a named collection attribute at an int index
void	setFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.Object value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Object value for a named attribute
void	setFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.io.Serializable value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Serializable value for a named attribute
void	setFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.Object value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Object value for a named collection attribute at a String key
void	setFactAttributeJava(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.io.Serializable value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Serializable value for a named collection attribute at a String key
void	setFactAttributeLong(IConcept lhsConcept, java.lang.String attributeName, int index, long value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified long value for a named collection attribute at an int index
void	setFactAttributeLong(IConcept lhsConcept, java.lang.String attributeName, long value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified long value for a named attribute
void	setFactAttributeLong(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, long value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified long value for a named collection attribute at a String key
void	setFactAttributeShort(IConcept lhsConcept, java.lang.String attributeName, int index, short value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified short value for a named collection attribute at an int index
void	setFactAttributeShort(IConcept lhsConcept, java.lang.String attributeName, short value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified short value for a named attribute
void	setFactAttributeShort(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, short value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified short value for a named collection attribute at a String key
void	setFactAttributeString(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.String value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified string value for a named collection attribute at an int index
void	setFactAttributeString(IConcept lhsConcept, java.lang.String attributeName, java.lang.String value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified string value for a named attribute
void	setFactAttributeString(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.String value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified string value for a named collection attribute at a String key
void	setFactAttributeSymbol(IConcept lhsConcept, java.lang.String attributeName, int index, java.lang.String value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified symbol value for a named collection attribute at an int index
void	setFactAttributeSymbol(IConcept lhsConcept, java.lang.String attributeName, java.lang.String value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified symbol value for a named attribute
void	setFactAttributeSymbol(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, java.lang.String value, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has a specified symbol value for a named collection attribute at a String key
void	setFactAttributeUnknown(IConcept lhsConcept, java.lang.String attributeName, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has the unknown value for a named attribute
void	setFactAttributeUnknown(IConcept lhsConcept, java.lang.String attributeName, int index, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has the unknown value for a named collection attribute at an int index
void	setFactAttributeUnknown(IConcept lhsConcept, java.lang.String attributeName, java.lang.String key, IContext ctx) Creates and asserts a new fact in the world state representing that an IConcept has the unknown value for a named collection attribute at a String key
void	setFactRelationUnknown(IConcept lhsConcept, java.lang.String relationName, IContext ctx) Removes any existing concepts as values of a named relation for a concept by giving the relation a value of unknown.

Method Detail

assertFact

void assertFact(IFact fact,
                IContext ctx)
                throws ExternalException

Schedules the assertion of the specified fact into the world state including the distribution of the fact to all agents and objects. The fact is not guaranteed to immediately be asserted in the world state.

Parameters:

fact - the IFact to be asserted

ctx - the IContext for the action

Throws:

ExternalException - if an internal error occurs

retractFact

void retractFact(IFact fact,
                 IContext ctx)
                 throws ExternalException

Schedules the retraction of the specified fact from the world state including the notification of the retraction to all agents and objects. The fact is not guaranteed to immediately be retracted from the world state.

Parameters:

fact - the IFact to be retracted

ctx - the IContext for the action

Throws:

ExternalException - if an internal error occurs

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              int value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side integer value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              char value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side character value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              byte value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side byte value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              short value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side short value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              long value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side long value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              float value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side float value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              double value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side double value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              boolean value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side boolean value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              java.lang.String value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side String or symbol value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              IConcept value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side IConcept value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              java.io.Serializable value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side Java Serializable value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              java.lang.Object value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side Java Object value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int relop,
              IUnknown value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

relop - the relational operator in the requested fact

value - the right hand side 'unknown' value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS, IUnknown.UNKNOWN

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              int value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side integer value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              int value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side integer value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              char value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side character value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              char value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side character value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              byte value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side byte value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              byte value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side byte value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              short value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side short value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              short value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side short value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              long value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side long value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              long value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side long value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              float value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side float value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              float value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side float value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              double value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side double value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              double value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side double value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              boolean value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side boolean value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              boolean value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side boolean value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              java.lang.String value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side String or symbol value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              java.lang.String value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side String or symbol value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IConstants.EQ, IConstants.NE

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              IConcept value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side IConcept value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              IConcept value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side IConcept value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              java.io.Serializable value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side Java Serializable value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              java.io.Serializable value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side Java Serializable value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              java.lang.Object value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side Java Object value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              java.lang.Object value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side Java Object value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              int lhsCollectionIndex,
              int relop,
              IUnknown value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side 'unknown' value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS, IUnknown.UNKNOWN

getFact

IFact getFact(IConcept lhsConcept,
              IAttribute lhsAttribute,
              java.lang.String lhsCollectionIndex,
              int relop,
              IUnknown value)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

value - the right hand side 'unknown' value in the requested fact

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS, IUnknown.UNKNOWN

getFactForIndex

IFact getFactForIndex(IConcept lhsConcept,
                      IAttribute lhsAttribute,
                      int lhsCollectionIndex,
                      int relop,
                      IContext ctx)
                      throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the integer index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

ctx - the IContext for the action

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

MessageNotRepliedToException, IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS, IUnknown.UNKNOWN

getFactForIndex

IFact getFactForIndex(IConcept lhsConcept,
                      IAttribute lhsAttribute,
                      java.lang.String lhsCollectionIndex,
                      int relop,
                      IContext ctx)
                      throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

lhsAttribute - the left hand side IAttribute in the requested fact

lhsCollectionIndex - the String index/key if the attribute's type is a collection

relop - the relational operator in the requested fact

ctx - the IContext for the action

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

MessageNotRepliedToException, IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS, IUnknown.UNKNOWN

getFact

IFact getFact(IConcept lhsConcept,
              IRelation relation,
              IConcept rhsConcept,
              int truthValue)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

relation - the IRelation in the requested fact

rhsConcept - the right hand side IConcept in the requested fact

truthValue - the truth value in the requested fact (TRUE, FALSE, UNKNOWN)

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

ITruthValue.TRUE, ITruthValue.FALSE, ITruthValue.UNKNOWN

getFact

IFact getFact(IConcept lhsConcept,
              IRelation relation,
              IUnknown rhsConcept,
              int truthValue)
              throws ExternalException

Find the fact using the specified parameters and return the fact if found, null if the fact was not found.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact

relation - the IRelation in the requested fact

rhsConcept - the right hand side 'unknown' value in the requested fact

truthValue - the truth value in the requested fact (TRUE, FALSE, UNKNOWN)

Returns:

IFact if the matching fact is found, null otherwise

Throws:

ExternalException - if an internal error occurs

See Also:

IUnknown.UNKNOWN, ITruthValue.TRUE, ITruthValue.FALSE, ITruthValue.UNKNOWN

getFacts

java.util.Enumeration getFacts()
                               throws ExternalException

Returns a list of all the facts in the world state's fact set.

Returns:

Enumeration a list of IFact

Throws:

ExternalException - if an internal error occurs

getFacts

java.util.Enumeration getFacts(IAttribute attribute)
                               throws ExternalException

Returns a list of all the facts that have the specified attribute regardless of the lhs concept, relational operator and right hand side value.

Parameters:

attribute - the IAttribute in the requested fact(s)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side regardless of their relational operator or value.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side and that use the specified relational operator.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               int value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the integer value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               char value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the character value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               byte value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the byte value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               short value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the short value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               long value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the long value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               float value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the float value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               double value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the double value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               boolean value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the boolean value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               java.lang.String value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the String or symbol value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               IConcept value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the IConcept value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               java.io.Serializable value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the Java Serializable value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               java.lang.Object value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the Java Object value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IAttribute lhsAttribute,
                               int relop,
                               IUnknown value)
                               throws ExternalException

Returns a list of all the facts that have the specified concept and attribute on their left hand side, that use the specified relational operator and have the specified rhs value. Multiple facts can only be returned if the attribute is of a collection type and the value is matched for multiple different indexes/keys.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

lhsAttribute - the left hand side IAttribute in the requested fact(s)

relop - the relational operator in the requested fact(s)

value - the IUnknown value to match

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IRelationalOperator.EQUALS, IRelationalOperator.NOT_EQUALS

getFacts

java.util.Enumeration getFacts(IRelation relation)
                               throws ExternalException

Returns a list of all the facts that have the specified relation regardless of their left and right hand side concept.

Parameters:

relation - the IRelation in the requested fact(s)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IRelation relation)
                               throws ExternalException

Returns a list of all the facts that have the specified left hand side concept and relation regardless of their right hand side concept.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

relation - the IRelation in the requested fact(s)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

getFacts

java.util.Enumeration getFacts(IConcept lhsConcept,
                               IRelation relation,
                               int truthValue)
                               throws ExternalException

Returns a list of all the facts that have the specified left hand side concept, relation and truth value regardless of their right hand side concept.

Parameters:

lhsConcept - the left hand side IConcept in the requested fact(s)

relation - the IRelation in the requested fact(s)

truthValue - the truth value in the requested fact(s) (TRUE, FALSE, UNKNOWN)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

ITruthValue.TRUE, ITruthValue.FALSE, ITruthValue.UNKNOWN

getFacts

java.util.Enumeration getFacts(IRelation relation,
                               IConcept rhsConcept,
                               int truthValue)
                               throws ExternalException

Returns a list of all the facts that have the specified relation and right hand side concept, and truth value regardless of their left hand side concept.

Parameters:

relation - the IRelation in the requested fact(s)

rhsConcept - the right hand side IConcept in the requested fact(s)

truthValue - the truth value in the requested fact(s) (TRUE, FALSE, UNKNOWN)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

ITruthValue.TRUE, ITruthValue.FALSE, ITruthValue.UNKNOWN

getFacts

java.util.Enumeration getFacts(IRelation relation,
                               IUnknown rhsConcept,
                               int truthValue)
                               throws ExternalException

Returns a list of all the facts that have the specified relation, as right hand side 'unknown', and the specified truth value regardless of their left hand side concept.

Parameters:

relation - the IRelation in the requested fact(s)

rhsConcept - the right hand side 'unknown' value in the requested fact(s)

truthValue - the truth value in the requested fact(s) (TRUE, FALSE, UNKNOWN)

Returns:

Enumeration a list of IFact's

Throws:

ExternalException - if an internal error occurs

See Also:

IUnknown.UNKNOWN, ITruthValue.TRUE, ITruthValue.FALSE, ITruthValue.UNKNOWN

getFactAttributeInt

int getFactAttributeInt(IConcept lhsConcept,
                        java.lang.String attributeName)
                        throws UnknownValueException,
                               InvalidTypeException,
                               ExternalException

Retrieves an int value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

int the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type int

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeInt

int getFactAttributeInt(IConcept lhsConcept,
                        java.lang.String attributeName,
                        int index)
                        throws UnknownValueException,
                               InvalidTypeException,
                               ExternalException

Retrieves an int value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

int the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type int

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeInt

int getFactAttributeInt(IConcept lhsConcept,
                        java.lang.String attributeName,
                        java.lang.String key)
                        throws UnknownValueException,
                               InvalidTypeException,
                               ExternalException

Retrieves an int value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

int the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type int

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeChar

char getFactAttributeChar(IConcept lhsConcept,
                          java.lang.String attributeName)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a char value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

char the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type char

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeChar

char getFactAttributeChar(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a char value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

char the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type char

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeChar

char getFactAttributeChar(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a char value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

char the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type char

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeByte

byte getFactAttributeByte(IConcept lhsConcept,
                          java.lang.String attributeName)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a byte value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

byte the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type byte

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeByte

byte getFactAttributeByte(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a byte value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

byte the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type byte

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeByte

byte getFactAttributeByte(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a byte value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

byte the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type byte

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeShort

short getFactAttributeShort(IConcept lhsConcept,
                            java.lang.String attributeName)
                            throws UnknownValueException,
                                   InvalidTypeException,
                                   ExternalException

Retrieves a short value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

short the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type short

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeShort

short getFactAttributeShort(IConcept lhsConcept,
                            java.lang.String attributeName,
                            int index)
                            throws UnknownValueException,
                                   InvalidTypeException,
                                   ExternalException

Retrieves a short value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

short the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type short

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeShort

short getFactAttributeShort(IConcept lhsConcept,
                            java.lang.String attributeName,
                            java.lang.String key)
                            throws UnknownValueException,
                                   InvalidTypeException,
                                   ExternalException

Retrieves a short value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

short the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type short

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeLong

long getFactAttributeLong(IConcept lhsConcept,
                          java.lang.String attributeName)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a long value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

long the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type long

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeLong

long getFactAttributeLong(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a long value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

long the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type long

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeLong

long getFactAttributeLong(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key)
                          throws UnknownValueException,
                                 InvalidTypeException,
                                 ExternalException

Retrieves a long value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

long the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type long

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeFloat

float getFactAttributeFloat(IConcept lhsConcept,
                            java.lang.String attributeName)
                            throws UnknownValueException,
                                   InvalidTypeException,
                                   ExternalException

Retrieves a float value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

float the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type float

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeFloat

float getFactAttributeFloat(IConcept lhsConcept,
                            java.lang.String attributeName,
                            int index)
                            throws UnknownValueException,
                                   InvalidTypeException,
                                   ExternalException

Retrieves a float value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

float the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type float

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeFloat

float getFactAttributeFloat(IConcept lhsConcept,
                            java.lang.String attributeName,
                            java.lang.String key)
                            throws UnknownValueException,
                                   InvalidTypeException,
                                   ExternalException

Retrieves a float value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

float the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type float

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeDouble

double getFactAttributeDouble(IConcept lhsConcept,
                              java.lang.String attributeName)
                              throws UnknownValueException,
                                     InvalidTypeException,
                                     ExternalException

Retrieves a double value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

double the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type double

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeDouble

double getFactAttributeDouble(IConcept lhsConcept,
                              java.lang.String attributeName,
                              int index)
                              throws UnknownValueException,
                                     InvalidTypeException,
                                     ExternalException

Retrieves a double value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

double the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type double

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeDouble

double getFactAttributeDouble(IConcept lhsConcept,
                              java.lang.String attributeName,
                              java.lang.String key)
                              throws UnknownValueException,
                                     InvalidTypeException,
                                     ExternalException

Retrieves a double value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

double the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type double

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeBoolean

boolean getFactAttributeBoolean(IConcept lhsConcept,
                                java.lang.String attributeName)
                                throws UnknownValueException,
                                       InvalidTypeException,
                                       ExternalException

Retrieves a boolean value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

boolean the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type boolean

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeBoolean

boolean getFactAttributeBoolean(IConcept lhsConcept,
                                java.lang.String attributeName,
                                int index)
                                throws UnknownValueException,
                                       InvalidTypeException,
                                       ExternalException

Retrieves a boolean value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

boolean the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type boolean

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeBoolean

boolean getFactAttributeBoolean(IConcept lhsConcept,
                                java.lang.String attributeName,
                                java.lang.String key)
                                throws UnknownValueException,
                                       InvalidTypeException,
                                       ExternalException

Retrieves a boolean value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

boolean the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type boolean

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeString

java.lang.String getFactAttributeString(IConcept lhsConcept,
                                        java.lang.String attributeName)
                                        throws UnknownValueException,
                                               InvalidTypeException,
                                               ExternalException

Retrieves a String value for an attribute of a concept from a fact in the world state The attribute's Brahms type may be either string or symbol.

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

String the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of a string

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeString

java.lang.String getFactAttributeString(IConcept lhsConcept,
                                        java.lang.String attributeName,
                                        int index)
                                        throws UnknownValueException,
                                               InvalidTypeException,
                                               ExternalException

Retrieves a String value for a collection attribute of a concept at a given integer index from a fact in the world state The Brahms type of the value may be either string or symbol.

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

String the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not s string

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeString

java.lang.String getFactAttributeString(IConcept lhsConcept,
                                        java.lang.String attributeName,
                                        java.lang.String key)
                                        throws UnknownValueException,
                                               InvalidTypeException,
                                               ExternalException

Retrieves a String value for a collection attribute of a concept at a given String key from a fact in the world state The Brahms type of the value may be either string or symbol.

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

String the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not a string

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeJava

java.io.Serializable getFactAttributeJava(IConcept lhsConcept,
                                          java.lang.String attributeName)
                                          throws UnknownValueException,
                                                 InvalidTypeException,
                                                 ExternalException

Retrieves a Java Serializable value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

Serializable the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not of type Serializable

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeJava

java.io.Serializable getFactAttributeJava(IConcept lhsConcept,
                                          java.lang.String attributeName,
                                          int index)
                                          throws UnknownValueException,
                                                 InvalidTypeException,
                                                 ExternalException

Retrieves a Serializable value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

Serializable the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type Serializable

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeJava

java.io.Serializable getFactAttributeJava(IConcept lhsConcept,
                                          java.lang.String attributeName,
                                          java.lang.String key)
                                          throws UnknownValueException,
                                                 InvalidTypeException,
                                                 ExternalException

Retrieves a Serializable value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

Serializable the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not of type Serializable

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeConcept

IConcept getFactAttributeConcept(IConcept lhsConcept,
                                 java.lang.String attributeName)
                                 throws UnknownValueException,
                                        InvalidTypeException,
                                        ExternalException

Retrieves an IConcept value for an attribute of a concept from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

IConcept the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the value of the attribute is not a concept

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeConcept

IConcept getFactAttributeConcept(IConcept lhsConcept,
                                 java.lang.String attributeName,
                                 int index)
                                 throws UnknownValueException,
                                        InvalidTypeException,
                                        ExternalException

Retrieves an IConcept value for a collection attribute of a concept at a given integer index from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

IConcept the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not a concept

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeConcept

IConcept getFactAttributeConcept(IConcept lhsConcept,
                                 java.lang.String attributeName,
                                 java.lang.String key)
                                 throws UnknownValueException,
                                        InvalidTypeException,
                                        ExternalException

Retrieves an IConcept value for a collection attribute of a concept at a given String key from a fact in the world state

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

IConcept the value of the attribute

Throws:

UnknownValueException - if the value of the attribute is missing or unknown

InvalidTypeException - if the attribute does not have a collection type or the value of the attribute is not a concept

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeMap

java.util.Map<java.lang.Object,java.lang.Object> getFactAttributeMap(IConcept lhsConcept,
                                                                     java.lang.String attributeName,
                                                                     boolean includeUnknown)
                                                                     throws InvalidTypeException,
                                                                            ExternalException

Returns a Map representing the values for a map attribute of a concept from facts in the world state Entries with values of unknown are included in the returned Map if the includeUnknown parameter is true. An empty Map will be returned if the value of the map attribute is Unknown.

Parameters:

lhsConcept - an IConcept whose map attribute values are to be retrieved

attributeName - the String name of the map attribute whose values are to be retrieved

includeUnknown - true if unknown values should be included in the map entries

Returns:

Map a map from the index/keys of the map attribute to their values

Throws:

InvalidTypeException - if the attribute is not a map attribute

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeSortedMap

java.util.SortedMap<java.lang.Object,java.lang.Object> getFactAttributeSortedMap(IConcept lhsConcept,
                                                                                 java.lang.String attributeName,
                                                                                 boolean includeUnknown)
                                                                                 throws InvalidTypeException,
                                                                                        ExternalException

Returns a sorted Map representing the values for a map attribute of a concept from facts in the world state Entries with values of unknown are included in the returned Map if the includeUnknown parameter is true. An empty Map will be returned if the value of the map attribute is Unknown.

Parameters:

lhsConcept - an IConcept whose map attribute values are to be retrieved

attributeName - the String name of the map attribute whose values are to be retrieved

includeUnknown - true if unknown values should be included in the map entries

Returns:

SortedMap a sorted map from the index/keys of the map attribute to their values

Throws:

InvalidTypeException - if the attribute is not a map attribute

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeValue

java.lang.Object getFactAttributeValue(IConcept lhsConcept,
                                       java.lang.String attributeName)
                                       throws ExternalException

Retrieves the value for an attribute of a concept from a fact in the world state Returns null if there is no corresponding fact in the world state. Returns IUnknown.UNKNOWN if the value of the attribute is the unknown value.

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

Returns:

Object the value of the attribute

Throws:

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeValue

java.lang.Object getFactAttributeValue(IConcept lhsConcept,
                                       java.lang.String attributeName,
                                       int index)
                                       throws InvalidTypeException,
                                              ExternalException

Retrieves the value for a collection attribute of a concept at a given integer index from a fact in the world state Returns null if there is no corresponding fact in the world state. Returns IUnknown.UNKNOWN if the value of the attribute for the index is the unknown value.

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

index - the integer index to be looked up in the map

Returns:

Object the value of the attribute at the index

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactAttributeValue

java.lang.Object getFactAttributeValue(IConcept lhsConcept,
                                       java.lang.String attributeName,
                                       java.lang.String key)
                                       throws InvalidTypeException,
                                              ExternalException

Retrieves the value for a collection attribute of a concept at a given String key from a fact in the world state Returns null if there is no corresponding fact in the world state. Returns IUnknown.UNKNOWN if the value of the attribute for the key is the unknown value.

Parameters:

lhsConcept - an IConcept whose attribute value is to be retrieved

attributeName - the String name of the attribute whose value is to be retrieved

key - the String key to be looked up in the map

Returns:

Object the value of the attribute for the key

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

hasFactAttributeAnyValue

boolean hasFactAttributeAnyValue(IConcept lhsConcept,
                                 java.lang.String attributeName,
                                 boolean includeUnknown)
                                 throws ExternalException

Tests whether a concept has any value for a named attribute based on the facts in the world state. The includeUnknown parameter controls whether the 'unknown' value counts as a value or only 'definite' values are considered.

Parameters:

lhsConcept - an IConcept whose attribute value is to be checked

attributeName - the String name of the attribute whose value is to be checked

includeUnknown - true if the unknown value is counted, else false

Returns:

boolean true if the concept has the 'unknown' value for the attribute, else false

Throws:

ExternalException - if the concept does not have the named attribute or an internal error occurs

hasFactAttributeAnyValue

boolean hasFactAttributeAnyValue(IConcept lhsConcept,
                                 java.lang.String attributeName,
                                 int index,
                                 boolean includeUnknown)
                                 throws InvalidTypeException,
                                        ExternalException

Tests whether a concept has any value for a named collection attribute at a given integer index based on the facts in the world state. The includeUnknown parameter controls whether the 'unknown' value counts as a value or only 'definite' values are considered.

Parameters:

lhsConcept - an IConcept whose attribute value is to be checked

attributeName - the String name of the attribute whose value is to be checked

index - the integer index to be looked up in the map

includeUnknown - true if the unknown value is counted, else false

Returns:

boolean true if the concept has any value for the attribute and index, else false

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

hasFactAttributeAnyValue

boolean hasFactAttributeAnyValue(IConcept lhsConcept,
                                 java.lang.String attributeName,
                                 java.lang.String key,
                                 boolean includeUnknown)
                                 throws InvalidTypeException,
                                        ExternalException

Tests whether a concept has any value for a named collection attribute at a given String key based on the facts in the world state. The includeUnknown parameter controls whether the 'unknown' value counts as a value or only 'definite' values are considered.

Parameters:

lhsConcept - an IConcept whose attribute value is to be checked

attributeName - the String name of the attribute whose value is to be checked

key - the String key to be looked up in the map

includeUnknown - true if the unknown value is counted, else false

Returns:

boolean true if the concept has any value for the attribute and index, else false

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

hasFactAttributeValue

boolean hasFactAttributeValue(IConcept lhsConcept,
                              java.lang.String attributeName,
                              java.lang.Object value)
                              throws ExternalException

Tests whether a concept has a specified value for a named attribute based on the facts in the world state.

Parameters:

lhsConcept - an IConcept whose attribute value is to be checked

attributeName - the String name of the attribute whose value is to be checked

value - an Object to be compared for equality to the current value of the attribute, if any

Returns:

boolean true if the concept has the specified value for the attribute, else false

Throws:

ExternalException - if the concept does not have the named attribute or an internal error occurs

hasFactAttributeValue

boolean hasFactAttributeValue(IConcept lhsConcept,
                              java.lang.String attributeName,
                              int index,
                              java.lang.Object value)
                              throws InvalidTypeException,
                                     ExternalException

Tests whether a concept has a specified value for a named collection attribute at an int index based on the facts in the world state.

Parameters:

lhsConcept - an IConcept whose attribute value is to be checked

attributeName - the String name of the attribute whose value is to be checked

index - the integer index to be looked up in the map

value - an Object to be compared for equality to the current value of the attribute for the index, if any

Returns:

boolean true if the concept has the specified value for the attribute and index, else false

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

hasFactAttributeValue

boolean hasFactAttributeValue(IConcept lhsConcept,
                              java.lang.String attributeName,
                              java.lang.String key,
                              java.lang.Object value)
                              throws InvalidTypeException,
                                     ExternalException

Tests whether a concept has a specified value for a named collection attribute at a String key based on the facts in the world state.

Parameters:

lhsConcept - an IConcept whose attribute value is to be checked

attributeName - the String name of the attribute whose value is to be checked

key - the String key to be looked up in the map

value - an Object to be compared for equality to the current value of the attribute for the key, if any

Returns:

boolean true if the concept has the specified value for the attribute and key, else false

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeInt

void setFactAttributeInt(IConcept lhsConcept,
                         java.lang.String attributeName,
                         int value,
                         IContext ctx)
                         throws InvalidTypeException,
                                ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified int value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new int value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeInt

void setFactAttributeInt(IConcept lhsConcept,
                         java.lang.String attributeName,
                         int index,
                         int value,
                         IContext ctx)
                         throws InvalidTypeException,
                                ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified int value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new int value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeInt

void setFactAttributeInt(IConcept lhsConcept,
                         java.lang.String attributeName,
                         java.lang.String key,
                         int value,
                         IContext ctx)
                         throws InvalidTypeException,
                                ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified int value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new int value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeChar

void setFactAttributeChar(IConcept lhsConcept,
                          java.lang.String attributeName,
                          char value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified char value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new char value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeChar

void setFactAttributeChar(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index,
                          char value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified char value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new char value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeChar

void setFactAttributeChar(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key,
                          char value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified char value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new char value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeByte

void setFactAttributeByte(IConcept lhsConcept,
                          java.lang.String attributeName,
                          byte value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified byte value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new byte value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeByte

void setFactAttributeByte(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index,
                          byte value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified byte value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new byte value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeByte

void setFactAttributeByte(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key,
                          byte value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified byte value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new byte value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeShort

void setFactAttributeShort(IConcept lhsConcept,
                           java.lang.String attributeName,
                           short value,
                           IContext ctx)
                           throws InvalidTypeException,
                                  ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified short value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new short value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeShort

void setFactAttributeShort(IConcept lhsConcept,
                           java.lang.String attributeName,
                           int index,
                           short value,
                           IContext ctx)
                           throws InvalidTypeException,
                                  ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified short value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new short value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeShort

void setFactAttributeShort(IConcept lhsConcept,
                           java.lang.String attributeName,
                           java.lang.String key,
                           short value,
                           IContext ctx)
                           throws InvalidTypeException,
                                  ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified short value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new short value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeLong

void setFactAttributeLong(IConcept lhsConcept,
                          java.lang.String attributeName,
                          long value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified long value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new long value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeLong

void setFactAttributeLong(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index,
                          long value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified long value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new long value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeLong

void setFactAttributeLong(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key,
                          long value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified long value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new long value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeFloat

void setFactAttributeFloat(IConcept lhsConcept,
                           java.lang.String attributeName,
                           float value,
                           IContext ctx)
                           throws InvalidTypeException,
                                  ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified float value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new float value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeFloat

void setFactAttributeFloat(IConcept lhsConcept,
                           java.lang.String attributeName,
                           int index,
                           float value,
                           IContext ctx)
                           throws InvalidTypeException,
                                  ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified float value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new float value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeFloat

void setFactAttributeFloat(IConcept lhsConcept,
                           java.lang.String attributeName,
                           java.lang.String key,
                           float value,
                           IContext ctx)
                           throws InvalidTypeException,
                                  ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified float value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new float value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeDouble

void setFactAttributeDouble(IConcept lhsConcept,
                            java.lang.String attributeName,
                            double value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified double value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new double value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeDouble

void setFactAttributeDouble(IConcept lhsConcept,
                            java.lang.String attributeName,
                            int index,
                            double value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified double value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new double value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeDouble

void setFactAttributeDouble(IConcept lhsConcept,
                            java.lang.String attributeName,
                            java.lang.String key,
                            double value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified double value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new double value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeBoolean

void setFactAttributeBoolean(IConcept lhsConcept,
                             java.lang.String attributeName,
                             boolean value,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified boolean value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new boolean value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeBoolean

void setFactAttributeBoolean(IConcept lhsConcept,
                             java.lang.String attributeName,
                             int index,
                             boolean value,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified boolean value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new boolean value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeBoolean

void setFactAttributeBoolean(IConcept lhsConcept,
                             java.lang.String attributeName,
                             java.lang.String key,
                             boolean value,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified boolean value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new boolean value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeString

void setFactAttributeString(IConcept lhsConcept,
                            java.lang.String attributeName,
                            java.lang.String value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified string value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - a String for the new value

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeString

void setFactAttributeString(IConcept lhsConcept,
                            java.lang.String attributeName,
                            int index,
                            java.lang.String value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified string value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new String value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeString

void setFactAttributeString(IConcept lhsConcept,
                            java.lang.String attributeName,
                            java.lang.String key,
                            java.lang.String value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified string value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new String value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeSymbol

void setFactAttributeSymbol(IConcept lhsConcept,
                            java.lang.String attributeName,
                            java.lang.String value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified symbol value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - a String for the new value

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type or the value is not a valid symbol

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeSymbol

void setFactAttributeSymbol(IConcept lhsConcept,
                            java.lang.String attributeName,
                            int index,
                            java.lang.String value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified symbol value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new String value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type or the value is not a valid symbol

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeSymbol

void setFactAttributeSymbol(IConcept lhsConcept,
                            java.lang.String attributeName,
                            java.lang.String key,
                            java.lang.String value,
                            IContext ctx)
                            throws InvalidTypeException,
                                   ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified symbol value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new String value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type or the value is not a valid symbol

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeJava

void setFactAttributeJava(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.io.Serializable value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Serializable value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new Java Serializable value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeJava

void setFactAttributeJava(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index,
                          java.io.Serializable value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Serializable value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new Java Serializable value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeJava

void setFactAttributeJava(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key,
                          java.io.Serializable value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Serializable value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new Java Serializable value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeJava

void setFactAttributeJava(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.Object value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Object value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new Java Object value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeJava

void setFactAttributeJava(IConcept lhsConcept,
                          java.lang.String attributeName,
                          int index,
                          java.lang.Object value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Object value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new Java Object value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeJava

void setFactAttributeJava(IConcept lhsConcept,
                          java.lang.String attributeName,
                          java.lang.String key,
                          java.lang.Object value,
                          IContext ctx)
                          throws InvalidTypeException,
                                 ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified Java Object value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new Java Object value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeConcept

void setFactAttributeConcept(IConcept lhsConcept,
                             java.lang.String attributeName,
                             IConcept value,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified IConcept value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

value - the new IConcept value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a compatible type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeConcept

void setFactAttributeConcept(IConcept lhsConcept,
                             java.lang.String attributeName,
                             int index,
                             IConcept value,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified IConcept value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to a value in the map

value - the new IConcept value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeConcept

void setFactAttributeConcept(IConcept lhsConcept,
                             java.lang.String attributeName,
                             java.lang.String key,
                             IConcept value,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has a specified IConcept value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to a value in the map

value - the new IConcept value for the attribute

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeUnknown

void setFactAttributeUnknown(IConcept lhsConcept,
                             java.lang.String attributeName,
                             IContext ctx)
                             throws ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has the unknown value for a named attribute

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

ctx - an IContext for asserting the new fact

Throws:

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeUnknown

void setFactAttributeUnknown(IConcept lhsConcept,
                             java.lang.String attributeName,
                             int index,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has the unknown value for a named collection attribute at an int index

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

index - the integer index to be set to 'unknown' in the collection

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

setFactAttributeUnknown

void setFactAttributeUnknown(IConcept lhsConcept,
                             java.lang.String attributeName,
                             java.lang.String key,
                             IContext ctx)
                             throws InvalidTypeException,
                                    ExternalException

Creates and asserts a new fact in the world state representing that an IConcept has the unknown value for a named collection attribute at a String key

Parameters:

lhsConcept - an IConcept to be given a new value for an attribute

attributeName - the String name of the attribute

key - the String key to be set to 'unknown' in the collection

ctx - an IContext for asserting the new fact

Throws:

InvalidTypeException - if the attribute does not have a collection type

ExternalException - if the concept does not have the named attribute or an internal error occurs

getFactRelationConcepts

java.util.List<IConcept> getFactRelationConcepts(IConcept lhsConcept,
                                                 java.lang.String relationName)
                                                 throws ExternalException

Retrieves a list of concepts that are related to a given concept by a named relation by inspecting the facts in the current world state. Unknown values are filtered out of the returned list so that (concept relation unknown) will result in an empty list being returned.

Parameters:

lhsConcept - an IConcept whose values for a relation are to be retrieved

relationName - a String name for a relation defined for lhsConcept

Returns:

List the list of IConcept instances that are related to the lhsConcept by the relation

Throws:

ExternalException - if no relation with the specified name is defined for this concept or an internal error occurs

hasFactRelationAnyValue

boolean hasFactRelationAnyValue(IConcept lhsConcept,
                                java.lang.String relationName,
                                boolean includeUnknown)
                                throws ExternalException

Tests whether there are any true facts for a given concept and named relation in the current world state. If includeUnknown is true a fact with 'unknown' as the right-hand side value is counted, else it is ignored.

Parameters:

lhsConcept - an IConcept whose relation to another concept is to be checked

relationName - a String name for a relation defined for lhsConcept

includeUnknown - true if the unknown value is counted, else false

Returns:

boolean true if a matching true fact exists in the world state, else false

Throws:

ExternalException - if no relation with the specified name is defined for this concept or an internal error occurs

hasFactRelationValue

boolean hasFactRelationValue(IConcept lhsConcept,
                             java.lang.String relationName,
                             java.lang.Object value)
                             throws ExternalException

Tests whether a concept is related to a value by a named relation by inspecting the facts in the current world state.

Parameters:

lhsConcept - an IConcept whose values for a relation are to be checked

relationName - a String name for a relation defined for lhsConcept

value - an Object to be tested for the right-hand side of the relation

Returns:

boolean true if the concept is related to the value by the relation, else false

Throws:

ExternalException - if no relation with the specified name is defined for this concept or an internal error occurs

addFactRelationConcept

void addFactRelationConcept(IConcept lhsConcept,
                            java.lang.String relationName,
                            IConcept rhsConcept,
                            IContext ctx)
                            throws ExternalException

Adds a concept as a value of a named relation for a concept by asserting a new fact into the world state.

Parameters:

lhsConcept - an IConcept that gets a new concept related to it

relationName - a String name for a relation defined for lhsConcept

rhsConcept - the IConcept to be added to lhsConcept's relation

ctx - an IContext for asserting the new fact

Throws:

ExternalException - if the concept does not have the named relation or an internal error occurs

removeFactRelationConcept

void removeFactRelationConcept(IConcept lhsConcept,
                               java.lang.String relationName,
                               IConcept rhsConcept,
                               IContext ctx)
                               throws ExternalException

Removes a concept as a value of a named relation for a concept by retracting the corresponding fact from the world state.

Parameters:

lhsConcept - an IConcept that has the relation value removed

relationName - a String name for a relation defined for lhsConcept

rhsConcept - the IConcept to be removed from the lhsConcept's relation

ctx - an IContext for retracting the fact

Throws:

ExternalException - if the concept does not have the named relation or an internal error occurs

setFactRelationUnknown

void setFactRelationUnknown(IConcept lhsConcept,
                            java.lang.String relationName,
                            IContext ctx)
                            throws ExternalException

Removes any existing concepts as values of a named relation for a concept by giving the relation a value of unknown.

Parameters:

lhsConcept - an IConcept for which a relation is set to unknown

relationName - a String name for a relation defined for lhsConcept

ctx - an IContext for asserting the fact with an unknown value

Throws:

ExternalException - if the concept does not have the named relation or an internal error occurs

removeAllFactRelationValues

java.util.List<IConcept> removeAllFactRelationValues(IConcept lhsConcept,
                                                     java.lang.String relationName,
                                                     IContext ctx)
                                                     throws ExternalException

Removes any existing concepts as values of a named relation for a concept by retracting facts from the world state. Unlike setRelationUnknown, removeAllRelationValues does not give the relation a value of unknown

Parameters:

lhsConcept - an IConcept for which a relation is set to unknown

relationName - a String name for a relation defined for lhsConcept

ctx - an IContext for retracting the facts

Returns:

List the list of IConcept instances that have been removed from the relation for the lhsConcept

Throws:

ExternalException - if the concept does not have the named relation or an internal error occurs