WordNet (sigma-component 2.10 API)

java.lang.Object
- com.articulate.sigma.WordNet

```
public class WordNet
extends Object
```
This program finds and displays SUMO terms that are related in meaning to the English expressions that are entered as input. Note that this program uses four WordNet data files, "NOUN.EXC", "VERB.EXC" etc, as well as four WordNet to SUMO mappings files called "WordNetMappings-nouns.txt", "WordNetMappings-verbs.txt" etc The main part of the program prompts the user for an English term and then returns associated SUMO concepts. The two primary public methods are initOnce() and page().

Author:

Ian Niles, Adam Pease

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADJECTIVE`
`static int`	`ADJECTIVE_SATELLITE`
`Hashtable<String,String>`	`adjectiveDocumentationHash`
`Hashtable<String,String>`	`adjectiveSUMOHash`
`Hashtable<String,String>`	`adjectiveSynsetHash`
`static int`	`ADVERB`
`Hashtable<String,String>`	`adverbDocumentationHash`
`Hashtable<String,String>`	`adverbSUMOHash`
`Hashtable<String,String>`	`adverbSynsetHash`
`Hashtable<String,String>`	`exceptionNounHash` list of irregular plural forms where the key is the plural, singular is the value.
`Hashtable<String,String>`	`exceptionVerbHash`
`static boolean`	`initNeeded`
`String`	`maxNounSynsetID`
`String`	`maxVerbSynsetID`
`MultiWords`	`multiWords`
`static int`	`NOUN`
`Hashtable<String,String>`	`nounDocumentationHash`
`Hashtable<String,String>`	`nounSUMOHash`
`Hashtable<String,String>`	`nounSynsetHash`
`HashMap<String,HashMap<String,String>>`	`OMW` A HashMap with language name keys and HashMap values.
`Hashtable<String,ArrayList<AVPair>>`	`relations` Keys are POS-prefixed synsets, values are ArrayList(s) of AVPair(s) in which the attribute is a pointer type according to http://wordnet.princeton.edu/man/wninput.5WN.html#sect3 and the value is a POS-prefixed synset @see WordNetUtilities.convertWordNetPointer
`HashMap<String,String>`	`reverseSenseIndex` A HashMap where the keys are 9 digit POS prefixed WordNet synset byte offsets, and the values are of the form word_POS_sensenum (alpha POS like "VB").
`HashMap<String,Integer>`	`senseFrequencies` a HashMap where the key is a 9-digit POS-prefixed sense and the value is a the number of times that sense occurs in the Brown corpus.
`HashMap<String,String>`	`senseIndex` A HashMap where the keys are of the form word_POS_sensenum (alpha POS like "VB") and values are 8 digit WordNet synset byte offsets.
`ArrayList<String>`	`stopwords` English "stop words" such as "a", "at", "them", which have no or little inherent meaning when taken alone.
`Hashtable<String,ArrayList<String>>`	`SUMOHash` Keys are SUMO terms, values are ArrayLists(s) of POS-prefixed synset String(s) meaning that the part of speech code is prepended to the synset number.
`Hashtable<String,ArrayList<String>>`	`synsetsToWords` Keys are String POS-prefixed synsets.
`static int`	`VERB`
`Hashtable<String,String>`	`verbDocumentationHash`
`HashMap<String,ArrayList<String>>`	`verbFrames` A HashMap where keys are 8 digit WordNet synset byte offsets or synsets appended with a dash and a specific word such as "12345678-foo".
`Hashtable<String,String>`	`verbSUMOHash`
`Hashtable<String,String>`	`verbSynsetHash`
`static WordNet`	`wn`
`static HashMap<String,WordNet>`	`wns`
`protected HashMap<String,HashMap<String,Integer>>`	`wordCoFrequencies` a HashMap of HashMaps where the key is a word sense of the form word_POS_num signifying the word, part of speech and number of the sense in WordNet.
`protected HashMap<String,TreeSet<AVPair>>`	`wordFrequencies` a HashMap of HashMaps where the key is a word and the value is a HashMap of 9-digit POS-prefixed senses and the number of times that sense occurs in the Brown corpus.
`HashMap<String,ArrayList<String>>`	`wordsToSenses` A HashMap with words as keys and ArrayList as values.

Constructor Summary

Constructors
Constructor and Description

WordNet()

Constructors
Constructor and Description
`WordNet()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HashMap<String,Integer>`	`collectCountedWordSenses(String sentence)` Collect all the synsets that represent the best guess at meanings for all the words in a sentence.
`boolean`	`containsWord(String word, int pos)` Does WordNet contain the given word.
`String`	`displayByKey(String sumokbname, String key, String params)`
`String`	`displaySynset(String sumokbname, String synset, String params)`
`String`	`generateNounSynsetID()` Generate a new noun synset ID that doesn't have an existing hash
`String`	`generateVerbSynsetID()` Generate a new noun synset ID that doesn't have an existing hash
`String`	`getDocumentation(String synset)`
`MultiWords`	`getMultiWords()`
`TreeMap<String,ArrayList<String>>`	`getSensesFromWord(String word)` Get all the synsets for a given word.
`String`	`getSUMOMapping(String synset)` Get the SUMO mapping for a POS-prefixed synset
`String`	`getSUMOterm(String word, int pos)` Get the SUMO term for the given root form word and part of speech.
`File`	`getWnFile(String key)` Returns the WordNet File object corresponding to key.
`ArrayList<String>`	`getWordsFromSynset(String synset)`
`TreeMap<String,String>`	`getWordsFromTerm(String SUMOterm)` Get the words and synsets corresponding to a SUMO term.
`static void`	`initOnce()` Read the WordNet files only on initialization of the class.
`boolean`	`isFile(String s)`
`boolean`	`isHyponym(String synset, String hypo)`
`boolean`	`isHyponymRecurse(String synset, String hypo, ArrayList<String> visited)`
`boolean`	`isStopWord(String word)` Check whether the word is a stop word
`static void`	`main(String[] args)` A main method, used only for testing.
`String`	`nounRootForm(String mixedCase, String input)` Return the root form of the noun, or null if it's not in the lexicon.
`String`	`nounSynsetFromTermFormat(String tf, String SUMOterm, KB kb)` Generate a new noun synset from a termFormat
`String`	`page(String inp, int pos, String kbname, String synset, String params)` This is the regular point of entry for this class.
`protected boolean`	`processNounLine(String line)`
`String`	`processPrologString(String doc)` Double any single quotes that appear.
`void`	`readSenseCount()` Read word sense frequencies into a HashMap of PriorityQueues containing AVPairs where the value is a word and the attribute (on which PriorityQueue is sorted) is an 8 digit String representation of an integer count.
`void`	`readSenseIndex()` Note that WordNet forces all these words to lowercase in the index.xxx files
`void`	`readStopWords()`
`void`	`readWordCoFrequencies()` Return a HashMap of HashMaps where the key is a word sense of the form word_POS_num signifying the word, part of speech and number of the sense in WordNet.
`String`	`removeStopWords(String sentence)` Remove stop words from a sentence.
`String`	`senseKeyPOS(String senseKey)`
`static ArrayList<String>`	`splitToArrayList(String st)` Return an ArrayList of the string split by spaces.
`static ArrayList<String>`	`splitToArrayListSentence(String st)` Return an ArrayList of the string split by periods.
`String`	`sumoFileDisplay(String pathname, String counter, String params)` A routine which takes a full pathname as input and returns a sentence by sentence display of sense and sentiment analysis
`String`	`sumoSentenceDisplay(String input, String context, String params)` A routine which looks up a given list of words in the hashtables to find the relevant word definitions and SUMO mappings.
`String`	`sumoSentimentDisplay(String sentence)` A routine that uses computeSentiment in DB.java to display a sentiment score for a single sentence as well as the individual scores of scored descriptors.
`void`	`synsetFromTermFormat(String tf, String SUMOterm, KB kb)` Generate a new synset from a termFormat
`void`	`termFormatsToSynsets(KB kb)` Generate a new synset from a termFormat
`static void`	`testProcessPointers()` A method used only for testing.
`static void`	`testWordFreq()` A method used only for testing.
`String`	`verbRootForm(String mixedCase, String input)` Return the present tense singular form of the verb, or null if it's not in the lexicon.
`String`	`verbSynsetFromTermFormat(String tf, String SUMOterm, KB kb)` Generate a new verb synset from a termFormat
`void`	`writeProlog(KB kb)`
`void`	`writeWordNetG()`
`void`	`writeWordNetHyp()`
`void`	`writeWordNetProlog()`
`void`	`writeWordNetS()` Write WordNet data to a prolog file with a single kind of clause in the following format: s(Synset_ID, Word_No_in_the_Synset, Word, SS_Type, Synset_Rank_By_the_Word,Tag_Count)
`void`	`writeXML()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - wn
```
public static WordNet wn
```
  - wns
```
public static HashMap<String,WordNet> wns
```
  - initNeeded
```
public static boolean initNeeded
```
  - nounSynsetHash
```
public Hashtable<String,String> nounSynsetHash
```
  - verbSynsetHash
```
public Hashtable<String,String> verbSynsetHash
```
  - adjectiveSynsetHash
```
public Hashtable<String,String> adjectiveSynsetHash
```
  - adverbSynsetHash
```
public Hashtable<String,String> adverbSynsetHash
```
  - verbDocumentationHash
```
public Hashtable<String,String> verbDocumentationHash
```
  - adjectiveDocumentationHash
```
public Hashtable<String,String> adjectiveDocumentationHash
```
  - adverbDocumentationHash
```
public Hashtable<String,String> adverbDocumentationHash
```
  - nounDocumentationHash
```
public Hashtable<String,String> nounDocumentationHash
```
  - nounSUMOHash
```
public Hashtable<String,String> nounSUMOHash
```
  - verbSUMOHash
```
public Hashtable<String,String> verbSUMOHash
```
  - adjectiveSUMOHash
```
public Hashtable<String,String> adjectiveSUMOHash
```
  - adverbSUMOHash
```
public Hashtable<String,String> adverbSUMOHash
```
  - maxNounSynsetID
```
public String maxNounSynsetID
```
  - maxVerbSynsetID
```
public String maxVerbSynsetID
```
  - SUMOHash
```
public Hashtable<String,ArrayList<String>> SUMOHash
```
    Keys are SUMO terms, values are ArrayLists(s) of POS-prefixed synset String(s) meaning that the part of speech code is prepended to the synset number.
  - synsetsToWords
```
public Hashtable<String,ArrayList<String>> synsetsToWords
```
    Keys are String POS-prefixed synsets. Values are ArrayList(s) of String(s) which are words. Note that the order of words in the file is preserved.
  - exceptionNounHash
```
public Hashtable<String,String> exceptionNounHash
```
    list of irregular plural forms where the key is the plural, singular is the value.
  - exceptionVerbHash
```
public Hashtable<String,String> exceptionVerbHash
```
  - relations
```
public Hashtable<String,ArrayList<AVPair>> relations
```
    Keys are POS-prefixed synsets, values are ArrayList(s) of AVPair(s) in which the attribute is a pointer type according to http://wordnet.princeton.edu/man/wninput.5WN.html#sect3 and the value is a POS-prefixed synset @see WordNetUtilities.convertWordNetPointer
  - wordCoFrequencies
```
protected HashMap<String,HashMap<String,Integer>> wordCoFrequencies
```
    a HashMap of HashMaps where the key is a word sense of the form word_POS_num signifying the word, part of speech and number of the sense in WordNet. The value is a HashMap of words and the number of times that word cooccurs in sentences with the word sense given in the key.
  - wordFrequencies
```
protected HashMap<String,TreeSet<AVPair>> wordFrequencies
```
    a HashMap of HashMaps where the key is a word and the value is a HashMap of 9-digit POS-prefixed senses and the number of times that sense occurs in the Brown corpus.
  - senseFrequencies
```
public HashMap<String,Integer> senseFrequencies
```
    a HashMap where the key is a 9-digit POS-prefixed sense and the value is a the number of times that sense occurs in the Brown corpus.
  - stopwords
```
public ArrayList<String> stopwords
```
    English "stop words" such as "a", "at", "them", which have no or little inherent meaning when taken alone.
  - senseIndex
```
public HashMap<String,String> senseIndex
```
    A HashMap where the keys are of the form word_POS_sensenum (alpha POS like "VB") and values are 8 digit WordNet synset byte offsets.
  - reverseSenseIndex
```
public HashMap<String,String> reverseSenseIndex
```
    A HashMap where the keys are 9 digit POS prefixed WordNet synset byte offsets, and the values are of the form word_POS_sensenum (alpha POS like "VB").
  - verbFrames
```
public HashMap<String,ArrayList<String>> verbFrames
```
    A HashMap where keys are 8 digit WordNet synset byte offsets or synsets appended with a dash and a specific word such as "12345678-foo". Values are ArrayList(s) of String verb frame numbers.
  - wordsToSenses
```
public HashMap<String,ArrayList<String>> wordsToSenses
```
    A HashMap with words as keys and ArrayList as values. The ArrayList contains word senses which are Strings of the form word_POS_num (alpha POS like "VB") signifying the word, part of speech and number of the sense in WordNet.
  - multiWords
```
public MultiWords multiWords
```
  - NOUN
```
public static final int NOUN
```
    See Also:
    
    Constant Field Values
  - VERB
```
public static final int VERB
```
    See Also:
    
    Constant Field Values
  - ADJECTIVE
```
public static final int ADJECTIVE
```
    See Also:
    
    Constant Field Values
  - ADVERB
```
public static final int ADVERB
```
    See Also:
    
    Constant Field Values
  - ADJECTIVE_SATELLITE
```
public static final int ADJECTIVE_SATELLITE
```
    See Also:
    
    Constant Field Values
  - OMW
```
public HashMap<String,HashMap<String,String>> OMW
```
    A HashMap with language name keys and HashMap values. The interior HashMap has String keys which are PWN30 synsets with 8-digit synsets a dash and then a alphabetic part of speech character. Values are words in the target language.
- Constructor Detail
  - WordNet
```
public WordNet()
```
- Method Detail
  - getMultiWords
```
public MultiWords getMultiWords()
```
  - getWnFile
```
public File getWnFile(String key)
```
    Returns the WordNet File object corresponding to key. The purpose of this accessor is to make it easier to deal with possible changes to these file names, since the descriptive key, ideally, need not change. Each key maps to a regular expression that is used to match against filenames found in the directory denoted by WordNet.baseDir. If multiple filenames match the pattern for one key, then the file that was most recently changed (presumably, saved) is chosen.
    
    Parameters:
    
    key - A descriptive literal String that maps to a regular expression pattern used to obtain a WordNet file.
    
    Returns:
    
    A File object
  - splitToArrayList
```
public static ArrayList<String> splitToArrayList(String st)
```
    Return an ArrayList of the string split by spaces.
  - splitToArrayListSentence
```
public static ArrayList<String> splitToArrayListSentence(String st)
```
    Return an ArrayList of the string split by periods.
  - getSUMOMapping
```
public String getSUMOMapping(String synset)
```
    Get the SUMO mapping for a POS-prefixed synset
  - processNounLine
```
protected boolean processNounLine(String line)
```
  - readWordCoFrequencies
```
public void readWordCoFrequencies()
```
    Return a HashMap of HashMaps where the key is a word sense of the form word_POS_num signifying the word, part of speech and number of the sense in WordNet. The value is a HashMap of words and the number of times that word cooccurs in sentences with the word sense given in the key.
  - readStopWords
```
public void readStopWords()
```
  - readSenseIndex
```
public void readSenseIndex()
```
    Note that WordNet forces all these words to lowercase in the index.xxx files
  - readSenseCount
```
public void readSenseCount()
```
    Read word sense frequencies into a HashMap of PriorityQueues containing AVPairs where the value is a word and the attribute (on which PriorityQueue is sorted) is an 8 digit String representation of an integer count.
  - sumoSentenceDisplay
```
public String sumoSentenceDisplay(String input,
                                  String context,
                                  String params)
```
    A routine which looks up a given list of words in the hashtables to find the relevant word definitions and SUMO mappings.
    
    Parameters:
    
    input - is the target sentence to be parsed. See WordSenseBody.jsp for usage.
    
    context - is the larger context of the sentence. Can mean more accurate results.
    
    params - is the set of html parameters
  - sumoSentimentDisplay
```
public String sumoSentimentDisplay(String sentence)
```
    A routine that uses computeSentiment in DB.java to display a sentiment score for a single sentence as well as the individual scores of scored descriptors.
    
    Parameters:
    
    sentence - is the target sentence to be scored. See WordSenseBody.jsp for usage.
  - sumoFileDisplay
```
public String sumoFileDisplay(String pathname,
                              String counter,
                              String params)
```
    A routine which takes a full pathname as input and returns a sentence by sentence display of sense and sentiment analysis
    
    Parameters:
    
    pathname -
    
    counter - is used to keep track of which sentence is being displayed
    
    params - is the set of html parameters
  - isFile
```
public boolean isFile(String s)
```
    Returns:
    
    true if the input String is a file pathname. Determined by whether the string contains a forward or backward slash. This is only used in WordSense.jsp and will fail if a sentence that is not a file contains a forward or back slash.
  - isHyponymRecurse
```
public boolean isHyponymRecurse(String synset,
                                String hypo,
                                ArrayList<String> visited)
```
    Returns:
    
    true if the first POS-prefixed synset is a hyponym of the second POS-prefixed synset. This is a recursive method.
  - isHyponym
```
public boolean isHyponym(String synset,
                         String hypo)
```
    Returns:
    
    true if the first POS-prefixed synset is a hyponym of the second POS-prefixed synset. This is a recursive method.
  - removeStopWords
```
public String removeStopWords(String sentence)
```
    Remove stop words from a sentence.
  - isStopWord
```
public boolean isStopWord(String word)
```
    Check whether the word is a stop word
  - collectCountedWordSenses
```
public HashMap<String,Integer> collectCountedWordSenses(String sentence)
```
    Collect all the synsets that represent the best guess at meanings for all the words in a sentence. Keep track of how many times each sense appears.
  - initOnce
```
public static void initOnce()
```
    Read the WordNet files only on initialization of the class.
  - nounRootForm
```
public String nounRootForm(String mixedCase,
                           String input)
```
    Return the root form of the noun, or null if it's not in the lexicon.
  - verbRootForm
```
public String verbRootForm(String mixedCase,
                           String input)
```
    Return the present tense singular form of the verb, or null if it's not in the lexicon.
  - getSensesFromWord
```
public TreeMap<String,ArrayList<String>> getSensesFromWord(String word)
```
    Get all the synsets for a given word.
    
    Returns:
    
    a TreeMap of word keys and values that are ArrayLists of synset Strings
  - getWordsFromTerm
```
public TreeMap<String,String> getWordsFromTerm(String SUMOterm)
```
    Get the words and synsets corresponding to a SUMO term. The return is a Map of words with their corresponding synset number.
  - getWordsFromSynset
```
public ArrayList<String> getWordsFromSynset(String synset)
```
  - getSUMOterm
```
public String getSUMOterm(String word,
                          int pos)
```
    Get the SUMO term for the given root form word and part of speech.
  - containsWord
```
public boolean containsWord(String word,
                            int pos)
```
    Does WordNet contain the given word.
  - page
```
public String page(String inp,
                   int pos,
                   String kbname,
                   String synset,
                   String params)
```
    This is the regular point of entry for this class. It takes the word the user is searching for, and the part of speech index, does the search, and returns the string with HTML formatting codes to present to the user. The part of speech codes must be the same as in the menu options in WordNet.jsp and Browse.jsp
    
    Parameters:
    
    inp - The string the user is searching for.
    
    pos - The part of speech of the word 1=noun, 2=verb, 3=adjective, 4=adverb
    
    Returns:
    
    A string contained the HTML formatted search result.
  - getDocumentation
```
public String getDocumentation(String synset)
```
    Parameters:
    
    synset - is a synset with POS-prefix
  - displaySynset
```
public String displaySynset(String sumokbname,
                            String synset,
                            String params)
```
    Parameters:
    
    synset - is a synset with POS-prefix
  - displayByKey
```
public String displayByKey(String sumokbname,
                           String key,
                           String params)
```
    Parameters:
    
    key - is a WordNet sense key
    
    Returns:
    
    9-digit POS-prefix and synset number
  - writeXML
```
public void writeXML()
```
  - writeProlog
```
public void writeProlog(KB kb)
```
  - senseKeyPOS
```
public String senseKeyPOS(String senseKey)
```
  - writeWordNetS
```
public void writeWordNetS()
```
    Write WordNet data to a prolog file with a single kind of clause in the following format: s(Synset_ID, Word_No_in_the_Synset, Word, SS_Type, Synset_Rank_By_the_Word,Tag_Count)
  - writeWordNetHyp
```
public void writeWordNetHyp()
```
  - processPrologString
```
public String processPrologString(String doc)
```
    Double any single quotes that appear.
  - writeWordNetG
```
public void writeWordNetG()
```
  - writeWordNetProlog
```
public void writeWordNetProlog()
                        throws IOException
```
    Throws:
    
    IOException
  - generateNounSynsetID
```
public String generateNounSynsetID()
```
    Generate a new noun synset ID that doesn't have an existing hash
  - generateVerbSynsetID
```
public String generateVerbSynsetID()
```
    Generate a new noun synset ID that doesn't have an existing hash
  - nounSynsetFromTermFormat
```
public String nounSynsetFromTermFormat(String tf,
                                       String SUMOterm,
                                       KB kb)
```
    Generate a new noun synset from a termFormat
  - verbSynsetFromTermFormat
```
public String verbSynsetFromTermFormat(String tf,
                                       String SUMOterm,
                                       KB kb)
```
    Generate a new verb synset from a termFormat
  - synsetFromTermFormat
```
public void synsetFromTermFormat(String tf,
                                 String SUMOterm,
                                 KB kb)
```
    Generate a new synset from a termFormat
  - termFormatsToSynsets
```
public void termFormatsToSynsets(KB kb)
```
    Generate a new synset from a termFormat
  - testWordFreq
```
public static void testWordFreq()
```
    A method used only for testing. It should not be called during normal operation.
  - testProcessPointers
```
public static void testProcessPointers()
```
    A method used only for testing. It should not be called during normal operation.
  - main
```
public static void main(String[] args)
```
    A main method, used only for testing. It should not be called during normal operation.

Class WordNet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

wn

wns

initNeeded

nounSynsetHash

verbSynsetHash

adjectiveSynsetHash

adverbSynsetHash

verbDocumentationHash

adjectiveDocumentationHash

adverbDocumentationHash

nounDocumentationHash

nounSUMOHash

verbSUMOHash

adjectiveSUMOHash

adverbSUMOHash

maxNounSynsetID

maxVerbSynsetID

SUMOHash

synsetsToWords

exceptionNounHash

exceptionVerbHash

relations

wordCoFrequencies

wordFrequencies

senseFrequencies

stopwords

senseIndex

reverseSenseIndex

verbFrames

wordsToSenses

multiWords

NOUN

VERB

ADJECTIVE

ADVERB

ADJECTIVE_SATELLITE

OMW

Constructor Detail

WordNet

Method Detail

getMultiWords

getWnFile

splitToArrayList

splitToArrayListSentence

getSUMOMapping

processNounLine

readWordCoFrequencies

readStopWords

readSenseIndex

readSenseCount

sumoSentenceDisplay

sumoSentimentDisplay

sumoFileDisplay

isFile

isHyponymRecurse

isHyponym

removeStopWords

isStopWord

collectCountedWordSenses

initOnce

nounRootForm

verbRootForm

getSensesFromWord

getWordsFromTerm

getWordsFromSynset

getSUMOterm

containsWord

page

getDocumentation

displaySynset

displayByKey

writeXML

writeProlog

senseKeyPOS