net.sf.extjwnl.dictionary

Class FileBackedDictionary

java.lang.Object

net.sf.extjwnl.dictionary.Dictionary

net.sf.extjwnl.dictionary.AbstractCachingDictionary

net.sf.extjwnl.dictionary.FileBackedDictionary

public class FileBackedDictionary
extends AbstractCachingDictionary

A Dictionary that retrieves objects from the text files in the WordNet distribution directory.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.extjwnl.dictionary.AbstractCachingDictionary

AbstractCachingDictionary.IndexWordIterator

Nested classes/interfaces inherited from class net.sf.extjwnl.dictionary.Dictionary

Dictionary.Version

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CACHE_SIZE The default cache size.
static java.lang.String	ENABLE_CACHING The value should be "true" or "false".
static java.lang.String	EXCEPTION_WORD_CACHE_SIZE Size of the exception cache.
static java.lang.String	FILE_MANAGER File manager install parameter.
static java.lang.String	INDEX_WORD_CACHE_SIZE Size of the index word cache.
static java.lang.String	SYNSET_WORD_CACHE_SIZE Size of the synset cache.

Fields inherited from class net.sf.extjwnl.dictionary.AbstractCachingDictionary

isCachingEnabled

Fields inherited from class net.sf.extjwnl.dictionary.Dictionary

CHECK_LEX_IDS_KEY, DEFAULT_RESOURCE_CONFIG_PATH, DICTIONARY_ELEMENT_FACTORY, EDIT_CHECK_ALIEN_POINTERS, EDIT_MANAGE_SYMMETRIC_POINTERS, elementFactory, MORPHOLOGICAL_PROCESSOR, params

Constructor Summary

Constructors

Constructor and Description
FileBackedDictionary(org.w3c.dom.Document doc)

Method Summary

Modifier and Type	Method and Description
void	cacheAll()
void	close() Shuts down the dictionary, freeing resources.
boolean	delete() Deletes dictionary files.
void	edit() Puts the dictionary into edit mode.
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.
java.util.Iterator<Exc>	getExceptionIterator(POS pos) Returns an iterator over all the exceptions.
IndexWord	getIndexWord(POS pos, java.lang.String lemma) Looks up a word.
java.util.Iterator<IndexWord>	getIndexWordIterator(POS pos) Returns an Iterator over all the IndexWords of part-of-speech pos.
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.
IndexWord	getRandomIndexWord(POS pos) Returns a random index word of a specified pos.
Synset	getSynsetAt(POS pos, long offset) Returns the Synset at offset offset.
java.util.Iterator<Synset>	getSynsetIterator(POS pos) Returns an iterator over all the synsets of part-of-speech pos.
void	save() Saves the dictionary.

Methods inherited from class net.sf.extjwnl.dictionary.AbstractCachingDictionary

addException, addIndexWord, addSynset, cacheException, cacheIndexWord, cachePOS, cacheSynset, clearCache, clearCache, clearException, clearIndexWord, clearSynset, getCacheCapacity, getCachedException, getCachedIndexWord, getCachedSynset, getCacheSizes, isCachingEnabled, removeException, removeIndexWord, removeSynset, setCacheCapacity, setCacheCapacity, setCachingEnabled

Methods inherited from class net.sf.extjwnl.dictionary.Dictionary

addElement, checkEditable, createException, createIndexWord, createSynset, getCheckAlienPointers, getDatabaseBackedInstance, getDefaultResourceInstance, getFileBackedInstance, getFrames, getFrames, getInstance, getInstance, getManageSymmetricPointers, getMapBackedInstance, getMessages, getMorphologicalProcessor, getRandom, getResourceInstance, getRestoreDictionary, getVerbFrameIndices, getVersion, getWordBySenseKey, isEditable, lookupAllIndexWords, lookupIndexWord, prepareQueryString, removeElement, resolveAllPointers, resolvePointers, setRandom, setRestoreDictionary

Methods inherited from class java.lang.Object

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

Field Detail

FILE_MANAGER

public static final java.lang.String FILE_MANAGER

File manager install parameter. The value should be the class of FileManager to use.

See Also:

Constant Field Values

ENABLE_CACHING

public static final java.lang.String ENABLE_CACHING

The value should be "true" or "false". The default is "true".

See Also:

Constant Field Values

CACHE_SIZE

public static final java.lang.String CACHE_SIZE

The default cache size.

See Also:

Constant Field Values

INDEX_WORD_CACHE_SIZE

public static final java.lang.String INDEX_WORD_CACHE_SIZE

Size of the index word cache. Overrides the default cache size

See Also:

Constant Field Values

SYNSET_WORD_CACHE_SIZE

public static final java.lang.String SYNSET_WORD_CACHE_SIZE

Size of the synset cache. Overrides the default cache size

See Also:

Constant Field Values

EXCEPTION_WORD_CACHE_SIZE

public static final java.lang.String EXCEPTION_WORD_CACHE_SIZE

Size of the exception cache. Overrides the default cache size

See Also:

Constant Field Values

Constructor Detail

FileBackedDictionary

public FileBackedDictionary(org.w3c.dom.Document doc)
                     throws JWNLException

Throws:

JWNLException

Method Detail

close

public void close()
           throws JWNLException

Description copied from class: Dictionary

Shuts down the dictionary, freeing resources.

Specified by:

close in class Dictionary

Throws:

JWNLException - JWNLException

delete

public boolean delete()
               throws JWNLException

Description copied from class: Dictionary

Deletes dictionary files.

Overrides:

delete in class Dictionary

Returns:

true if deleted

Throws:

JWNLException - JWNLException

getIndexWordIterator

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

Description copied from class: Dictionary

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

Overrides:

getIndexWordIterator in class AbstractCachingDictionary

Parameters:

pos - The part-of-speech

Returns:

iterator over IndexWords

Throws:

JWNLException - JWNLException

getIndexWordIterator

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

Description copied from class: Dictionary

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

Overrides:

getIndexWordIterator in class AbstractCachingDictionary

Parameters:

pos - The part-of-speech.

substring - substring

Returns:

An iterator over IndexWords.

Throws:

JWNLException - JWNLException

getIndexWord

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

Description copied from class: Dictionary

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 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 - JWNLException

getRandomIndexWord

public IndexWord getRandomIndexWord(POS pos)
                             throws JWNLException

Description copied from class: Dictionary

Returns a random index word of a specified pos.

Specified by:

getRandomIndexWord in class Dictionary

Parameters:

pos - part of speech

Returns:

a random index word of a specified pos

Throws:

JWNLException - JWNLException

getSynsetIterator

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

Description copied from class: Dictionary

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

Overrides:

getSynsetIterator in class AbstractCachingDictionary

Parameters:

pos - The part-of-speech.

Returns:

An iterator over Synsets.

Throws:

JWNLException - JWNLException

getSynsetAt

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

Description copied from class: Dictionary

Returns the Synset at offset offset.

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 - JWNLException

getExceptionIterator

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

Description copied from class: Dictionary

Returns an iterator over all the exceptions.

Overrides:

getExceptionIterator in class AbstractCachingDictionary

Parameters:

pos - the part-of-speech

Returns:

an iterator over Excs

Throws:

JWNLException - JWNLException

getException

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

Description copied from class: Dictionary

Looks up 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:

the Exc object

Throws:

JWNLException - JWNLException

edit

public void edit()
          throws JWNLException

Description copied from class: Dictionary

Puts the dictionary into edit mode.

Overrides:

edit in class AbstractCachingDictionary

Throws:

JWNLException - JWNLException

save

public void save()
          throws JWNLException

Description copied from class: Dictionary

Saves the dictionary.

Overrides:

save in class Dictionary

Throws:

JWNLException - JWNLException

cacheAll

public void cacheAll()
              throws JWNLException

Overrides:

cacheAll in class AbstractCachingDictionary

Throws:

JWNLException