WordNetUtilities (sigma-component 2.09 API)

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

public class WordNetUtilities
extends Object

Author:: Adam Pease

Field Summary

Fields
Modifier and Type Field and Description

static int TPTPidCounter

protected static ArrayList<String> WordNetRelations

Fields
Modifier and Type	Field and Description
`static int`	`TPTPidCounter`
`protected static ArrayList<String>`	`WordNetRelations`

Constructor Summary

Constructors
Constructor and Description

WordNetUtilities()

Constructors
Constructor and Description
`WordNetUtilities()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`commentSentiment(String fileWithPath)`
`static ArrayList<String>`	`convertTermList(String termList)` Convert a list of Terms in the format "&%term1 &%term2" to an ArrayList of bare term Strings
`static String`	`convertWordNetPointer(String ptr)`
`static void`	`deduceMissingLinks()` Use the WordNet hyper-/hypo-nym links to deduce a likely link for a SUMO term that has not yet been manually linked.
`static void`	`extractMeronyms()` A utility to extract meronym relations as relations between SUMO terms.
`static HashSet<String>`	`findLeaves(String rel)` Find all the leaf nodes for a particular relation in WordNet.
`static HashSet<String>`	`findLeavesInTree(HashSet<String> rels)` Find all the leaf nodes for a particular relation in WordNet.
`static ArrayList<ArrayList<String>>`	`findPathsToRoot(ArrayList<String> base, String synset)` Find the complete path from a given synset.
`static String`	`formatWords(TreeMap<String,String> words, String kbName)` HTML format a TreeMap of word senses and their associated synset
`static String`	`formatWordsList(TreeMap<String,ArrayList<String>> words, String kbName)` HTML format a TreeMap of ArrayLists word senses
`static String`	`getBareSUMOTerm(String term)` Get a SUMO term minus its &% prefix and one character mapping suffix.
`static String`	`getPOSfromKey(String senseKey)` Extract the POS from a word_POS_num sense key.
`static String`	`getSenseFromKey(String senseKey)` Extract the synset corresponding to a word_POS_num sense key.
`static char`	`getSUMOMappingSuffix(String term)` Get a SUMO term mapping suffix.
`static String`	`getWordFromKey(String senseKey)` Extract the word from a word_POS_num sense key.
`void`	`imageNetLinks()` Import links from www.image-net.org that are linked to WordNet and links them to SUMO terms when the synset has a directly equivalent SUMO term
`static String`	`lowestCommonParent(String s1, String s2)`
`static void`	`main(String[] args)` A main method, used only for testing.
`static String`	`mappingCharToName(char mappingType)`
`static void`	`mergeUpdates()` Read in a file with a nine-digit synset number followed by a space and a SUMO term.
`static int`	`numSynsets(char pos)`
`static String`	`posLettersToNumber(String pos)` Convert a part of speech number to the two letter format used by the WordNet sense index code.
`static char`	`posLetterToNumber(char POS)`
`static char`	`posNumberToLetter(char POS)`
`static String`	`posNumberToLetters(String pos)` Convert a part of speech number to the two letter format used by the WordNet sense index code.
`static String`	`printStatistics()`
`static void`	`processMissingLinks(String fileName, String pattern, String posNum)` This is a utility routine that should not be called during normal Sigma operation.
`static String`	`removeTermPrefixes(String formula)`
`static void`	`searchCoherence(String fileWithPath)` Take a file of tabtab and calculate the average Levenshtein distance for each ID.
`static int`	`sensePOS(String sense)` Take a WordNet sense identifier, and return the integer part of speech code.
`static void`	`showAllLeaves()`
`static void`	`showAllRoots()`
`static String`	`subst(String result, String match, String subst)` A utility function that mimics the functionality of the perl substitution feature (s/match/replacement/).
`static boolean`	`substTest(String result, String match, String subst, Hashtable<String,String> hash)` A utility function that mimics the functionality of the perl substitution feature (s/match/replacement/) but rather than returning the result of the substitution, just tests whether the result is a key in a hashtable.
`static String`	`synsetToOneWord(String s)`
`void`	`updateWNversion()` Port the mappings from one version of WordNet to another.
`void`	`updateWNversionProcess(String fileName, String pattern, String posNum)` This is a utility routine that should not be called during normal Sigma operation.
`void`	`updateWNversionReading(String fileName, String pattern, String posNum)` Read the version mapping files and store in the HashMap called "mappings".
`static String`	`verbPlural(String verb)` Return the plural form of the verb.
`static HashSet<String>`	`wordsToSynsets(String word)`
`static void`	`writeTPTPWordNet(PrintWriter pw)` Write TPTP format for WordNet

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

- Field Detail
  - TPTPidCounter
```
public static int TPTPidCounter
```
  - WordNetRelations
```
protected static ArrayList<String> WordNetRelations
```
- Constructor Detail
  - WordNetUtilities
```
public WordNetUtilities()
```
- Method Detail
  - getBareSUMOTerm
```
public static String getBareSUMOTerm(String term)
```
    Get a SUMO term minus its &% prefix and one character mapping suffix.
  - getPOSfromKey
```
public static String getPOSfromKey(String senseKey)
```
    Extract the POS from a word_POS_num sense key. Should be an alpha key, such as "VB".
  - getWordFromKey
```
public static String getWordFromKey(String senseKey)
```
    Extract the word from a word_POS_num sense key.
  - getSenseFromKey
```
public static String getSenseFromKey(String senseKey)
```
    Extract the synset corresponding to a word_POS_num sense key.
  - removeTermPrefixes
```
public static String removeTermPrefixes(String formula)
```
  - convertTermList
```
public static ArrayList<String> convertTermList(String termList)
```
    Convert a list of Terms in the format "&%term1 &%term2" to an ArrayList of bare term Strings
  - getSUMOMappingSuffix
```
public static char getSUMOMappingSuffix(String term)
```
    Get a SUMO term mapping suffix.
  - convertWordNetPointer
```
public static String convertWordNetPointer(String ptr)
```
  - posLetterToNumber
```
public static char posLetterToNumber(char POS)
```
  - posNumberToLetter
```
public static char posNumberToLetter(char POS)
```
  - posNumberToLetters
```
public static String posNumberToLetters(String pos)
```
    Convert a part of speech number to the two letter format used by the WordNet sense index code. Defaults to noun "NN".
  - posLettersToNumber
```
public static String posLettersToNumber(String pos)
```
    Convert a part of speech number to the two letter format used by the WordNet sense index code. Defaults to noun "NN".
  - sensePOS
```
public static int sensePOS(String sense)
```
    Take a WordNet sense identifier, and return the integer part of speech code.
  - mappingCharToName
```
public static String mappingCharToName(char mappingType)
```
  - subst
```
public static String subst(String result,
                           String match,
                           String subst)
```
    A utility function that mimics the functionality of the perl substitution feature (s/match/replacement/). Note that only one replacement is made, not a global replacement.
    
    Parameters:
    
    result - is the string on which the substitution is performed.
    
    match - is the substring to be found and replaced.
    
    subst - is the string replacement for match.
    
    Returns:
    
    is a String containing the result of the substitution.
  - substTest
```
public static boolean substTest(String result,
                                String match,
                                String subst,
                                Hashtable<String,String> hash)
```
    A utility function that mimics the functionality of the perl substitution feature (s/match/replacement/) but rather than returning the result of the substitution, just tests whether the result is a key in a hashtable. Note that only one replacement is made, not a global replacement.
    
    Parameters:
    
    result - is the string on which the substitution is performed.
    
    match - is the substring to be found and replaced.
    
    subst - is the string replacement for match.
    
    hash - is a hashtable to be checked against the result.
    
    Returns:
    
    is a boolean indicating whether the result of the substitution was found in the hashtable.
  - verbPlural
```
public static String verbPlural(String verb)
```
    Return the plural form of the verb. Handle multi-word phrases to modify only the first word.
  - formatWords
```
public static String formatWords(TreeMap<String,String> words,
                                 String kbName)
```
    HTML format a TreeMap of word senses and their associated synset
  - formatWordsList
```
public static String formatWordsList(TreeMap<String,ArrayList<String>> words,
                                     String kbName)
```
    HTML format a TreeMap of ArrayLists word senses
  - mergeUpdates
```
public static void mergeUpdates()
                         throws IOException
```
    Read in a file with a nine-digit synset number followed by a space and a SUMO term. If the term is more specific than the current mapping for that synset, replace the old term. This is a utility that is not normally called from the interactive Sigma system.
    
    Throws:
    
    IOException
  - processMissingLinks
```
public static void processMissingLinks(String fileName,
                                       String pattern,
                                       String posNum)
                                throws IOException
```
    This is a utility routine that should not be called during normal Sigma operation. It does most of the actual work for deduceMissingLinks()
    
    Throws:
    
    IOException
  - deduceMissingLinks
```
public static void deduceMissingLinks()
                               throws IOException
```
    Use the WordNet hyper-/hypo-nym links to deduce a likely link for a SUMO term that has not yet been manually linked. This is a utility routine that should not be called during normal Sigma operation.
    
    Throws:
    
    IOException
  - updateWNversionProcess
```
public void updateWNversionProcess(String fileName,
                                   String pattern,
                                   String posNum)
                            throws IOException
```
    This is a utility routine that should not be called during normal Sigma operation. It does most of the actual work for updateWNversion(). The output is a set of WordNet data files with a "-new" suffix.
    
    Throws:
    
    IOException
  - updateWNversionReading
```
public void updateWNversionReading(String fileName,
                                   String pattern,
                                   String posNum)
                            throws IOException
```
    Read the version mapping files and store in the HashMap called "mappings".
    
    Throws:
    
    IOException
  - updateWNversion
```
public void updateWNversion()
                     throws IOException
```
    Port the mappings from one version of WordNet to another. It calls updateWNversionReading to do most of the work. It assumes that the mapping file has the new synset first and the old one second. File names are for the new WordNet version, which will need to have different names from the old version that WordNet.java needs to read in order to get the existing mappings. This is a utility which should not be called during normal Sigma operation. Mapping files are in a simple format produced by University of Catalonia and available at http://www.lsi.upc.edu/~nlp/web/index.php?option=com_content&task=view&id=21&Itemid=57 If that address changes you may also start at http://www.lsi.upc.edu/~nlp/web/ and go to Resources and then an item on WordNet mappings.
    
    Throws:
    
    IOException
  - numSynsets
```
public static int numSynsets(char pos)
```
    Returns:
    
    the number of synsets in WordNet for the given part of speech
  - printStatistics
```
public static String printStatistics()
```
  - imageNetLinks
```
public void imageNetLinks()
                   throws IOException
```
    Import links from www.image-net.org that are linked to WordNet and links them to SUMO terms when the synset has a directly equivalent SUMO term
    
    Throws:
    
    IOException
  - extractMeronyms
```
public static void extractMeronyms()
```
    A utility to extract meronym relations as relations between SUMO terms. Filter out relations between genus and species, which shouldn't be meronyms
  - searchCoherence
```
public static void searchCoherence(String fileWithPath)
```
    Take a file of tabtab and calculate the average Levenshtein distance for each ID.
  - commentSentiment
```
public static void commentSentiment(String fileWithPath)
```
  - writeTPTPWordNet
```
public static void writeTPTPWordNet(PrintWriter pw)
                             throws IOException
```
    Write TPTP format for WordNet
    
    Throws:
    
    IOException
  - findLeavesInTree
```
public static HashSet<String> findLeavesInTree(HashSet<String> rels)
```
    Find all the leaf nodes for a particular relation in WordNet. Note that the leaf must have a link from another node to be a leaf. No isolated nodes can be considered leaves.
    
    Returns:
    
    a list of POS-prefixed synsets
  - findPathsToRoot
```
public static ArrayList<ArrayList<String>> findPathsToRoot(ArrayList<String> base,
                                                           String synset)
```
    Find the complete path from a given synset. If multiple inheritance results in multiple paths, return them all.
  - lowestCommonParent
```
public static String lowestCommonParent(String s1,
                                        String s2)
```
  - findLeaves
```
public static HashSet<String> findLeaves(String rel)
```
    Find all the leaf nodes for a particular relation in WordNet. Note that a node may be a leaf simply because it has no such link to another node.
    
    Returns:
    
    a list of POS-prefixed synsets
  - showAllLeaves
```
public static void showAllLeaves()
```
  - showAllRoots
```
public static void showAllRoots()
```
  - wordsToSynsets
```
public static HashSet<String> wordsToSynsets(String word)
```
    Returns:
    
    POS-prefixed synsets
  - synsetToOneWord
```
public static String synsetToOneWord(String s)
```
  - main
```
public static void main(String[] args)
```
    A main method, used only for testing. It should not be called during normal operation.

Class WordNetUtilities

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TPTPidCounter

WordNetRelations

Constructor Detail

WordNetUtilities

Method Detail

getBareSUMOTerm

getPOSfromKey

getWordFromKey

getSenseFromKey

removeTermPrefixes

convertTermList

getSUMOMappingSuffix

convertWordNetPointer

posLetterToNumber

posNumberToLetter

posNumberToLetters

posLettersToNumber

sensePOS

mappingCharToName

subst

substTest

verbPlural

formatWords

formatWordsList

mergeUpdates

processMissingLinks

deduceMissingLinks

updateWNversionProcess

updateWNversionReading

updateWNversion

numSynsets

printStatistics

imageNetLinks

extractMeronyms

searchCoherence

commentSentiment

writeTPTPWordNet

findLeavesInTree

findPathsToRoot

lowestCommonParent

findLeaves

showAllLeaves

showAllRoots

wordsToSynsets

synsetToOneWord

main