org.licas_text.search.semantic

Class WordNet

java.lang.Object

org.licas_text.search.semantic.OnlineDictionary

org.licas_text.search.semantic.WordNet

All Implemented Interfaces:

java.lang.AutoCloseable

public final class WordNet
extends OnlineDictionary
implements java.lang.AutoCloseable

This class can be used to query and process replies from a local or online WordNet dictionary and thesaurus database, found at http://wordnet.princeton.edu/wordnet/. You need to install WordNet first. The local interface is 'Java API for WordNet Searching (JAWS)', found at http://lyle.smu.edu/~tspell/jaws/index.html, simply because this keeps the package size down to a minimum.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.licas_text.search.semantic.OnlineDictionary

alternativeDefinitions, timeout

Constructor Summary

Constructors

Constructor and Description
WordNet() Create a new instance of WordNet

Method Summary

Modifier and Type	Method and Description
boolean	checkLocalDictionary(java.lang.String localFolder) Check if the local dictionary and file path is OK.
void	close() For garbage collection.
boolean	createLocalDictionary(java.lang.String localFolder) Create an instance of the local dictionary.
edu.smu.tspell.wordnet.Synset[]	getSynsetsLocal(java.lang.String theWord) Get the set of synsets related to the word from a local dictionary.
edu.smu.tspell.wordnet.Synset[]	getSynsetsLocal(java.lang.String theWord, edu.smu.tspell.wordnet.SynsetType type) Get the set of synsets related to the word from a local dictionary.
edu.smu.tspell.wordnet.Synset[]	getSynsetsLocal(java.lang.String theWord, edu.smu.tspell.wordnet.SynsetType type, boolean useMorphology) Get the set of synsets related to the word from a local dictionary.
java.util.HashMap<java.lang.String,?>	queryDictionary(java.util.ArrayList<java.lang.String[]> parameters) Query the dictionary using a single http GET request.
java.util.HashMap<java.lang.String,?>	queryDictionary(java.util.ArrayList<java.lang.String[]> parameters, java.lang.String language) Query the dictionary using a single http GET request.
java.util.HashMap<java.lang.String,?>	queryLocalDictionary(java.util.ArrayList<java.lang.String[]> parameters) Query the dictionary using a single HTTP GET request.
java.util.HashMap<java.lang.String,?>	requeryDictionary(java.lang.String whichMeaning, java.util.ArrayList<java.lang.String[]> parameters) Re-query the dictionary using a single HTTP GET request.

Methods inherited from class org.licas_text.search.semantic.OnlineDictionary

convertCode, getReplyHash, isDefaultLanguage, requeryDictionary

Methods inherited from class java.lang.Object

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

Constructor Detail

WordNet

public WordNet()

Create a new instance of WordNet

Method Detail

checkLocalDictionary

public boolean checkLocalDictionary(java.lang.String localFolder)

Check if the local dictionary and file path is OK.

Parameters:

localFolder - the local dictionary folder.

Returns:

true if the dictionary can be loaded, false otherwise.

createLocalDictionary

public boolean createLocalDictionary(java.lang.String localFolder)

Create an instance of the local dictionary.

Parameters:

localFolder - the local WordNet 'dict' dictionary folder.

Returns:

true if the dictionary instance is created, false otherwise.

queryLocalDictionary

public java.util.HashMap<java.lang.String,?> queryLocalDictionary(java.util.ArrayList<java.lang.String[]> parameters)
                                                           throws java.lang.Exception

Query the dictionary using a single HTTP GET request.

Parameters:

parameters - the parameter list of type String[2] (name, value).

Returns:

key parts of the reply produced from executing the query.

Throws:

java.lang.Exception - any error.

queryDictionary

public java.util.HashMap<java.lang.String,?> queryDictionary(java.util.ArrayList<java.lang.String[]> parameters,
                                                             java.lang.String language)
                                                      throws java.lang.Exception

Query the dictionary using a single http GET request.

Specified by:

queryDictionary in class OnlineDictionary

Parameters:

parameters - the parameter list of type String[2] (name, value).

language - the code for the language the query should be in.

Returns:

key parts of the reply produced from executing the query.

Throws:

java.lang.Exception - any error.

queryDictionary

public java.util.HashMap<java.lang.String,?> queryDictionary(java.util.ArrayList<java.lang.String[]> parameters)
                                                      throws java.lang.Exception

Query the dictionary using a single http GET request.

Specified by:

queryDictionary in class OnlineDictionary

Parameters:

parameters - the parameter list of type String[2] (name, value).

Returns:

key parts of the reply produced from executing the query.

Throws:

java.lang.Exception - any error.

requeryDictionary

public java.util.HashMap<java.lang.String,?> requeryDictionary(java.lang.String whichMeaning,
                                                               java.util.ArrayList<java.lang.String[]> parameters)

Re-query the dictionary using a single HTTP GET request. This makes a second more detailed call when the first call is ambiguous.

Specified by:

requeryDictionary in class OnlineDictionary

Parameters:

whichMeaning - which meaning to query if alternatives are possible.

parameters - the parameter list of type String[2] (name, value).

Returns:

key parts of the reply produced from executing the query.

getSynsetsLocal

public edu.smu.tspell.wordnet.Synset[] getSynsetsLocal(java.lang.String theWord)
                                                throws java.lang.Exception

Get the set of synsets related to the word from a local dictionary.

Parameters:

theWord - the word term to check for.

Returns:

all synsets that contain the specified word form or a morphological variation of that word form.

Throws:

java.lang.Exception - any error.

getSynsetsLocal

public edu.smu.tspell.wordnet.Synset[] getSynsetsLocal(java.lang.String theWord,
                                                       edu.smu.tspell.wordnet.SynsetType type)
                                                throws java.lang.Exception

Get the set of synsets related to the word from a local dictionary.

Parameters:

theWord - the word term to check for.

type - the type of synsets (e.g., noun) to return. If this argument is null, all synsets will be returned that contain the specified word form.

Returns:

only the synsets of a particular type (e.g., noun) that contain a word form or morphological variation of that form.

Throws:

java.lang.Exception - any error.

getSynsetsLocal

public edu.smu.tspell.wordnet.Synset[] getSynsetsLocal(java.lang.String theWord,
                                                       edu.smu.tspell.wordnet.SynsetType type,
                                                       boolean useMorphology)
                                                throws java.lang.Exception

Get the set of synsets related to the word from a local dictionary.

Parameters:

theWord - the word term to check for.

type - the type of synsets (e.g., noun) to return. If this argument is null, all synsets will be returned that contain the specified word form.

useMorphology - when true, indicates that this method should return synsets that contain any morphological variation of the specified word form; conversely, a value of false returns in only synsets being returned that contain the word for exactly as it is specified. In other words, specifying false indicates that an exact-match-only approach should be used to determine which synsets to return.

Returns:

only the synsets of a particular type (e.g., noun) that contain a word form or morphological variation of that form.

Throws:

java.lang.Exception - any error.

close

public void close()

For garbage collection.

Specified by:

close in interface java.lang.AutoCloseable