charger.gloss.wn

Class WordnetManager

Object

charger.gloss.wn.WordnetManager

public class WordnetManager
extends Object

Takes care of WordNet access when it is needed.

Field Summary

Fields

Modifier and Type	Field and Description
private static boolean	_JWNLinitialized
private static double	activeVersion
static net.didion.jwnl.dictionary.Dictionary	dict
static String	file_properties_xml
private static boolean	initializationFailed
static String	wordnetDictionaryFilename

Constructor Summary

Constructors

Modifier	Constructor and Description
private	WordnetManager()

Method Summary

Modifier and Type	Method and Description
boolean	attachDescriptor(AbstractTypeDescriptor[] ds, GNode gn) Associates a set of descriptors with a particular object.
boolean	attachDescriptor(AbstractTypeDescriptor descr, GNode gn) Associates a descriptor with a particular object.
GenericTypeDescriptor	chooseGenericSense(String word, String phrase, AbstractTypeDescriptor initialOption)
static net.didion.jwnl.data.Synset[]	collectAllSenses(String word) Returns all senses, regardless of their part of speech.
boolean	forgetDescriptors(GNode gn) Sets the descriptor to null for this GNode.
static double	getActiveVersion() Identify the Wordnet version for the dictionary that is currently being used.
static WordnetManager	getInstance() Create a new instance of a wordnet manager.
static net.didion.jwnl.data.POS	getPOSForLabel(String label) Return the POS constant (e.g., POS.NOUN, etc) corresponding to the label.
static net.didion.jwnl.data.Synset	getSynset(net.didion.jwnl.data.POS pos, long offset) A wrapper for Dictionary.getSynsetAt.
String	getTrimmedGloss(net.didion.jwnl.data.Synset s, int length, boolean includePOS, boolean includeExamples) ` Removes trailing example sentences from a gloss entry and adds a part-of-speech label to the front.
private static void	initializeWordnet()
static boolean	isWordnetAvailable() Tests whether the wordnet system is available.
AbstractTypeDescriptor	queryForSense(String word, AbstractTypeDescriptor initialOption, boolean tryGeneric) Invokes queryForSense on a word, with no phrase.
AbstractTypeDescriptor	queryForSense(String word, boolean tryGeneric) Invokes queryForSense on a word, with no phrase and no default.
AbstractTypeDescriptor	queryForSense(String word, String phrase, AbstractTypeDescriptor initialOption, boolean tryGeneric) Interactively query a user to choose a synset for a given word.
AbstractTypeDescriptor	queryForSense(String word, String phrase, boolean tryGeneric) Invokes queryForSense on a word in a phrase.
boolean	wordExists(String word) Determines whether the word is in any ontology at all.

Methods inherited from class Object

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

Field Detail

_JWNLinitialized

private static boolean _JWNLinitialized

wordnetDictionaryFilename

public static String wordnetDictionaryFilename

dict

public static net.didion.jwnl.dictionary.Dictionary dict

initializationFailed

private static boolean initializationFailed

activeVersion

private static double activeVersion

file_properties_xml

public static String file_properties_xml

Constructor Detail

WordnetManager

private WordnetManager()

Method Detail

isWordnetAvailable

public static boolean isWordnetAvailable()

Tests whether the wordnet system is available. If wordnet isn't available, then many features will be of limited use, but they should use this test so that they needn't crash.

Returns:

true if Wordnet is initialized and available; false otherwise. Wordnet is only initialized once per session, so if its availability changes during a session, nothing will change. If Wordnet becomes unavailable during a session where it was previously available, unpredictable (but probably bad) things will happen.

getActiveVersion

public static double getActiveVersion()

Identify the Wordnet version for the dictionary that is currently being used.

Returns:

a Wordnet version (e.g., 1.7 or 2.0); if zero, then no dictionary has yet been initialized.

getInstance

public static WordnetManager getInstance()

Create a new instance of a wordnet manager. If WordNet has not already been made accessible, then initialize WordNet for access.

Parameters:

t - A transcript to be used for any interactive knowledge acquisition.

Returns:

a wordnet manager suitable for framing.

initializeWordnet

private static void initializeWordnet()

collectAllSenses

public static net.didion.jwnl.data.Synset[] collectAllSenses(String word)

Returns all senses, regardless of their part of speech.

Parameters:

word - The word taken directly from some text

Returns:

the list of all synsets for that word.

queryForSense

public AbstractTypeDescriptor queryForSense(String word,
                                            String phrase,
                                            AbstractTypeDescriptor initialOption,
                                            boolean tryGeneric)

Interactively query a user to choose a synset for a given word. Wordnet is the first one tried, so it gets priority if it contains a sense for the word. If Wordnet knows nothing about the word, but the word contains underscores in it, or has an alternation of upper and lower case, then CRAFT will try to guess the constituent words.

Parameters:

word - The word for whom a synset is to be chosen

phrase - A phrase in which the word appears, to aid the user

initialOption - the initial synset to select

tryGeneric - whether to query a generic "free-form" sense from the user if Wordnet fails.

Returns:

the descriptor corresponding to the definition chosen by the user; null if the user cancelled, or if the word wasn't found.

See Also:

chooseGenericSense(java.lang.String, java.lang.String, charger.gloss.AbstractTypeDescriptor), WNUtil.guessWordsFromPhrase(java.lang.String)

queryForSense

public AbstractTypeDescriptor queryForSense(String word,
                                            String phrase,
                                            boolean tryGeneric)

Invokes queryForSense on a word in a phrase. Assumes a null WordnetTypeDescriptor for its default. Note that wordnet descriptor is the default type here, so that it will always look for a wordnet descriptor first.

See Also:

queryForSense(java.lang.String, java.lang.String, charger.gloss.AbstractTypeDescriptor, boolean)

queryForSense

public AbstractTypeDescriptor queryForSense(String word,
                                            AbstractTypeDescriptor initialOption,
                                            boolean tryGeneric)

Invokes queryForSense on a word, with no phrase.

queryForSense

public AbstractTypeDescriptor queryForSense(String word,
                                            boolean tryGeneric)

Invokes queryForSense on a word, with no phrase and no default.

getTrimmedGloss

public String getTrimmedGloss(net.didion.jwnl.data.Synset s,
                              int length,
                              boolean includePOS,
                              boolean includeExamples)

` Removes trailing example sentences from a gloss entry and adds a part-of-speech label to the front. This makes selections shorter and somewhat easier.

Parameters:

s - Wordnet gloss entry

length - the maximum length of the resulting string; if 0 (zero) then don't truncate

includePOS - whether to include a string denoting the part of speech

includeExamples - whether to include explanatory or examples that usually appear at the end of a glossary entry

Returns:

a possibly shorter entry

wordExists

public boolean wordExists(String word)

Determines whether the word is in any ontology at all.

Parameters:

word - case insensitive

Returns:

whether the word is in any ontology, no further indication.

getSynset

public static net.didion.jwnl.data.Synset getSynset(net.didion.jwnl.data.POS pos,
                                                    long offset)

A wrapper for Dictionary.getSynsetAt. First makes sure that wordnet has been initialized and catches exceptions.

attachDescriptor

public boolean attachDescriptor(AbstractTypeDescriptor descr,
                                GNode gn)

Associates a descriptor with a particular object. If the object is a concept/relation/actor/graph, the intention is for that descriptor to be associated with the object's type. If the object is a type/relation label, then the intention is that the descriptor is associated with the type itself. QUESTION: how should type and relation labels be handled? When I use an instance of a type, should I automatically associate all instances with the type's associated synset?

Parameters:

descr - the descriptor to associate. If s is null, there is no effect; use forgetDescriptor.

gn - the non-null GNode to be associated.

Returns:

true if a new non-null descriptor was successfully associated with the GNode; false otherwise.

See Also:

forgetDescriptors(charger.obj.GNode)

attachDescriptor

public boolean attachDescriptor(AbstractTypeDescriptor[] ds,
                                GNode gn)

Associates a set of descriptors with a particular object. If the object is a concept/relation/actor/graph, the intention is for that descriptor to be associated with the object's type. If the object is a type/relation label, then the intention is that the descriptor is associated with the type itself. QUESTION: how should type and relation labels be handled? When I use an instance of a type, should I automatically associate all instances with the type's associated synset?

Parameters:

ds - the descriptors to associate. If s is null or zero-length, there is no effect; use forgetDescriptor.

gn - the non-null GNode to be associated.

Returns:

true if one or more new non-null descriptors were successfully associated with the GNode; false otherwise.

See Also:

forgetDescriptors(charger.obj.GNode)

forgetDescriptors

public boolean forgetDescriptors(GNode gn)

Sets the descriptor to null for this GNode.

Parameters:

gn - The GNode whose descriptor is to be erased

Returns:

true if the descriptor wasn't null to begin with (i.e., the node changed); false otherwise.

See Also:

attachDescriptor(charger.gloss.AbstractTypeDescriptor, charger.obj.GNode)

getPOSForLabel

public static net.didion.jwnl.data.POS getPOSForLabel(String label)

Return the POS constant (e.g., POS.NOUN, etc) corresponding to the label.

Parameters:

label - a label such as one returned by a call to POS.getLabel()

chooseGenericSense

public GenericTypeDescriptor chooseGenericSense(String word,
                                                String phrase,
                                                AbstractTypeDescriptor initialOption)