net.sf.extjwnl.dictionary

Class Dictionary

java.lang.Object

net.sf.extjwnl.dictionary.Dictionary

Direct Known Subclasses:

AbstractCachingDictionary, MapDictionary

public abstract class Dictionary
extends java.lang.Object

Abstract representation of a WordNet dictionary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Dictionary.Version Represents a version of WordNet.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECK_LEX_IDS_KEY Parameter name: whether to check and fix lexicographer ids, default true.
static java.lang.String	DEFAULT_RESOURCE_CONFIG_PATH Default name of the configuration file for resource instance creation.
static java.lang.String	DICTIONARY_ELEMENT_FACTORY The class of DictionaryElementFactory to use.
static java.lang.String	EDIT_CHECK_ALIEN_POINTERS Parameter name: whether to check for alien pointers (pointing nowhere, or to another dictionary), default true.
static java.lang.String	EDIT_MANAGE_SYMMETRIC_POINTERS Parameter name: whether to add symmetric pointers automatically, default true.
protected DictionaryElementFactory	elementFactory
static java.lang.String	MORPHOLOGICAL_PROCESSOR Parameter name: class of the morphological processor to use.
protected java.util.Map<java.lang.String,Param>	params

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Dictionary(org.w3c.dom.Document doc)

Method Summary

Modifier and Type	Method and Description
void	addElement(DictionaryElement element) Adds dictionary element to the dictionary.
void	addException(Exc exc) Adds exception to the dictionary.
void	addIndexWord(IndexWord indexWord) Adds index word to the dictionary.
void	addSynset(Synset synset) Adds synset to the dictionary.
protected void	checkEditable() Checks whether dictionary is editable and throws if not;
abstract void	close() Shuts down the dictionary, freeing resources.
Exc	createException(POS pos, java.lang.String lemma, java.util.List<java.lang.String> exceptions) Creates an exception in the dictionary.
IndexWord	createIndexWord(POS pos, java.lang.String lemma, Synset synset) Creates index word.
Synset	createSynset(POS pos) Creates synset of the specified part of speech.
boolean	delete() Deletes dictionary files.
void	edit() Puts the dictionary into edit mode.
boolean	getCheckAlienPointers()
static Dictionary	getDatabaseBackedInstance(java.lang.String dbURL) Returns DatabaseBackedDictionary instance with default configuration.
static Dictionary	getDefaultResourceInstance() Returns Dictionary instance configured from classpath by default.
abstract Exc	getException(POS pos, java.lang.String derivation) Looks up derivation in the exceptions file of part-of-speech pos and return an Exc object containing the results.
abstract java.util.Iterator<Exc>	getExceptionIterator(POS pos) Returns an iterator over all the exceptions.
static Dictionary	getFileBackedInstance(java.lang.String dictionaryPath) Returns FileBackedDictionary instance with default configuration.
java.lang.String[]	getFrames(java.util.BitSet bits) Returns the frames at the indexes encoded in l.
static java.lang.String[]	getFrames(java.util.BitSet bits, java.lang.String[] verbFrames) Returns the frames at the indexes encoded in l.
abstract IndexWord	getIndexWord(POS pos, java.lang.String lemma) Looks up a word.
abstract java.util.Iterator<IndexWord>	getIndexWordIterator(POS pos) Returns an Iterator over all the IndexWords of part-of-speech pos.
abstract java.util.Iterator<IndexWord>	getIndexWordIterator(POS pos, java.lang.String substring) Returns an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.
static Dictionary	getInstance(org.xml.sax.InputSource properties) Parses properties and creates a dictionary.
static Dictionary	getInstance(java.io.InputStream properties) Parses a properties file and creates a dictionary.
boolean	getManageSymmetricPointers()
static Dictionary	getMapBackedInstance(java.lang.String dictionaryPath) Returns MapBackedDictionary instance with default configuration.
ResourceBundleSet	getMessages()
MorphologicalProcessor	getMorphologicalProcessor()
java.util.Random	getRandom()
abstract IndexWord	getRandomIndexWord(POS pos) Returns a random index word of a specified pos.
static Dictionary	getResourceInstance(java.lang.String propertiesPath) Returns Dictionary instance configured from classpath.
static Dictionary	getRestoreDictionary()
abstract Synset	getSynsetAt(POS pos, long offset) Returns the Synset at offset offset.
abstract java.util.Iterator<Synset>	getSynsetIterator(POS pos) Returns an iterator over all the synsets of part-of-speech pos.
static int[]	getVerbFrameIndices(java.util.BitSet bits) Returns the verb frame indices for a synset.
Dictionary.Version	getVersion() Returns the current dictionary version.
Word	getWordBySenseKey(java.lang.String senseKey) Returns a word by specified senseKey or null if not found.
boolean	isEditable() Returns whether the dictionary is editable.
IndexWordSet	lookupAllIndexWords(java.lang.String lemma) Returns a set of IndexWords, with each element in the set corresponding to a part-of-speech of word.
IndexWord	lookupIndexWord(POS pos, java.lang.String lemma) Looks up a word lemma.
protected static java.lang.String	prepareQueryString(java.lang.String lemma) Prepares the lemma for being used in a lookup operation.
void	removeElement(DictionaryElement element) Removes the dictionary element from the dictionary.
void	removeException(Exc exc) Removes the exc from the dictionary.
void	removeIndexWord(IndexWord indexWord) Removes indexWord from the dictionary.
void	removeSynset(Synset synset) Removes synset from the dictionary.
protected void	resolveAllPointers() Loads all targets in load all pointers and all synsets in all index words.
protected void	resolvePointers(POS pos)
void	save() Saves the dictionary.
void	setRandom(java.util.Random rand)
static void	setRestoreDictionary(Dictionary dictionary)

Methods inherited from class java.lang.Object

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

Field Detail

MORPHOLOGICAL_PROCESSOR

public static final java.lang.String MORPHOLOGICAL_PROCESSOR

Parameter name: class of the morphological processor to use.

See Also:

Constant Field Values

EDIT_MANAGE_SYMMETRIC_POINTERS

public static final java.lang.String EDIT_MANAGE_SYMMETRIC_POINTERS

Parameter name: whether to add symmetric pointers automatically, default true.

See Also:

Constant Field Values

EDIT_CHECK_ALIEN_POINTERS

public static final java.lang.String EDIT_CHECK_ALIEN_POINTERS

Parameter name: whether to check for alien pointers (pointing nowhere, or to another dictionary), default true.

See Also:

Constant Field Values

CHECK_LEX_IDS_KEY

public static final java.lang.String CHECK_LEX_IDS_KEY

Parameter name: whether to check and fix lexicographer ids, default true.

See Also:

Constant Field Values

params

protected final java.util.Map<java.lang.String,Param> params

DEFAULT_RESOURCE_CONFIG_PATH

public static final java.lang.String DEFAULT_RESOURCE_CONFIG_PATH

Default name of the configuration file for resource instance creation.

See Also:

Constant Field Values

DICTIONARY_ELEMENT_FACTORY

public static final java.lang.String DICTIONARY_ELEMENT_FACTORY

The class of DictionaryElementFactory to use.

See Also:

Constant Field Values

elementFactory

protected final DictionaryElementFactory elementFactory

Constructor Detail

Dictionary

protected Dictionary(org.w3c.dom.Document doc)
              throws JWNLException

Throws:

JWNLException

Method Detail

getInstance

public static Dictionary getInstance(java.io.InputStream properties)
                              throws JWNLException

Parses a properties file and creates a dictionary.

Parameters:

properties - the properties file stream

Returns:

dictionary

Throws:

JWNLException - various JWNL exceptions, depending on where this fails

getInstance

public static Dictionary getInstance(org.xml.sax.InputSource properties)
                              throws JWNLException

Parses properties and creates a dictionary.

Parameters:

properties - input source with properties

Returns:

dictionary

Throws:

JWNLException - various JWNL exceptions, depending on where this fails

getFileBackedInstance

public static Dictionary getFileBackedInstance(java.lang.String dictionaryPath)
                                        throws JWNLException

Returns FileBackedDictionary instance with default configuration.

Parameters:

dictionaryPath - dictionary path

Returns:

FileBackedDictionary instance with default configuration

Throws:

JWNLException - JWNLException

getMapBackedInstance

public static Dictionary getMapBackedInstance(java.lang.String dictionaryPath)
                                       throws JWNLException

Returns MapBackedDictionary instance with default configuration.

Parameters:

dictionaryPath - dictionary path

Returns:

MapBackedDictionary instance with default configuration

Throws:

JWNLException - JWNLException

getDatabaseBackedInstance

public static Dictionary getDatabaseBackedInstance(java.lang.String dbURL)
                                            throws JWNLException

Returns DatabaseBackedDictionary instance with default configuration.

Parameters:

dbURL - database url

Returns:

DatabaseBackedDictionary instance with default configuration

Throws:

JWNLException - JWNLException

getDefaultResourceInstance

public static Dictionary getDefaultResourceInstance()
                                             throws JWNLException

Returns Dictionary instance configured from classpath by default.

Returns:

Dictionary instance configured from classpath by default

Throws:

JWNLException - JWNLException

getResourceInstance

public static Dictionary getResourceInstance(java.lang.String propertiesPath)
                                      throws JWNLException

Returns Dictionary instance configured from classpath.

Parameters:

propertiesPath - path to properties, for example "/net/sf/extjwnl/data/wordnet/wn31/res_properties.xml"

Returns:

Dictionary instance configured from classpath

Throws:

JWNLException - JWNLException

setRestoreDictionary

public static void setRestoreDictionary(Dictionary dictionary)

getRestoreDictionary

public static Dictionary getRestoreDictionary()

getIndexWordIterator

public abstract java.util.Iterator<IndexWord> getIndexWordIterator(POS pos)
                                                            throws JWNLException

Returns an Iterator over all the IndexWords of part-of-speech pos.

Parameters:

pos - The part-of-speech

Returns:

iterator over IndexWords

Throws:

JWNLException - JWNLException

getIndexWordIterator

public abstract java.util.Iterator<IndexWord> getIndexWordIterator(POS pos,
                                                                   java.lang.String substring)
                                                            throws JWNLException

Returns an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.

Parameters:

pos - The part-of-speech.

substring - substring

Returns:

An iterator over IndexWords.

Throws:

JWNLException - JWNLException

getIndexWord

public abstract IndexWord getIndexWord(POS pos,
                                       java.lang.String lemma)
                                throws JWNLException

Looks up a word. The search is case-independent, and phrases are separated by spaces ("look up", not "look_up"). Note: this method does not subject lemma to any morphological processing. If you want this, use lookupIndexWord(POS, String).

Parameters:

pos - The part-of-speech

lemma - The orthographic representation of the word

Returns:

An IndexWord representing the word, or null if no such entry exists

Throws:

JWNLException - JWNLException

getRandomIndexWord

public abstract IndexWord getRandomIndexWord(POS pos)
                                      throws JWNLException

Returns a random index word of a specified pos.

Parameters:

pos - part of speech

Returns:

a random index word of a specified pos

Throws:

JWNLException - JWNLException

getSynsetIterator

public abstract java.util.Iterator<Synset> getSynsetIterator(POS pos)
                                                      throws JWNLException

Returns an iterator over all the synsets of part-of-speech pos.

Parameters:

pos - The part-of-speech.

Returns:

An iterator over Synsets.

Throws:

JWNLException - JWNLException

getSynsetAt

public abstract Synset getSynsetAt(POS pos,
                                   long offset)
                            throws JWNLException

Returns the Synset at offset offset.

Parameters:

pos - The part-of-speech file to look in

offset - The offset of the synset in the file

Returns:

A synset containing the parsed line from the database

Throws:

JWNLException - JWNLException

getExceptionIterator

public abstract java.util.Iterator<Exc> getExceptionIterator(POS pos)
                                                      throws JWNLException

Returns an iterator over all the exceptions.

Parameters:

pos - the part-of-speech

Returns:

an iterator over Excs

Throws:

JWNLException - JWNLException

getException

public abstract Exc getException(POS pos,
                                 java.lang.String derivation)
                          throws JWNLException

Looks up derivation in the exceptions file of part-of-speech pos and return an Exc object containing the results.

Parameters:

pos - the exception file to look in

derivation - the word to look up

Returns:

the Exc object

Throws:

JWNLException - JWNLException

close

public abstract void close()
                    throws JWNLException

Shuts down the dictionary, freeing resources.

Throws:

JWNLException - JWNLException

getMessages

public ResourceBundleSet getMessages()

getMorphologicalProcessor

public MorphologicalProcessor getMorphologicalProcessor()

getWordBySenseKey

public Word getWordBySenseKey(java.lang.String senseKey)
                       throws JWNLException

Returns a word by specified senseKey or null if not found.

Parameters:

senseKey - sense key

Returns:

a word by specified senseKey or null if not found

Throws:

JWNLException - JWNLException

lookupIndexWord

public IndexWord lookupIndexWord(POS pos,
                                 java.lang.String lemma)
                          throws JWNLException

Looks up a word lemma. First tries a normal lookup. If that doesn't work, tries looking up the stemmed form of the lemma.

Parameters:

pos - the part-of-speech of the word to look up

lemma - the lemma to look up

Returns:

the IndexWord found by the lookup procedure, or null

Throws:

JWNLException - JWNLException

lookupAllIndexWords

public IndexWordSet lookupAllIndexWords(java.lang.String lemma)
                                 throws JWNLException

Returns a set of IndexWords, with each element in the set corresponding to a part-of-speech of word.

Parameters:

lemma - the word for which to lookup senses

Returns:

An array of IndexWords, each of which is a sense of word

Throws:

JWNLException - JWNLException

getVersion

public Dictionary.Version getVersion()

Returns the current dictionary version.

Returns:

current dictionary version

isEditable

public boolean isEditable()

Returns whether the dictionary is editable.

Returns:

whether the dictionary is editable

edit

public void edit()
          throws JWNLException

Puts the dictionary into edit mode.

Throws:

JWNLException - JWNLException

save

public void save()
          throws JWNLException

Saves the dictionary.

Throws:

JWNLException - JWNLException

delete

public boolean delete()
               throws JWNLException

Deletes dictionary files.

Returns:

true if deleted

Throws:

JWNLException - JWNLException

addElement

public void addElement(DictionaryElement element)
                throws JWNLException

Adds dictionary element to the dictionary.

Parameters:

element - element to add

Throws:

JWNLException - JWNLException

removeElement

public void removeElement(DictionaryElement element)
                   throws JWNLException

Removes the dictionary element from the dictionary.

Parameters:

element - element to be removed

Throws:

JWNLException - JWNLException

createException

public Exc createException(POS pos,
                           java.lang.String lemma,
                           java.util.List<java.lang.String> exceptions)
                    throws JWNLException

Creates an exception in the dictionary.

Parameters:

pos - exception part of speech

lemma - exception lemma

exceptions - list of base forms

Returns:

exception object

Throws:

JWNLException - JWNLException

addException

public void addException(Exc exc)
                  throws JWNLException

Adds exception to the dictionary.

Parameters:

exc - exception to add

Throws:

JWNLException - JWNLException

removeException

public void removeException(Exc exc)
                     throws JWNLException

Removes the exc from the dictionary.

Parameters:

exc - exc to be removed

Throws:

JWNLException - JWNLException

createSynset

public Synset createSynset(POS pos)
                    throws JWNLException

Creates synset of the specified part of speech.

Parameters:

pos - part of speech

Returns:

synset object

Throws:

JWNLException - JWNLException

addSynset

public void addSynset(Synset synset)
               throws JWNLException

Adds synset to the dictionary.

Parameters:

synset - synset to add

Throws:

JWNLException - JWNLException

removeSynset

public void removeSynset(Synset synset)
                  throws JWNLException

Removes synset from the dictionary.

Parameters:

synset - synset to remove

Throws:

JWNLException - JWNLException

createIndexWord

public IndexWord createIndexWord(POS pos,
                                 java.lang.String lemma,
                                 Synset synset)
                          throws JWNLException

Creates index word.

Parameters:

pos - part of speech

lemma - lemma

synset - synset

Returns:

index word object

Throws:

JWNLException - JWNLException

addIndexWord

public void addIndexWord(IndexWord indexWord)
                  throws JWNLException

Adds index word to the dictionary.

Parameters:

indexWord - index word to add

Throws:

JWNLException - JWNLException

removeIndexWord

public void removeIndexWord(IndexWord indexWord)
                     throws JWNLException

Removes indexWord from the dictionary.

Parameters:

indexWord - index word to remove

Throws:

JWNLException - JWNLException

getManageSymmetricPointers

public boolean getManageSymmetricPointers()

getCheckAlienPointers

public boolean getCheckAlienPointers()

getFrames

public java.lang.String[] getFrames(java.util.BitSet bits)

Returns the frames at the indexes encoded in l. Verb Frames are encoded within Words as a long. Each bit represents the frame at its corresponding index. If the bit is set, that verb frame is valid for the word.

Parameters:

bits - frame flags

Returns:

the frames at the indexes encoded in l

getFrames

public static java.lang.String[] getFrames(java.util.BitSet bits,
                                           java.lang.String[] verbFrames)

Returns the frames at the indexes encoded in l. Verb Frames are encoded within Words as a long. Each bit represents the frame at its corresponding index. If the bit is set, that verb frame is valid for the word.

Parameters:

bits - frame flags

verbFrames - frames

Returns:

the frames at the indexes encoded in l

getVerbFrameIndices

public static int[] getVerbFrameIndices(java.util.BitSet bits)

Returns the verb frame indices for a synset. This is the collection of f_num values for a synset definition. In the case of a synset, this is only the values that are true for all words with the synset. In other words, only the sentence frames that belong to all words.

Parameters:

bits - the bit set

Returns:

an integer collection

getRandom

public java.util.Random getRandom()

setRandom

public void setRandom(java.util.Random rand)

prepareQueryString

protected static java.lang.String prepareQueryString(java.lang.String lemma)

Prepares the lemma for being used in a lookup operation. Specifically, this method trims whitespace and converts the lemma to lower case.

Parameters:

lemma - the lemma to be prepared

Returns:

String the prepared lemma

checkEditable

protected void checkEditable()
                      throws JWNLException

Checks whether dictionary is editable and throws if not;

Throws:

JWNLException - JWNLException

resolveAllPointers

protected void resolveAllPointers()
                           throws JWNLException

Loads all targets in load all pointers and all synsets in all index words.

Throws:

JWNLException - JWNLException

resolvePointers

protected void resolvePointers(POS pos)
                        throws JWNLException

Throws:

JWNLException