com.articulate.sigma

Class KIF

java.lang.Object

com.articulate.sigma.KIF

public class KIF
extends java.lang.Object

A class designed to read a file in SUO-KIF format into memory. See for a language specification. readFile() and writeFile() are the primary entry points and parse() does all the real work.

Field Summary

Fields

Modifier and Type	Field and Description
static int	count
java.util.TreeSet<java.lang.String>	errorSet errors generated during parsing
java.util.HashMap<java.lang.String,Formula>	formulaMap A HashMap of String keys representing the formula, and Formula values.
java.util.HashMap<java.lang.String,java.util.ArrayList<java.lang.String>>	formulas A HashMap of ArrayLists of Formulas.
static int	NORMAL_PARSE_MODE A numeric constant denoting normal parse mode, in which syntax constraints are enforced.
static int	RELAXED_PARSE_MODE A numeric constant denoting relaxed parse mode, in which fewer syntax constraints are enforced than in NORMAL_PARSE_MODE.
java.util.Map<java.lang.String,java.lang.Integer>	termFrequency A hashMap to store term frequencies for each term in knowledge base
java.util.TreeSet<java.lang.String>	terms The set of all terms in the knowledge base.
java.util.TreeSet<java.lang.String>	warningSet warnings generated during parsing

Constructor Summary

Constructors

Constructor and Description
KIF()

Method Summary

Modifier and Type	Method and Description
int	getParseMode()
static void	main(java.lang.String[] args) Test method for this class.
protected java.util.TreeSet<java.lang.String>	parse(java.io.Reader r) This method has the side effect of setting the contents of formulaMap and formulas as it parses the file.
java.lang.String	parseStatement(java.lang.String formula) Parse a single formula.
void	readFile(java.lang.String fname) Read a KIF file.
void	setParseMode(int mode) Sets the current parse mode to the input value mode.
static void	setupStreamTokenizer(StreamTokenizer_s st) This routine sets up the StreamTokenizer_s so that it parses SUO-KIF.
static void	tptpOutputTest(java.lang.String filename) Writes the TPTP output to a file.
void	writeFile(java.lang.String fname) Write a KIF file.

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL_PARSE_MODE

public static final int NORMAL_PARSE_MODE

A numeric constant denoting normal parse mode, in which syntax constraints are enforced.

See Also:

Constant Field Values

count

public static int count

RELAXED_PARSE_MODE

public static final int RELAXED_PARSE_MODE

A numeric constant denoting relaxed parse mode, in which fewer syntax constraints are enforced than in NORMAL_PARSE_MODE.

See Also:

Constant Field Values

terms

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

The set of all terms in the knowledge base. This is a set of Strings.

termFrequency

public java.util.Map<java.lang.String,java.lang.Integer> termFrequency

A hashMap to store term frequencies for each term in knowledge base

formulas

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

A HashMap of ArrayLists of Formulas. Each String key points to a list of String formulas that correspond to that key. For example, "arg-1-Foo" would be one of several keys for "(instance Foo Bar)".

See Also:

for key format.

formulaMap

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

A HashMap of String keys representing the formula, and Formula values. For example, "(instance Foo Bar)" is a String key that might point to a Formula that is that string, along with information about at what line number and in what file it appears.

warningSet

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

warnings generated during parsing

errorSet

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

errors generated during parsing

Constructor Detail

KIF

public KIF()

Method Detail

getParseMode

public int getParseMode()

Returns:

int Returns an integer value denoting the current parse mode.

setParseMode

public void setParseMode(int mode)

Sets the current parse mode to the input value mode.

Parameters:

mode - An integer value denoting a parsing mode.

setupStreamTokenizer

public static void setupStreamTokenizer(StreamTokenizer_s st)

This routine sets up the StreamTokenizer_s so that it parses SUO-KIF. = < > are treated as word characters, as are normal alphanumerics. ; is the line comment character and " is the quote character.

parse

protected java.util.TreeSet<java.lang.String> parse(java.io.Reader r)

This method has the side effect of setting the contents of formulaMap and formulas as it parses the file. It throws a ParseException with file line numbers if fatal errors are encountered during parsing. Keys in variable "formulas" include the string representation of the formula.

Returns:

a Set of warnings that may indicate syntax errors, but not fatal parse errors.

readFile

public void readFile(java.lang.String fname)
              throws java.lang.Exception

Read a KIF file.

Parameters:

fname - - the full pathname of the file.

Throws:

java.lang.Exception

writeFile

public void writeFile(java.lang.String fname)

Write a KIF file.

Parameters:

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

parseStatement

public java.lang.String parseStatement(java.lang.String formula)

Parse a single formula.

tptpOutputTest

public static void tptpOutputTest(java.lang.String filename)
                           throws java.io.IOException

Writes the TPTP output to a file.

Throws:

java.io.IOException

main

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

Test method for this class.

Throws:

java.io.IOException