net.didion.jwnl.dictionary
Class DatabaseBackedDictionary

java.lang.Object
  net.didion.jwnl.dictionary.Dictionary
      net.didion.jwnl.dictionary.AbstractCachingDictionary
          net.didion.jwnl.dictionary.DatabaseBackedDictionary

All Implemented Interfaces:

Installable

public class DatabaseBackedDictionary

extends AbstractCachingDictionary

Field Summary

static java.lang.String	DATABASE_MANAGER
static java.lang.String	DICTIONARY_ELEMENT_FACTORY
static java.lang.String	MORPH MorphologicalProcessor class install parameter.

Constructor Summary

DatabaseBackedDictionary()

Method Summary

void	close() Shut down the dictionary
Exc	getException(POS pos, java.lang.String derivation) Lookup derivation in the exceptions file of part-of-speech pos and return an Exc object containing the results.
java.util.Iterator	getExceptionIterator(POS pos) Return an Iterator over all the Exceptions in the database.
IndexWord	getIndexWord(POS pos, java.lang.String lemma) Look up a word in the database.
java.util.Iterator	getIndexWordIterator(POS pos) Return an Iterator over all the IndexWords of part-of-speech pos in the database.
java.util.Iterator	getIndexWordIterator(POS pos, java.lang.String substring) Return an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.
IndexWord	getRandomIndexWord(POS pos)
Synset	getSynsetAt(POS pos, long offset) Return the Synset at offset offset from the database.
java.util.Iterator	getSynsetIterator(POS pos) Return an Iterator over all the Synsets of part-of-speech pos in the database.
void	install(java.util.Map params)

Methods inherited from class net.didion.jwnl.dictionary.AbstractCachingDictionary

cacheException, cacheIndexWord, cacheSynset, clearCache, clearCache, getCacheCapacity, getCachedException, getCachedIndexWord, getCachedSynset, getCacheSizes, isCachingEnabled, setCacheCapacity, setCacheCapacity, setCachingEnabled

Methods inherited from class net.didion.jwnl.dictionary.Dictionary

getInstance, getMorphologicalProcessor, lookupAllIndexWords, lookupIndexWord, prepareQueryString, setDictionary, uninstall

Methods inherited from class java.lang.Object

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

Field Detail

MORPH

public static final java.lang.String MORPH

MorphologicalProcessor class install parameter. The value should be the class of MorphologicalProcessor to use.

See Also:

Constant Field Values

DICTIONARY_ELEMENT_FACTORY

public static final java.lang.String DICTIONARY_ELEMENT_FACTORY

See Also:

Constant Field Values

DATABASE_MANAGER

public static final java.lang.String DATABASE_MANAGER

See Also:

Constant Field Values

Constructor Detail

DatabaseBackedDictionary

public DatabaseBackedDictionary()

Method Detail

install

public void install(java.util.Map params)
             throws JWNLException

Throws:

JWNLException

getIndexWord

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

Description copied from class: Dictionary

Look up a word in the database. 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 Dictionary.lookupIndexWord(POS, String).

Specified by:

getIndexWord in class Dictionary

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

getIndexWordIterator

public java.util.Iterator getIndexWordIterator(POS pos)
                                        throws JWNLException

Description copied from class: Dictionary

Return an Iterator over all the IndexWords of part-of-speech pos in the database.

Specified by:

getIndexWordIterator in class Dictionary

Parameters:

pos - The part-of-speech

Returns:

An iterator over IndexWords

Throws:

JWNLException

getIndexWordIterator

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

Description copied from class: Dictionary

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

Specified by:

getIndexWordIterator in class Dictionary

Parameters:

pos - The part-of-speech.

Returns:

An iterator over IndexWords.

Throws:

JWNLException

getRandomIndexWord

public IndexWord getRandomIndexWord(POS pos)
                             throws JWNLException

Specified by:

getRandomIndexWord in class Dictionary

Throws:

JWNLException

getSynsetAt

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

Description copied from class: Dictionary

Return the Synset at offset offset from the database.

Specified by:

getSynsetAt in class Dictionary

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

getSynsetIterator

public java.util.Iterator getSynsetIterator(POS pos)
                                     throws JWNLException

Description copied from class: Dictionary

Return an Iterator over all the Synsets of part-of-speech pos in the database.

Specified by:

getSynsetIterator in class Dictionary

Parameters:

pos - The part-of-speech.

Returns:

An iterator over Synsets.

Throws:

JWNLException

getException

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

Description copied from class: Dictionary

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

Specified by:

getException in class Dictionary

Parameters:

pos - the exception file to look in

derivation - the word to look up

Returns:

Exc the Exc object

Throws:

JWNLException

getExceptionIterator

public java.util.Iterator getExceptionIterator(POS pos)
                                        throws JWNLException

Description copied from class: Dictionary

Return an Iterator over all the Exceptions in the database.

Specified by:

getExceptionIterator in class Dictionary

Parameters:

pos - the part-of-speech

Returns:

Iterator An iterator over Strings

Throws:

JWNLException

close

public void close()

Description copied from class: Dictionary

Shut down the dictionary

Specified by:

close in class Dictionary