com.articulate.sigma.EditGUI Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sigma-component Show documentation
Show all versions of sigma-component Show documentation
Sigma knowledge engineering system is an system for developing, viewing and debugging theories in first
order logic. It works with Knowledge Interchange Format (KIF) and is optimized for the Suggested Upper Merged
Ontology (SUMO) www.ontologyportal.org.
/** This code is copyrighted by Rearden Commerce (c) 2011. It is
released under the GNU Public License <http://www.gnu.org/copyleft/gpl.html>.
Users of this code also consent, by use of this code, to credit
Articulate Software in any writings, briefings, publications,
presentations, or other representations of any software which
incorporates, builds on, or uses this code. Please cite the following
article in any publication with references:
Pease, A., (2003). The Sigma Ontology Development Environment, in Working
Notes of the IJCAI-2003 Workshop on Ontology and Distributed Systems,
August 9, Acapulco, Mexico. See also http://sigmakee.sourceforge.net.
*/
/*************************************************************************************************/
package com.articulate.sigma;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.LineNumberReader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.TreeMap;
import java.util.TreeSet;
import com.articulate.sigma.KB;
/** A class that generates a GUI for elements of the ontology. */
public class EditGUI {
public static ArrayList allowedTerms = new ArrayList();
public static boolean initOnce = false;
/** *************************************************************
*/
public static void initOnce() {
if (initOnce) return;
LineNumberReader lnr = null;
String fname = "allowedTerms.txt";
String kbDir = KBmanager.getMgr().getPref("kbDir");
try {
File fin = new File(kbDir + File.separator + fname);
FileReader fr = new FileReader(fin);
if (fr != null) {
lnr = new LineNumberReader(fr);
String line = null;
while ((line = lnr.readLine()) != null) {
line = line.trim();
allowedTerms.add(line);
}
}
}
catch (IOException ioe) {
System.out.println("Error in EditGUI.readConfig() reading file: " + kbDir + File.separator + fname);
System.out.println(ioe.getMessage());
}
finally {
try {
if (lnr != null) lnr.close();
}
catch (Exception e) {
System.out.println("Exception in EditGUI.readConfig()");
}
}
initOnce = true;
}
/** *************************************************************
*/
public String genRelPage(KB kb, String rel) {
StringBuffer sb = new StringBuffer();
// get classes or instances that apply for each argument
return sb.toString();
}
/** *************************************************************
* Get and print all instances of a class
*/
public static String printInstances(KB kb, String className) {
StringBuffer sb = new StringBuffer();
TreeSet ts = kb.getAllInstances(className);
Iterator it = ts.iterator();
while (it.hasNext()) {
String term = (String) it.next();
sb.append(term);
if (it.hasNext()) sb.append(", ");
}
return sb.toString();
}
/** *************************************************************
* Get the all parent classes of term. Return the full transitive closure
* of instance and subclass through the subclass relation all the way
* to the root term of the hierarchy.
* @return an ArrayList of term strings
*/
public static ArrayList genAllParentList(KB kb, String term) {
ArrayList parents = new ArrayList();
HashSet immedParents = new HashSet();
ArrayList res = kb.askWithRestriction(0,"instance",1,term);
for (int i = 0; i < res.size(); i++) {
Formula f = res.get(i);
immedParents.add(f.getArgument(2));
}
res = kb.askWithRestriction(0,"subclass",1,term);
for (int i = 0; i < res.size(); i++) {
Formula f = res.get(i);
immedParents.add(f.getArgument(2));
}
parents.addAll(kb.getAllSuperClasses(immedParents));
return parents;
}
/** *************************************************************
* Get the just the immediate parent classes of a term
* @return an ArrayList of term strings
*/
public static ArrayList genImmedParentList(KB kb, String term) {
ArrayList parents = new ArrayList();
ArrayList res = kb.askWithRestriction(0,"instance",1,term);
for (int i = 0; i < res.size(); i++) {
Formula f = res.get(i);
parents.add(f.getArgument(2));
}
res = kb.askWithRestriction(0,"subclass",1,term);
for (int i = 0; i < res.size(); i++) {
Formula f = res.get(i);
parents.add(f.getArgument(2));
}
return parents;
}
/** *************************************************************
* Collect a set of relations in which the type of given term is an argument instance type,
* and collect the set of possible argument fillers.
* @return a map of relation name keys and array values, where each element of
* the array is a particular argument, and consists of an array of possible
* string values.
*/
public static HashMap>> genInstList(KB kb, String term) {
HashMap>> result = new HashMap>>();
ArrayList parents = genAllParentList(kb,term);
// get relations that apply
ArrayList relations = new ArrayList();
for (int i = 0; i < parents.size(); i++) {
String parent = parents.get(i);
ArrayList res = kb.askWithRestriction(0,"domain",3,parent);
//sb.append(";; res = " + Integer.toString(res.size()) + " for " +
// "(domain ?X ?Y " + parent + ")");
for (int k = 0; k < res.size(); k++) {
Formula f = res.get(k);
relations.add(f.getArgument(1));
}
}
// get the arity of each relation
HashMap arity = new HashMap();
for (int i = 0; i < relations.size(); i++) {
String r = relations.get(i);
int a = kb.kbCache.valences.get(r);
arity.put(r,new Integer(a));
}
for (int i = 0; i < relations.size(); i++) {
String r = relations.get(i);
ArrayList al = new ArrayList();
result.put(r,al);
int a = arity.get(r).intValue();
for (int j = 1; j <= a; j++) {
ArrayList al2 = new ArrayList();
String className = kb.getArgTypeClass(r,j);
if (className.endsWith("+"))
al2.addAll(kb.kbCache.getChildClasses(className.substring(0,className.length()-1)));
else
al2.addAll(kb.getAllInstances(className));
al.add(al2);
}
}
return result;
}
/** *************************************************************
* Collect a set of relations in which the type of given term is an argument subclass,
* and collect the set of possible argument fillers.
* @return a map of relation name keys and array values, where each element of
* the array is a particular argument, and consists of an array of possible
* string values.
*/
public static HashMap>> genClassList(KB kb, String term) {
HashMap>> result = new HashMap>>();
ArrayList parents = genAllParentList(kb,term);
// get relations that apply
ArrayList relations = new ArrayList();
for (int i = 0; i < parents.size(); i++) {
String parent = parents.get(i);
ArrayList res = kb.askWithRestriction(0,"domainSubclass",3,parent);
//sb.append(";; res = " + Integer.toString(res.size()) + " for " +
// "(domain ?X ?Y " + parent + ")");
for (int k = 0; k < res.size(); k++) {
Formula f = res.get(k);
relations.add(f.getArgument(1));
}
}
// get the arity of each relation
HashMap arity = new HashMap();
for (int i = 0; i < relations.size(); i++) {
String r = relations.get(i);
int a = kb.kbCache.valences.get(r);
arity.put(r,new Integer(a));
}
for (int i = 0; i < relations.size(); i++) {
String r = relations.get(i);
ArrayList al = new ArrayList();
result.put(r,al);
int a = arity.get(r).intValue();
for (int j = 1; j <= a; j++) {
ArrayList al2 = new ArrayList();
String className = kb.getArgTypeClass(r,j);
if (className.endsWith("+"))
al2.addAll(kb.kbCache.getChildClasses(className.substring(0,className.length()-1)));
else
al2.addAll(kb.getAllInstances(className));
al.add(al2);
}
}
return result;
}
/** *************************************************************
* Generate fields for an HTML form that allow a user to assert
* statements by using menus to set parameters that are arguments
* to relations.
*/
public static String genInstPage(KB kb, String term, String kbHref) {
initOnce();
StringBuffer sb = new StringBuffer();
HashMap>> instList = EditGUI.genInstList(kb,term);
ArrayList parents = genAllParentList(kb,term);
// show the instance and its class
sb.append("Instance relations for: " + term + ":");
for (int i = 0; i < parents.size(); i++) {
String parent = parents.get(i);
sb.append("" + parent + ",");
}
sb.append("\n");
sb.append("
\n");
sb.append("relation arguments assert? " + relation + ": ");
ArrayList> arguments = instList.get(relation);
for (int i = 0; i < arguments.size(); i++) {
ArrayList fillers = arguments.get(i);
if (fillers.size() < 1)
sb.append("");
else
sb.append(HTMLformatter.createMenu(relation + "--" + Integer.toString(i),"", fillers, ""));
}
sb.append("
\n");
// for each relation, get other class and instances that apply
return sb.toString();
}
/** *************************************************************
* Generate a set of menus comprising relations that apply to this class
* i.e. which has (domainSubclass [relation] [N] [thisclass])
* If the allowedTerms list is non-empty, ensure that only terms in that
* list are used.
*/
public static String genClassPage(KB kb, String term, String kbHref) {
initOnce();
StringBuffer sb = new StringBuffer();
HashMap>> instList = EditGUI.genClassList(kb,term);
ArrayList parents = genAllParentList(kb,term);
// show the instance and its class
sb.append("Class relations for: " + term + ":");
for (int i = 0; i < parents.size(); i++) {
String parent = parents.get(i);
sb.append("" + parent + ",");
}
sb.append("\n");
sb.append("
\n");
sb.append("relation arguments assert? " + relation + ": ");
ArrayList> arguments = instList.get(relation);
for (int i = 0; i < arguments.size(); i++) {
ArrayList fillers = arguments.get(i);
if (fillers.size() < 1)
sb.append("");
else
sb.append(HTMLformatter.createMenu(relation + "--" + Integer.toString(i),"", fillers, ""));
}
sb.append("
\n");
// for each relation, get other class and instances that apply
return sb.toString();
}
/** *************************************************************
* Interpret a map as a key relation name and ArrayList of values as arguments.
* @return a String status message that includes a hyperlinked presentation of each
* formula that is successfully asserted.
*/
public static String assertFacts(KB kb, TreeMap> cbset, String kbHref) {
System.out.println("INFO in EditGUI.assertFacts(): cbset: "+ cbset);
StringBuffer status = new StringBuffer();
Iterator it = cbset.keySet().iterator();
while (it.hasNext()) {
String rel = (String) it.next();
StringBuffer sb = new StringBuffer();
sb.append("(" + rel);
ArrayList al = cbset.get(rel);
for (int i = 0; i < al.size(); i++) {
String val = al.get(i);
sb.append(" " + val);
}
sb.append(")");
Formula f = new Formula();
f.read(sb.toString());
status.append(f.htmlFormat(kbHref) + "\n");
status.append(kb.tell(sb.toString()) + "
\n");
}
return status.toString();
}
/** *************************************************************
* A test method.
*/
public static void main (String args[]) {
try {
KBmanager.getMgr().initializeOnce();
WordNet.initOnce();
}
catch (Exception e) {
System.out.println(e.getMessage());
}
KB kb = KBmanager.getMgr().getKB("SUMO");
System.out.println(genInstPage(kb,"UnitedStates",""));
}
}