prajna.text

Class WordNetExplorer

java.lang.Object

prajna.text.WordNetExplorer

public class WordNetExplorer
extends java.lang.Object

Provides multiple utilities for exploring and extracting information from Princeton Wordnet data files.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
WordNetExplorer(java.io.File wordNetData) Initialize the WordNetExplorer
WordNetExplorer(java.lang.String wordNetData) Initialize the WordNetExplorer
WordNetExplorer(java.net.URL wordNetUrl) Initialize the WordNetExplorer using a URL location for the data files

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canExplore(PartOfSpeech pos) Return whether this WordNetExplorer can handle a particular part of speech.
java.lang.String	getBaseWord(java.lang.String word, PartOfSpeech pos) Get the base word for a particular word.
java.io.File	getDirectory() Get the directory location of the WordNet files
java.util.Set<java.lang.String>	getParentConcepts(java.lang.String word, PartOfSpeech pos) Get the hierarchical set of hypernyms for the word.
java.util.Set<java.lang.String>	getRelated(java.lang.String pattern) Get the related terms from an encoded pattern.
java.util.Set<java.lang.String>	getRelated(java.lang.String word, PartOfSpeech pos, int[] senses, java.lang.String flags) Get related terms and concepts for a particular word.
java.util.Set<java.lang.String>	getRelated(java.lang.String word, PartOfSpeech pos, java.lang.String flags) Get related terms and concepts for a particular word.
java.util.List<java.lang.String>	getSenseDescriptions(java.lang.String word, PartOfSpeech pos) Get the list of sense descriptions for the given word.
java.util.Set<java.lang.String>	getSynonyms(java.lang.String word, PartOfSpeech pos) Get synonyms for a particular word.
java.util.Set<java.lang.String>	getSynonyms(java.lang.String word, PartOfSpeech pos, int[] senses) Get synonyms for a particular word.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordNetExplorer

public WordNetExplorer(java.io.File wordNetData)

Initialize the WordNetExplorer

Parameters:

wordNetData - the directory where the data files reside.

WordNetExplorer

public WordNetExplorer(java.lang.String wordNetData)

Initialize the WordNetExplorer

Parameters:

wordNetData - the directory where the data files reside.

WordNetExplorer

public WordNetExplorer(java.net.URL wordNetUrl)

Initialize the WordNetExplorer using a URL location for the data files

Parameters:

wordNetUrl - the directory where the data files reside.

Method Detail

canExplore

public boolean canExplore(PartOfSpeech pos)

Return whether this WordNetExplorer can handle a particular part of speech. The WordNetExplorer returns true if pos is NOUN, VERB, ADJECTIVE or ADVERB.

Parameters:

pos - the part of speech to explore

Returns:

true if the WordnetExplorer can handle the part of speech, false otherwise.

getBaseWord

public java.lang.String getBaseWord(java.lang.String word,
                           PartOfSpeech pos)

Get the base word for a particular word. This attempts to identify the stem of a word. If the word has no stem (or is its own stem), the word itself is returned. If the word does not appear in WordNet, this method returns null. If the part of speech is null, this method guesses the part of speech.

Parameters:

word - the word to stem

pos - the part of speech, or null

Returns:

the base word, or stem, of the word

getDirectory

public java.io.File getDirectory()

Get the directory location of the WordNet files

Returns:

the directory location for WordNet

getParentConcepts

public java.util.Set<java.lang.String> getParentConcepts(java.lang.String word,
                                                PartOfSpeech pos)

Get the hierarchical set of hypernyms for the word. A hypernym is the parent concept of a term; for instance vehicle is a hypernym of car. This method recurses, so it will discover and create an entire set of concept ancestors

Parameters:

word - the word to check

pos - the part of speech

Returns:

the set of hypernyms

getRelated

public java.util.Set<java.lang.String> getRelated(java.lang.String pattern)

Get the related terms from an encoded pattern. The pattern argument includes optional parts of speech, senses, and tags. The pattern format is word:X#.#.#:tags, where word represents the word to match. X is a character representing part of speech (n for noun, v for verb, a for adjective, or r for adverb). The # symbols are sense numbers, matching the sense number for the word and part of speech. They are optional, but the part of speech character must be specified if one or more sense numbers are specified. The tags are a collection of symbols matching the Pointer symbols of WordNet. See the WordNet documentation for the pointer symbols. In addition to the pointer symbols, the pipe symbol ('|') represents synonyms.

All parts of the pattern are optional except the word. If the part of speech character is missing, then all parts of speech will be used. Likewise, if no senses are specified, all will be used. If no tags are specified, then only the base word (and its stem) will be returned.

Parameters:

pattern - the pattern to match for related terms

Returns:

the set of matching terms

getRelated

public java.util.Set<java.lang.String> getRelated(java.lang.String word,
                                         PartOfSpeech pos,
                                         int[] senses,
                                         java.lang.String flags)

Get related terms and concepts for a particular word. This method returns those concepts from wordnet that have a particular relation with the provided term. The flags argument specifies which relations are allowed; if null, all relations match. The flags argument consists of one or more strings from the lexicographer files. The senses argument determines which senses of the word to use; if null, all senses are used.

Parameters:

word - the word to check

pos - the part of speech

senses - the sense numbers. If null, all senses are used

flags - the set of lexicographer symbols, concatenated together

Returns:

the set of related terms

getRelated

public java.util.Set<java.lang.String> getRelated(java.lang.String word,
                                         PartOfSpeech pos,
                                         java.lang.String flags)

Get related terms and concepts for a particular word. This method returns those concepts from wordnet that have a particular relation with the provided term. The flags argument specifies which relations are allowed; if null, all relations match. The flags argument consists of one or more strings from the lexicographer files. All senses of the word are checked.

Parameters:

word - the word to check

pos - the part of speech

flags - the set of lexicographer symbols, concatenated together

Returns:

the set of related terms

getSenseDescriptions

public java.util.List<java.lang.String> getSenseDescriptions(java.lang.String word,
                                                    PartOfSpeech pos)

Get the list of sense descriptions for the given word. The sense descriptions correspond to the indexes within the data files

Parameters:

word - the word to check

pos - the part of speech

Returns:

the list of descriptions of the different senses

getSynonyms

public java.util.Set<java.lang.String> getSynonyms(java.lang.String word,
                                          PartOfSpeech pos)

Get synonyms for a particular word. This method returns those terms which are synonymous with the provided word. This method gets synonyms for all senses of the word

Parameters:

word - the word to check

pos - the part of speech

Returns:

the set of synonyms

getSynonyms

public java.util.Set<java.lang.String> getSynonyms(java.lang.String word,
                                          PartOfSpeech pos,
                                          int[] senses)

Get synonyms for a particular word. This method returns those terms which are synonymous with the provided word, and that match the specified senses of the word.

Parameters:

word - the word to check

pos - the part of speech

senses - the sense numbers. If null, all senses are used

Returns:

the set of synonyms