com.articulate.sigma

Class KB

java.lang.Object

com.articulate.sigma.KB

public class KB
extends java.lang.Object

Contains methods for reading, writing knowledge bases and their configurations. Also contains the inference engine process for the knowledge base.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_cacheFileSuffix The String constant that is the suffix for files of cached assertions.
static java.lang.String	_userAssertionsString The String constant that is the suffix for files of user assertions.
CELT	celt The instance of the CELT process.
java.util.ArrayList<java.lang.String>	constituents An ArrayList of Strings that are the full canonical pathnames of the files that comprise the KB.
EProver	eprover The inference engine process for this KB.
java.util.TreeSet<java.lang.String>	errors Errors and warnings found during loading of the KB constituents.
java.util.HashMap<java.lang.String,Formula>	formulaMap A Map of all the Formula objects in the KB.
java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>>	formulas A HashMap of ArrayLists of String formulae, containing all the formulae in the KB.
KBcache	kbCache
java.lang.String	kbDir The location of preprocessed KIF files, suitable for loading into EProver.
java.lang.String	language The natural language in which axiom paraphrases should be presented.
protected java.util.ArrayList<java.lang.String>	loadFormatMapsAttempted This List is used to limit the number of warning messages logged by loadFormatMaps(lang).
boolean	modifiedContents Future: If true, the contents of the KB have been modified without updating the caches
java.lang.String	name The name of the knowledge base.
java.util.SortedSet<java.lang.String>	terms A synchronized SortedSet of Strings, which are all the terms in the KB.

Constructor Summary

Constructors

Constructor and Description
KB(KB kbIn) Perform a deep copy of the kb input
KB(java.lang.String n) Constructor
KB(java.lang.String n, java.lang.String dir) Constructor which takes the name of the KB and the location where KBs preprocessed for EProver should be placed.
KB(java.lang.String n, java.lang.String dir, boolean visibility)

Method Summary

Modifier and Type	Method and Description
void	addConstituent(java.lang.String filename) Add a new KB constituent by reading in the file, and then merging the formulas with the existing set of formulas.
java.util.ArrayList<java.lang.String>	ask(java.lang.String suoKifFormula, int timeout, int maxAnswers) Submits a query to the inference engine.
java.util.ArrayList<Formula>	ask(java.lang.String kind, int argnum, java.lang.String term) Returns an ArrayList containing the Formulas that match the request.
java.lang.String	askEngine(java.lang.String suoKifFormula, int timeout, int maxAnswers, InferenceEngine engine) Submits a query to specified InferenceEngine object.
java.lang.String	askLEO(java.lang.String suoKifFormula, int timeout, int maxAnswers, java.lang.String flag) Submits a query to the LEO inference engine.
java.util.ArrayList<java.lang.String>	askNoProof(java.lang.String suoKifFormula, int timeout, int maxAnswers) Submits a query to the inference engine.
java.lang.String	askSInE(java.lang.String suoKifFormula, int timeout, int maxAnswers) Submits a query to the SInE inference engine.
java.util.ArrayList<Formula>	askWithLiteral(Formula queryLit) This method retrieves formulas by asking the query expression queryLit, and returns the results, if any, in an ArrayList.
java.util.ArrayList<Formula>	askWithLiteral(java.util.List<java.lang.String> queryLit) This method retrieves Formulas by asking the query expression queryLit, and returns the results, if any, in an ArrayList.
java.util.ArrayList<Formula>	askWithPredicateSubsumption(java.lang.String relation, int idxArgnum, java.lang.String idxTerm) Returns an ArrayList containing the Formulae retrieved, possibly via multiple asks that recursively use relation and all of its subrelations.
java.util.ArrayList<Formula>	askWithRestriction(int argnum1, java.lang.String term1, int argnum2, java.lang.String term2)
java.util.ArrayList<Formula>	askWithTwoRestrictions(int argnum1, java.lang.String term1, int argnum2, java.lang.String term2, int argnum3, java.lang.String term3) Returns an ArrayList of Formulas in which the two terms provided appear in the indicated argument positions.
java.util.ArrayList<java.lang.String>	availableLanguages() Get an ArrayList of Strings containing the language identifiers of available natural language formatting templates.
void	checkArity() Arity errors should already have been trapped in addConstituent() unless a relation is used before it is defined.
boolean	childOf(java.lang.String child, java.lang.String parent) Determine whether a particular class or instance "child" is a child of the given "parent".
protected void	clearFormatMaps() Clears all loaded format and termFormat maps, for all languages.
java.util.ArrayList<java.lang.String>	collectPredicates()
boolean	containsFormula(java.lang.String formula) Takes a formula string and returns true if the corresponding Formula occurs in the KB.
boolean	containsRE(java.lang.String term) Takes a term (interpreted as a Regular Expression) and returns true if any term in the KB has a match with the RE.
boolean	containsTerm(java.lang.String term) Takes a term and returns true if the term occurs in the KB.
InferenceEngine	createInferenceEngine(InferenceEngine.EngineFactory factory) Creates InferenceEngine and loads all of the constituents into it.
void	deleteUserAssertions() Deletes user assertions, both in the files and in the constituents list.
void	deleteUserAssertionsAndReload() Deletes the user assertions key in the constituents map, and then reloads the KBs.
java.lang.String	formatDocumentation(java.lang.String href, java.lang.String documentation, java.lang.String language) Hyperlink terms identified with '&%' to the URL that brings up that term in the browser.
static java.util.ArrayList<java.util.ArrayList<java.lang.String>>	formulasToArrayLists(java.util.List<Formula> formulaList) Converts all Formula objects in the input List to ArrayList tuples.
java.util.TreeSet<java.lang.String>	getAllInstances(java.lang.String className) This method retrieves all instances of the class named in the input String.
protected java.util.TreeSet<java.lang.String>	getAllInstances(java.util.TreeSet<java.lang.String> classNames) This method retrieves all instances of the classes named in the input set.
java.util.Set<java.lang.String>	getAllSuperClasses(java.util.Set<java.lang.String> classNames) This method retrieves the upward transitive closure of all Class names contained in the input set.
java.lang.String	getAlphaAfter(java.lang.String term, int num) Get the alphabetically num higher neighbor of this initial term, which must exist in the current KB otherwise an empty string is returned.
java.lang.String	getAlphaBefore(java.lang.String term, int num) Get the alphabetically num lower neighbor of this initial term, which must exist in the current KB otherwise an empty string is returned.
java.lang.String	getArgType(java.lang.String reln, int argPos) Returns the type (SUO-KIF SetOrClass name) for any argument in argPos position of an assertion formed with the SUO-KIF Relation reln.
java.lang.String	getArgTypeClass(java.lang.String reln, int argPos) Returns the type (SUO-KIF SetOrClass name) for any argument in argPos position of an assertion formed with the SUO-KIF Relation reln.
static java.util.regex.Pattern	getCompiledPattern(java.lang.String key) This method returns a compiled regular expression Pattern object indexed by key.
int	getCountAxioms() Count the number of formulas in the knowledge base in order to present statistics to the user.
int	getCountRelations() Count the number of relations in the knowledge base in order to present statistics to the user.
int	getCountRules() Count the number of rules in the knowledge base in order to present statistics to the user.
int	getCountTerms() Count the number of terms in the knowledge base in order to present statistics to the user.
java.lang.String	getFirstTermViaAskWithRestriction(int argnum1, java.lang.String term1, int argnum2, java.lang.String term2, int targetArgnum) Returns the first term found that corresponds to targetArgnum in the Formulas obtained from the method call askWithRestriction(argnum1, term1, argnum2, term2).
java.lang.String	getFirstTermViaAWTR(int argnum1, java.lang.String term1, int argnum2, java.lang.String term2, int argnum3, java.lang.String term3, int targetArgnum) Returns the first SUO-KIF terms that matches the request, or null.
java.lang.String	getFirstTermViaPredicateSubsumption(java.lang.String relation, int idxArgnum, java.lang.String idxTerm, int targetArgnum, boolean useInverses) Returns the first SUO-KIF constant found via asks using relation and its subrelations.
java.util.HashMap<java.lang.String,java.lang.String>	getFormatMap(java.lang.String lang) This method creates an association list (Map) of the natural language format string and the relation name for which that format string applies.
Formula	getFormulaByKey(java.lang.String key) An accessor providing a Formula
java.util.TreeSet<java.lang.String>	getFormulas() An accessor providing a TreeSet of un-preProcessed String representations of Formulae.
java.util.ArrayList<java.lang.String>	getLoadFormatMapsAttempted()
static java.util.ArrayList<java.lang.String>	getMatches(java.lang.String input, java.lang.String patternKey) This method finds regular expression matches in an input string using a compiled Pattern and binding group index retrieved with patternKey, and returns the results, if any, in an ArrayList.
static java.util.ArrayList<java.lang.String>	getMatches(java.lang.String input, java.lang.String patternKey, java.util.ArrayList<java.lang.String> accumulator) This method finds regular expression matches in an input string using a compiled Pattern and binding group index retrieved with patternKey.
java.util.ArrayList<java.lang.String>	getNearestNonRelations(java.lang.String term) Get the neighbors of this initial lowercase term (relation).
java.util.ArrayList<java.lang.String>	getNearestRelations(java.lang.String term) Get the neighbors of this initial uppercase term (class or function).
static int	getPatternGroupIndex(java.lang.String key) This method returns the int value that identifies the regular expression binding group to be returned when there is a match.
java.util.ArrayList<java.lang.String>	getREMatch(java.lang.String term) Takes a term (interpreted as a Regular Expression) and returns an ArrayList containing every term in the KB that has a match with the RE.
java.util.HashMap<java.lang.String,java.lang.String>	getTermFormatMap(java.lang.String lang) This method creates a dictionary (Map) of SUO-KIF term symbols -- the keys -- and a natural language string for each key that is the preferred name for the term -- the values -- in the context denoted by lang.
java.util.SortedSet<java.lang.String>	getTerms() Returns a SortedSet of Strings, which are all the terms in the KB.
java.util.ArrayList<java.lang.String>	getTermsViaAsk(int knownArgnum, java.lang.String knownArg, int targetArgnum) Returns an ArrayList containing the terms (Strings) that correspond to targetArgnum in the ground atomic Formulae in which knownArg is in the argument position knownArgnum.
java.util.ArrayList<java.lang.String>	getTermsViaAskWithRestriction(int argnum1, java.lang.String term1, int argnum2, java.lang.String term2, int targetArgnum) Returns an ArrayList containing the terms (Strings) that correspond to targetArgnum in the Formulas obtained from the method call askWithRestriction(argnum1, term1, argnum2, term2).
java.util.ArrayList<java.lang.String>	getTermsViaAskWithRestriction(int argnum1, java.lang.String term1, int argnum2, java.lang.String term2, int targetArgnum, java.util.Set<java.lang.String> predicatesUsed) Returns an ArrayList containing the terms (Strings) that correspond to targetArgnum in the Formulas obtained from the method call askWithRestriction(argnum1, term1, argnum2, term2).
java.util.ArrayList<java.lang.String>	getTermsViaAWTR(int argnum1, java.lang.String term1, int argnum2, java.lang.String term2, int argnum3, java.lang.String term3, int targetArgnum) Returns an ArrayList containing the SUO-KIF terms that match the request.
java.util.ArrayList<java.lang.String>	getTermsViaPredicateSubsumption(java.lang.String relation, int idxArgnum, java.lang.String idxTerm, int targetArgnum, boolean useInverses) Returns an ArrayList containing SUO-KIF constants, possibly retrieved via multiple asks that recursively use relation and all of its subrelations.
java.util.ArrayList<java.lang.String>	getTermsViaPredicateSubsumption(java.lang.String relation, int idxArgnum, java.lang.String idxTerm, int targetArgnum, boolean useInverses, java.util.Set predicatesUsed) Returns an ArrayList containing SUO-KIF constants, possibly retrieved via multiple asks that recursively use relation and all of its subrelations.
java.util.ArrayList<java.lang.String>	getTransitiveClosureViaPredicateSubsumption(java.lang.String relation, int idxArgnum, java.lang.String idxTerm, int targetArgnum, boolean useInverses) Returns an ArrayList containing the transitive closure of relation starting from idxTerm in position idxArgnum.
int	getValence(java.lang.String relnName) This method tries to find or compute a valence for the input relation.
java.util.ArrayList<Formula>	instancesOf(java.lang.String term) Determine whether a particular term is an immediate instance, which has a statement of the form (instance term otherTerm).
boolean	isChildOf(java.lang.String i, java.lang.String c) Returns true if i is c, is an instance of c, or is subclass of c, or is subAttribute of c, else returns false.
static boolean	isCommutative(java.lang.String obj) A static utility method.
static boolean	isEmptyList(java.lang.Object obj)
boolean	isInstance(java.lang.String term)
boolean	isInstanceOf(java.lang.String i, java.lang.String c) Returns true if i is an instance of c, else returns false.
static boolean	isQuantifier(java.lang.String obj) A static utility method.
static boolean	isRelationInAnyKB(java.lang.String i) Returns true if i is an instance of c in any loaded KB, else returns false.
boolean	isSubAttribute(java.lang.String c1, java.lang.String c2) Returns true if the KB cache supports the conclusion that c1 is a subAttribute of c2, else returns false.
boolean	isSubclass(java.lang.String c1, java.lang.String c2) Returns true if the subclass cache supports the conclusion that c1 is a subclass of c2, else returns false.
static boolean	isVariable(java.lang.String obj) A static utility method.
boolean	isVisible()
static Formula	literalListToFormula(java.util.List<java.lang.String> lit) Converts a literal (List object) to a Formula.
static java.lang.String	literalListToString(java.util.List<java.lang.String> literal) Converts a literal (List object) to a String.
void	loadEProver() Starts EProver and collects, preprocesses and loads all of the constituents into it.
void	loadFormatMaps(java.lang.String lang) Populates the format maps for language lang.
static void	main(java.lang.String[] args)
java.util.TreeSet<java.lang.String>	preProcess(java.util.HashSet<java.lang.String> forms) Preprocess the knowledge base to TPTP.
java.lang.String	reload() Reload all the KB constituents.
java.util.Set<java.lang.String>	removeSuperClasses(java.util.Set<java.lang.String> set) Remove from the given set any item which is a superclass of another item in the set.
void	rename(java.lang.String term2, java.lang.String term1) Rename term2 as term1 throughout the knowledge base.
java.lang.String	REswitch(java.lang.String term) REswitch determines if a String is a RegEx or not based on its use of RE metacharacters.
void	setTerms(java.util.SortedSet<java.lang.String> newTerms) Sets the synchronized SortedSet of all the terms in the KB to be kbTerms.
java.lang.String	simplifyTerm(java.lang.String term) Only called in BrowseBody.jsp when a single match is found.
static java.util.ArrayList<Formula>	stringsToFormulas(java.util.List<java.lang.String> strings) Converts all Strings in the input List to Formula objects.
java.lang.String	tell(java.lang.String input) Adds a formula to the knowledge base.
SimpleElement	writeConfiguration() Create the XML configuration element.
void	writeFile(java.lang.String fname) Write a KIF file consisting of all the formulas in the knowledge base.
java.lang.String	writeInferenceEngineFormulas(java.util.TreeSet<java.lang.String> forms) Save the contents of the current KB to a file.
void	writeTerms() Writes all the terms in the knowledge base to a file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eprover

public EProver eprover

The inference engine process for this KB.

name

public java.lang.String name

The name of the knowledge base.

constituents

public java.util.ArrayList<java.lang.String> constituents

An ArrayList of Strings that are the full canonical pathnames of the files that comprise the KB.

language

public java.lang.String language

The natural language in which axiom paraphrases should be presented.

kbDir

public java.lang.String kbDir

The location of preprocessed KIF files, suitable for loading into EProver.

celt

public CELT celt

The instance of the CELT process.

terms

public java.util.SortedSet<java.lang.String> terms

A synchronized SortedSet of Strings, which are all the terms in the KB.

_userAssertionsString

public static final java.lang.String _userAssertionsString

The String constant that is the suffix for files of user assertions.

See Also:

Constant Field Values

_cacheFileSuffix

public static final java.lang.String _cacheFileSuffix

The String constant that is the suffix for files of cached assertions.

See Also:

Constant Field Values

formulaMap

public java.util.HashMap<java.lang.String,Formula> formulaMap

A Map of all the Formula objects in the KB. Each key is a String representation of a Formula. Each value is the Formula object corresponding to the key.

formulas

public java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>> formulas

A HashMap of ArrayLists of String formulae, containing all the formulae in the KB. Keys are the formula itself, a formula ID, and term indexes created in KIF.createKey(). The actual formula can be retrieved by using the returned String as the key for the variable formulaMap

errors

public java.util.TreeSet<java.lang.String> errors

Errors and warnings found during loading of the KB constituents.

modifiedContents

public boolean modifiedContents

Future: If true, the contents of the KB have been modified without updating the caches

kbCache

public KBcache kbCache

loadFormatMapsAttempted

protected java.util.ArrayList<java.lang.String> loadFormatMapsAttempted

This List is used to limit the number of warning messages logged by loadFormatMaps(lang). If an attempt to load format or termFormat values for lang is unsuccessful, the list is checked for the presence of lang. If lang is not in the list, a warning message is logged and lang is added to the list. The list is cleared whenever a constituent file is added or removed for KB, since the latter might affect the availability of format or termFormat values.

Constructor Detail

KB

public KB(java.lang.String n,
          java.lang.String dir)

Constructor which takes the name of the KB and the location where KBs preprocessed for EProver should be placed.

KB

public KB(java.lang.String n,
          java.lang.String dir,
          boolean visibility)

KB

public KB(KB kbIn)
   throws java.io.IOException

Perform a deep copy of the kb input

Parameters:

kbIn -

Throws:

java.io.IOException

KB

public KB(java.lang.String n)

Constructor

Method Detail

isVisible

public boolean isVisible()

getTerms

public java.util.SortedSet<java.lang.String> getTerms()

Returns a SortedSet of Strings, which are all the terms in the KB.

REswitch

public java.lang.String REswitch(java.lang.String term)

REswitch determines if a String is a RegEx or not based on its use of RE metacharacters. "1"=nonRE, "2"=RE

Parameters:

term - A String

Returns:

"1" or "2"

simplifyTerm

public java.lang.String simplifyTerm(java.lang.String term)

Only called in BrowseBody.jsp when a single match is found. Purpose is to simplify a RegEx to its only matching term

Parameters:

term - a String

Returns:

modified term a String

containsRE

public boolean containsRE(java.lang.String term)

Takes a term (interpreted as a Regular Expression) and returns true if any term in the KB has a match with the RE.

Parameters:

term - A String

Returns:

true or false.

getREMatch

public java.util.ArrayList<java.lang.String> getREMatch(java.lang.String term)

Takes a term (interpreted as a Regular Expression) and returns an ArrayList containing every term in the KB that has a match with the RE.

Parameters:

term - A String

Returns:

An ArrayList of terms that have a match to term

setTerms

public void setTerms(java.util.SortedSet<java.lang.String> newTerms)

Sets the synchronized SortedSet of all the terms in the KB to be kbTerms.

availableLanguages

public java.util.ArrayList<java.lang.String> availableLanguages()

Get an ArrayList of Strings containing the language identifiers of available natural language formatting templates.

Returns:

an ArrayList of Strings containing the language identifiers

removeSuperClasses

public java.util.Set<java.lang.String> removeSuperClasses(java.util.Set<java.lang.String> set)

Remove from the given set any item which is a superclass of another item in the set.

Parameters:

set -

Returns:

checkArity

public void checkArity()

Arity errors should already have been trapped in addConstituent() unless a relation is used before it is defined. This routine is a comprehensive re-check.

getArgType

public java.lang.String getArgType(java.lang.String reln,
                                   int argPos)

Returns the type (SUO-KIF SetOrClass name) for any argument in argPos position of an assertion formed with the SUO-KIF Relation reln. If no argument type value is directly stated for reln, this method tries to find a value inherited from one of reln's super-relations.

Parameters:

reln - A String denoting a SUO-KIF Relation

argPos - An int denoting an argument position, where 0 is the position of reln itself

Returns:

A String denoting a SUO-KIF SetOrClass, or null if no value can be obtained

getArgTypeClass

public java.lang.String getArgTypeClass(java.lang.String reln,
                                        int argPos)

Returns the type (SUO-KIF SetOrClass name) for any argument in argPos position of an assertion formed with the SUO-KIF Relation reln. If no argument type value is directly stated for reln, this method tries to find a value inherited from one of reln's super-relations.

Parameters:

reln - A String denoting a SUO-KIF Relation

argPos - An int denoting an argument position, where 0 is the position of reln itself

Returns:

A String denoting a SUO-KIF SetOrClass, or null if no value can be obtained. A '+' is appended to the class name if the argument is a subclass of the class, rather than an instance

instancesOf

public java.util.ArrayList<Formula> instancesOf(java.lang.String term)

Determine whether a particular term is an immediate instance, which has a statement of the form (instance term otherTerm). Note that this does not count for terms such as Attribute(s) and Relation(s), which may be defined as subAttribute(s) or subrelation(s) of another instance. If the term is not an instance, return an empty ArrayList. Otherwise, return an ArrayList of the Formula(s) in which the given term is defined as an instance.

isInstanceOf

public boolean isInstanceOf(java.lang.String i,
                            java.lang.String c)

Returns true if i is an instance of c, else returns false.

Parameters:

i - A String denoting an instance.

c - A String denoting a Class.

Returns:

true or false.

isChildOf

public boolean isChildOf(java.lang.String i,
                         java.lang.String c)

Returns true if i is c, is an instance of c, or is subclass of c, or is subAttribute of c, else returns false.

Parameters:

i - A String denoting an instance.

c - A String denoting a Class.

Returns:

true or false.

isRelationInAnyKB

public static boolean isRelationInAnyKB(java.lang.String i)

Returns true if i is an instance of c in any loaded KB, else returns false.

Parameters:

i - A String denoting an instance.

Returns:

true or false.

isInstance

public boolean isInstance(java.lang.String term)

childOf

public boolean childOf(java.lang.String child,
                       java.lang.String parent)

Determine whether a particular class or instance "child" is a child of the given "parent".

Parameters:

child - A String, the name of a term.

parent - A String, the name of a term.

Returns:

true if child and parent constitute an actual or implied relation in the current KB, else false.

isSubclass

public boolean isSubclass(java.lang.String c1,
                          java.lang.String c2)

Returns true if the subclass cache supports the conclusion that c1 is a subclass of c2, else returns false.

Parameters:

c1 - A String, the name of a SetOrClass.

c2 - A String, the name of a SetOrClass.

Returns:

boolean

isSubAttribute

public boolean isSubAttribute(java.lang.String c1,
                              java.lang.String c2)

Returns true if the KB cache supports the conclusion that c1 is a subAttribute of c2, else returns false.

Parameters:

c1 - A String, the name of a SetOrClass.

c2 - A String, the name of a SetOrClass.

Returns:

boolean

formulasToArrayLists

public static java.util.ArrayList<java.util.ArrayList<java.lang.String>> formulasToArrayLists(java.util.List<Formula> formulaList)

Converts all Formula objects in the input List to ArrayList tuples.

Parameters:

formulaList - A list of Formulas.

Returns:

An ArrayList of formula tuples (ArrayLists), or an empty ArrayList.

stringsToFormulas

public static java.util.ArrayList<Formula> stringsToFormulas(java.util.List<java.lang.String> strings)

Converts all Strings in the input List to Formula objects.

Parameters:

strings - A list of Strings.

Returns:

An ArrayList of Formulas, or an empty ArrayList.

literalListToString

public static java.lang.String literalListToString(java.util.List<java.lang.String> literal)

Converts a literal (List object) to a String.

Parameters:

literal - A List representing a SUO-KIF formula.

Returns:

A String representing a SUO-KIF formula.

literalListToFormula

public static Formula literalListToFormula(java.util.List<java.lang.String> lit)

Converts a literal (List object) to a Formula.

Parameters:

literal - A List representing a SUO-KIF formula.

Returns:

A SUO-KIF Formula object, or null if no Formula can be created.

getTermsViaAskWithRestriction

public java.util.ArrayList<java.lang.String> getTermsViaAskWithRestriction(int argnum1,
                                                                           java.lang.String term1,
                                                                           int argnum2,
                                                                           java.lang.String term2,
                                                                           int targetArgnum,
                                                                           java.util.Set<java.lang.String> predicatesUsed)

Returns an ArrayList containing the terms (Strings) that correspond to targetArgnum in the Formulas obtained from the method call askWithRestriction(argnum1, term1, argnum2, term2).

Parameters:

predicatesUsed - A Set to which will be added the predicates of the ground assertions actually used to gather the terms returned

Returns:

An ArrayList of terms, or an empty ArrayList if no terms can be retrieved.

getTermsViaAskWithRestriction

public java.util.ArrayList<java.lang.String> getTermsViaAskWithRestriction(int argnum1,
                                                                           java.lang.String term1,
                                                                           int argnum2,
                                                                           java.lang.String term2,
                                                                           int targetArgnum)

Returns an ArrayList containing the terms (Strings) that correspond to targetArgnum in the Formulas obtained from the method call askWithRestriction(argnum1, term1, argnum2, term2).

Returns:

An ArrayList of terms, or an empty ArrayList if no terms can be retrieved.

getFirstTermViaAskWithRestriction

public java.lang.String getFirstTermViaAskWithRestriction(int argnum1,
                                                          java.lang.String term1,
                                                          int argnum2,
                                                          java.lang.String term2,
                                                          int targetArgnum)

Returns the first term found that corresponds to targetArgnum in the Formulas obtained from the method call askWithRestriction(argnum1, term1, argnum2, term2).

Returns:

A SUO-KIF term (String), or null is no answer can be retrieved.

askWithRestriction

public java.util.ArrayList<Formula> askWithRestriction(int argnum1,
                                                       java.lang.String term1,
                                                       int argnum2,
                                                       java.lang.String term2)

Returns:

an ArrayList of Formulas in which the two terms provided appear in the indicated argument positions. If there are no Formula(s) matching the given terms and respective argument positions, return an empty ArrayList. Iterate through the smallest list of results.

askWithTwoRestrictions

public java.util.ArrayList<Formula> askWithTwoRestrictions(int argnum1,
                                                           java.lang.String term1,
                                                           int argnum2,
                                                           java.lang.String term2,
                                                           int argnum3,
                                                           java.lang.String term3)

Returns an ArrayList of Formulas in which the two terms provided appear in the indicated argument positions. If there are no Formula(s) matching the given terms and respective argument positions, return an empty ArrayList.

Returns:

ArrayList

getTermsViaAWTR

public java.util.ArrayList<java.lang.String> getTermsViaAWTR(int argnum1,
                                                             java.lang.String term1,
                                                             int argnum2,
                                                             java.lang.String term2,
                                                             int argnum3,
                                                             java.lang.String term3,
                                                             int targetArgnum)

Returns an ArrayList containing the SUO-KIF terms that match the request.

Returns:

An ArrayList of terms, or an empty ArrayList if no matches can be found.

getFirstTermViaAWTR

public java.lang.String getFirstTermViaAWTR(int argnum1,
                                            java.lang.String term1,
                                            int argnum2,
                                            java.lang.String term2,
                                            int argnum3,
                                            java.lang.String term3,
                                            int targetArgnum)

Returns the first SUO-KIF terms that matches the request, or null.

Returns:

A term (String), or null.

getTermsViaAsk

public java.util.ArrayList<java.lang.String> getTermsViaAsk(int knownArgnum,
                                                            java.lang.String knownArg,
                                                            int targetArgnum)

Returns an ArrayList containing the terms (Strings) that correspond to targetArgnum in the ground atomic Formulae in which knownArg is in the argument position knownArgnum. The ArrayList returned will contain no duplicate terms.

Parameters:

knownArgnum - The argument position of knownArg

knownArg - The term that appears in the argument knownArgnum of the ground atomic Formulae in the KB

targetArgnum - The argument position of the terms being sought

Returns:

An ArrayList of Strings, which will be empty if no match found.

ask

public java.util.ArrayList<Formula> ask(java.lang.String kind,
                                        int argnum,
                                        java.lang.String term)

Returns an ArrayList containing the Formulas that match the request.

Parameters:

kind - May be one of "ant", "cons", "stmt", or "arg"

term - The term that appears in the statements being requested.

argnum - The argument position of the term being asked for. The first argument after the predicate is "1". This parameter is ignored if the kind is "ant", "cons" or "stmt".

Returns:

An ArrayList of Formula(s), which will be empty if no match found.

See Also:

KIF.createKey()

askWithPredicateSubsumption

public java.util.ArrayList<Formula> askWithPredicateSubsumption(java.lang.String relation,
                                                                int idxArgnum,
                                                                java.lang.String idxTerm)

Returns an ArrayList containing the Formulae retrieved, possibly via multiple asks that recursively use relation and all of its subrelations. Note that the Formulas might be formed with different predicates, but all of the predicates will be subrelations of relation and will be related to each other in a subsumption hierarchy.

Parameters:

relation - The name of a predicate, which is assumed to be the 0th argument of one or more atomic formulae

idxArgnum - The argument position occupied by idxTerm in each ground Formula to be retrieved

idxTerm - A constant that occupied idxArgnum position in each ground Formula to be retrieved

Returns:

an ArrayList of Formulas that satisfy the query, or an empty ArrayList if no Formulae are retrieved.

getTermsViaPredicateSubsumption

public java.util.ArrayList<java.lang.String> getTermsViaPredicateSubsumption(java.lang.String relation,
                                                                             int idxArgnum,
                                                                             java.lang.String idxTerm,
                                                                             int targetArgnum,
                                                                             boolean useInverses,
                                                                             java.util.Set predicatesUsed)

Returns an ArrayList containing SUO-KIF constants, possibly retrieved via multiple asks that recursively use relation and all of its subrelations.

Parameters:

relation - The name of a predicate, which is assumed to be the 0th argument of one or more atomic Formulae

idxArgnum - The argument position occupied by term in the ground atomic Formulae that will be retrieved to gather the target (answer) terms

idxTerm - A constant that occupies idxArgnum position in each of the ground atomic Formulae that will be retrieved to gather the target (answer) terms

targetArgnum - The argument position of the answer terms in the Formulae to be retrieved

useInverses - If true, the inverses of relation and its subrelations will be also be used to try to find answer terms

predicatesUsed - A Set to which will be added the predicates of the ground assertions actually used to gather the terms returned

Returns:

an ArrayList of terms (SUO-KIF constants), or an empy ArrayList if no terms can be retrieved

getTermsViaPredicateSubsumption

public java.util.ArrayList<java.lang.String> getTermsViaPredicateSubsumption(java.lang.String relation,
                                                                             int idxArgnum,
                                                                             java.lang.String idxTerm,
                                                                             int targetArgnum,
                                                                             boolean useInverses)

Returns an ArrayList containing SUO-KIF constants, possibly retrieved via multiple asks that recursively use relation and all of its subrelations.

Parameters:

relation - The name of a predicate, which is assumed to be the 0th argument of one or more atomic Formulae

idxArgnum - The argument position occupied by term in the ground atomic Formulae that will be retrieved to gather the target (answer) terms

idxTerm - A constant that occupies idxArgnum position in each of the ground atomic Formulae that will be retrieved to gather the target (answer) terms

targetArgnum - The argument position of the answer terms in the Formulae to be retrieved

useInverses - If true, the inverses of relation and its subrelations will be also be used to try to find answer terms

Returns:

an ArrayList of terms (SUO-KIF constants), or an empy ArrayList if no terms can be retrieved

getFirstTermViaPredicateSubsumption

public java.lang.String getFirstTermViaPredicateSubsumption(java.lang.String relation,
                                                            int idxArgnum,
                                                            java.lang.String idxTerm,
                                                            int targetArgnum,
                                                            boolean useInverses)

Returns the first SUO-KIF constant found via asks using relation and its subrelations.

Parameters:

relation - The name of a predicate, which is assumed to be the 0th argument of one or more atomic Formulae.

idxArgnum - The argument position occupied by term in the ground atomic Formulae that will be retrieved to gather the target (answer) terms.

idxTerm - A constant that occupies idxArgnum position in each of the ground atomic Formulae that will be retrieved to gather the target (answer) terms.

targetArgnum - The argument position of the answer terms in the Formulae to be retrieved.

useInverses - If true, the inverses of relation and its subrelations will be also be used to try to find answer terms.

Returns:

A SUO-KIF constants (String), or null if no term can be retrieved.

getTransitiveClosureViaPredicateSubsumption

public java.util.ArrayList<java.lang.String> getTransitiveClosureViaPredicateSubsumption(java.lang.String relation,
                                                                                         int idxArgnum,
                                                                                         java.lang.String idxTerm,
                                                                                         int targetArgnum,
                                                                                         boolean useInverses)

Returns an ArrayList containing the transitive closure of relation starting from idxTerm in position idxArgnum. The result does not contain idxTerm.

Parameters:

relation - The name of a predicate, which is assumed to be the 0th argument of one or more atomic Formulae

idxArgnum - The argument position occupied by term in the ground atomic Formulae that will be retrieved to gather the target (answer) terms

idxTerm - A constant that occupies idxArgnum position in the first "level" of ground atomic Formulae that will be retrieved to gather the target (answer) terms

targetArgnum - The argument position of the answer terms in the Formulae to be retrieved

useInverses - If true, the inverses of relation and its subrelations will be also be used to try to find answer terms

Returns:

an ArrayList of terms (SUO-KIF constants), or an empy ArrayList if no terms can be retrieved

rename

public void rename(java.lang.String term2,
                   java.lang.String term1)

Rename term2 as term1 throughout the knowledge base. This is an operation with side effects - the term names in the KB are changed.

writeTerms

public void writeTerms()
                throws java.io.IOException

Writes all the terms in the knowledge base to a file

Throws:

java.io.IOException

tell

public java.lang.String tell(java.lang.String input)

Adds a formula to the knowledge base. Returns an XML formatted String that contains the response of the inference engine. It should be of the form "..." where the body should be " Formula has been added to the session database" if all went well. TODO: If we find a way to directly add assertions into opened inference engine, we can roll back to 1.111 version

Parameters:

input - The String representation of a SUO-KIF Formula.

Returns:

A String indicating the status of the tell operation.

ask

public java.util.ArrayList<java.lang.String> ask(java.lang.String suoKifFormula,
                                                 int timeout,
                                                 int maxAnswers)

Submits a query to the inference engine. Returns an XML formatted String that contains the response of the inference engine. It should be in the form "...".

Parameters:

suoKifFormula - The String representation of the SUO-KIF query.

timeout - The number of seconds after which the inference engine should give up.

maxAnswers - The maximum number of answers (binding sets) the inference engine should return.

Returns:

A String indicating the status of the ask operation.

askNoProof

public java.util.ArrayList<java.lang.String> askNoProof(java.lang.String suoKifFormula,
                                                        int timeout,
                                                        int maxAnswers)

Submits a query to the inference engine. Returns a list of answers from inference engine. If no proof is found, return null;

Parameters:

suoKifFormula - The String representation of the SUO-KIF query.

Returns:

A list of answers from inference engine; If no proof or answer is found, return null;

askEngine

public java.lang.String askEngine(java.lang.String suoKifFormula,
                                  int timeout,
                                  int maxAnswers,
                                  InferenceEngine engine)

Submits a query to specified InferenceEngine object. Returns an XML formatted String that contains the response of the inference engine. It should be in the form "...".

Parameters:

suoKifFormula - The String representation of the SUO-KIF query.

timeout - The number of seconds after which the underlying inference engine should give up. (Time taken by axiom selection doesn't count.)

maxAnswers - The maximum number of answers (binding sets) the inference engine should return.

engine - InferenceEngine object that will be used for the inference.

Returns:

A String indicating the status of the ask operation.

askSInE

public java.lang.String askSInE(java.lang.String suoKifFormula,
                                int timeout,
                                int maxAnswers)

Submits a query to the SInE inference engine. Returns an XML formatted String that contains the response of the inference engine. It should be in the form "...".

Parameters:

suoKifFormula - The String representation of the SUO-KIF query.

timeout - The number of seconds after which the underlying inference engine should give up. (Time taken by axiom selection doesn't count.)

maxAnswers - The maximum number of answers (binding sets) the inference engine should return.

Returns:

A String indicating the status of the ask operation.

askLEO

public java.lang.String askLEO(java.lang.String suoKifFormula,
                               int timeout,
                               int maxAnswers,
                               java.lang.String flag)

Submits a query to the LEO inference engine. Returns an XML formatted String that contains the response of the inference engine. It should be in the form "...".

Parameters:

suoKifFormula - The String representation of the SUO-KIF query.

timeout - The number of seconds after which the underlying inference engine should give up. (Time taken by axiom selection doesn't count.)

maxAnswers - The maximum number of answers (binding sets) the inference engine should return.

Returns:

A String indicating the status of the ask operation.

containsTerm

public boolean containsTerm(java.lang.String term)

Takes a term and returns true if the term occurs in the KB.

Parameters:

term - A String.

Returns:

true or false.

containsFormula

public boolean containsFormula(java.lang.String formula)

Takes a formula string and returns true if the corresponding Formula occurs in the KB.

Parameters:

formula - A String.

Returns:

true or false.

getCountTerms

public int getCountTerms()

Count the number of terms in the knowledge base in order to present statistics to the user.

Returns:

The int(eger) number of terms in the knowledge base.

getCountRelations

public int getCountRelations()

Count the number of relations in the knowledge base in order to present statistics to the user.

Returns:

The int(eger) number of relations in the knowledge base.

getCountAxioms

public int getCountAxioms()

Count the number of formulas in the knowledge base in order to present statistics to the user.

Returns:

The int(eger) number of formulas in the knowledge base.

getFormulas

public java.util.TreeSet<java.lang.String> getFormulas()

An accessor providing a TreeSet of un-preProcessed String representations of Formulae.

Returns:

A TreeSet of Strings.

getFormulaByKey

public Formula getFormulaByKey(java.lang.String key)

An accessor providing a Formula

getCountRules

public int getCountRules()

Count the number of rules in the knowledge base in order to present statistics to the user. Note that the number of rules is a subset of the number of formulas.

Returns:

The int(eger) number of rules in the knowledge base.

getNearestRelations

public java.util.ArrayList<java.lang.String> getNearestRelations(java.lang.String term)

Get the neighbors of this initial uppercase term (class or function).

getNearestNonRelations

public java.util.ArrayList<java.lang.String> getNearestNonRelations(java.lang.String term)

Get the neighbors of this initial lowercase term (relation).

getAlphaBefore

public java.lang.String getAlphaBefore(java.lang.String term,
                                       int num)

Get the alphabetically num lower neighbor of this initial term, which must exist in the current KB otherwise an empty string is returned.

getAlphaAfter

public java.lang.String getAlphaAfter(java.lang.String term,
                                      int num)

Get the alphabetically num higher neighbor of this initial term, which must exist in the current KB otherwise an empty string is returned.

loadFormatMaps

public void loadFormatMaps(java.lang.String lang)

Populates the format maps for language lang.

See Also:

is a HashMap of language keys and HashMap values. The interior HashMaps are term keys and format string values., is the same but for relation format strings.

clearFormatMaps

protected void clearFormatMaps()

Clears all loaded format and termFormat maps, for all languages.

getTermFormatMap

public java.util.HashMap<java.lang.String,java.lang.String> getTermFormatMap(java.lang.String lang)

This method creates a dictionary (Map) of SUO-KIF term symbols -- the keys -- and a natural language string for each key that is the preferred name for the term -- the values -- in the context denoted by lang. If the Map has already been built and the language hasn't changed, just return the existing map. This is a case of "lazy evaluation".

Returns:

An instance of Map where the keys are terms and the values are format strings.

getFormatMap

public java.util.HashMap<java.lang.String,java.lang.String> getFormatMap(java.lang.String lang)

This method creates an association list (Map) of the natural language format string and the relation name for which that format string applies. If the map has already been built and the language hasn't changed, just return the existing map. This is a case of "lazy evaluation".

Returns:

An instance of Map where the keys are relation names and the values are format strings.

deleteUserAssertions

public void deleteUserAssertions()
                          throws java.io.IOException

Deletes user assertions, both in the files and in the constituents list.

Throws:

java.io.IOException

deleteUserAssertionsAndReload

public void deleteUserAssertionsAndReload()

Deletes the user assertions key in the constituents map, and then reloads the KBs.

addConstituent

public void addConstituent(java.lang.String filename)

Add a new KB constituent by reading in the file, and then merging the formulas with the existing set of formulas.

Parameters:

filename - - The full path of the file being added

buildCachesP - - If true, forces the assertion caches to be rebuilt - deprecated

performArity - - Perform arity check - deprecated since this can't be dont until all relations are defined

loadEProverP - - If true, destroys the old EProver process and starts a new one - deprecated

reload

public java.lang.String reload()

Reload all the KB constituents.

writeFile

public void writeFile(java.lang.String fname)
               throws java.io.IOException

Write a KIF file consisting of all the formulas in the knowledge base.

Parameters:

fname - - the name of the file to write, including full path.

Throws:

java.io.IOException

writeConfiguration

public SimpleElement writeConfiguration()

Create the XML configuration element.

getCompiledPattern

public static java.util.regex.Pattern getCompiledPattern(java.lang.String key)

This method returns a compiled regular expression Pattern object indexed by key.

Parameters:

key - A String that is the retrieval key for a compiled regular expression Pattern.

Returns:

A compiled regular expression Pattern instance.

getPatternGroupIndex

public static int getPatternGroupIndex(java.lang.String key)

This method returns the int value that identifies the regular expression binding group to be returned when there is a match.

Parameters:

key - A String that is the retrieval key for the binding group index associated with a compiled regular expression Pattern.

Returns:

An int that indexes a binding group.

getMatches

public static java.util.ArrayList<java.lang.String> getMatches(java.lang.String input,
                                                               java.lang.String patternKey,
                                                               java.util.ArrayList<java.lang.String> accumulator)

This method finds regular expression matches in an input string using a compiled Pattern and binding group index retrieved with patternKey. If the ArrayList accumulator is provided, match results are added to it and it is returned. If accumulator is not provided (is null), then a new ArrayList is created and returned if matches are found.

Parameters:

input - The input String in which matches are sought.

patternKey - A String used as the retrieval key for a regular expression Pattern object, and an int index identifying a binding group.

accumulator - An optional ArrayList to which matches are added. Note that if accumulator is provided, it will be the return value even if no new matches are found in the input String.

Returns:

An ArrayList, or null if no matches are found and an accumulator is not provided.

getMatches

public static java.util.ArrayList<java.lang.String> getMatches(java.lang.String input,
                                                               java.lang.String patternKey)

This method finds regular expression matches in an input string using a compiled Pattern and binding group index retrieved with patternKey, and returns the results, if any, in an ArrayList.

Parameters:

input - The input String in which matches are sought.

patternKey - A String used as the retrieval key for a regular expression Pattern object, and an int index identifying a binding group.

Returns:

An ArrayList, or null if no matches are found.

askWithLiteral

public java.util.ArrayList<Formula> askWithLiteral(java.util.List<java.lang.String> queryLit)

This method retrieves Formulas by asking the query expression queryLit, and returns the results, if any, in an ArrayList.

Parameters:

queryLit - The query, which is assumed to be a List (atomic literal) consisting of a single predicate and its arguments. The arguments could be variables, constants, or a mix of the two, but only the first constant encountered in a left to right sweep over the literal will be used in the actual query.

Returns:

An ArrayList of Formula objects, or an empty ArrayList if no answers are retrieved.

askWithLiteral

public java.util.ArrayList<Formula> askWithLiteral(Formula queryLit)

This method retrieves formulas by asking the query expression queryLit, and returns the results, if any, in an ArrayList.

Parameters:

queryLit - The query, which is assumed to be an atomic literal consisting of a single predicate and its arguments. The arguments could be variables, constants, or a mix of the two, but only the first constant encountered in a left to right sweep over the literal will be used in the actual query.

Returns:

An ArrayList of Formula objects, or an empty ArrayList if no answers are retrieved.

getAllSuperClasses

public java.util.Set<java.lang.String> getAllSuperClasses(java.util.Set<java.lang.String> classNames)

This method retrieves the upward transitive closure of all Class names contained in the input set. The members of the input set are not included in the result set.

Parameters:

classNames - A Set object containing SUO-KIF class names (Strings).

Returns:

A Set of SUO-KIF class names, which could be empty.

getAllInstances

protected java.util.TreeSet<java.lang.String> getAllInstances(java.util.TreeSet<java.lang.String> classNames)

This method retrieves all instances of the classes named in the input set.

Parameters:

classNames - A Set of String, containing SUO-KIF class names

Returns:

A TreeSet, possibly empty, containing SUO-KIF constant names.

getAllInstances

public java.util.TreeSet<java.lang.String> getAllInstances(java.lang.String className)

This method retrieves all instances of the class named in the input String.

Parameters:

className - The name of a SUO-KIF Class.

Returns:

A TreeSet, possibly empty, containing SUO-KIF constant names.

getValence

public int getValence(java.lang.String relnName)

This method tries to find or compute a valence for the input relation.

Parameters:

relnName - A String, the name of a SUO-KIF Relation.

Returns:

An int value. -1 means that no valence value could be found. 0 means that the relation is a VariableArityRelation. 1-5 are the standard SUO-KIF valence values.

collectPredicates

public java.util.ArrayList<java.lang.String> collectPredicates()

Returns:

an ArrayList containing all predicates in this KB.

isEmptyList

public static boolean isEmptyList(java.lang.Object obj)

Parameters:

obj - Any object

Returns:

true if obj is a String representation of a LISP empty list, else false.

isVariable

public static boolean isVariable(java.lang.String obj)

A static utility method.

Parameters:

obj - Presumably, a String.

Returns:

true if obj is a SUO-KIF variable, else false.

isQuantifier

public static boolean isQuantifier(java.lang.String obj)

A static utility method.

Parameters:

obj - A String.

Returns:

true if obj is a SUO-KIF logical quantifier, else false.

isCommutative

public static boolean isCommutative(java.lang.String obj)

A static utility method.

Parameters:

obj - Presumably, a String.

Returns:

true if obj is a SUO-KIF commutative logical operator, else false.

formatDocumentation

public java.lang.String formatDocumentation(java.lang.String href,
                                            java.lang.String documentation,
                                            java.lang.String language)

Hyperlink terms identified with '&%' to the URL that brings up that term in the browser. Handle (and ignore) suffixes on the term. For example "&%Processes" would get properly linked to the term "Process", if present in the knowledge base.

writeInferenceEngineFormulas

public java.lang.String writeInferenceEngineFormulas(java.util.TreeSet<java.lang.String> forms)

Save the contents of the current KB to a file.

createInferenceEngine

public InferenceEngine createInferenceEngine(InferenceEngine.EngineFactory factory)

Creates InferenceEngine and loads all of the constituents into it.

Parameters:

factory - Factory object used to create new InferenceEngine.

Returns:

InferenceEngine object with all constituents loaded.

loadEProver

public void loadEProver()

Starts EProver and collects, preprocesses and loads all of the constituents into it.

preProcess

public java.util.TreeSet<java.lang.String> preProcess(java.util.HashSet<java.lang.String> forms)

Preprocess the knowledge base to TPTP. This includes "holds" prefixing, ticking nested formulas, expanding row variables, and translating mathematical relation operators. All the real work is done in Formula.preProcess().

Returns:

a TreeSet of Strings.

getLoadFormatMapsAttempted

public java.util.ArrayList<java.lang.String> getLoadFormatMapsAttempted()

Returns:

a defensive copy of loadFormatMapsAttempted.

main

public static void main(java.lang.String[] args)