Package net.didion.jwnl.dictionary
Class FileBackedDictionary
- java.lang.Object
-
- net.didion.jwnl.dictionary.Dictionary
-
- net.didion.jwnl.dictionary.AbstractCachingDictionary
-
- net.didion.jwnl.dictionary.FileBackedDictionary
-
- All Implemented Interfaces:
Installable
public class FileBackedDictionary extends AbstractCachingDictionary
ADictionary
that retrieves objects from the text files in the WordNet distribution directory.
-
-
Field Summary
Fields Modifier and Type Field Description static String
CACHE_SIZE
The default cache size.static String
DICTIONARY_ELEMENT_FACTORY
The class of FileDictionaryElementFactory to use.static String
ENABLE_CACHING
The value should be "true" or "false".static String
EXCEPTION_WORD_CACHE_SIZE
Size of the exception cache.static String
FILE_MANAGER
File manager install parameter.static String
INDEX_WORD_CACHE_SIZE
Size of the index word cache.static String
MORPH
Morphological processor class install parameter.static String
SYNSET_WORD_CACHE_SIZE
Size of the synset cache.
-
Constructor Summary
Constructors Constructor Description FileBackedDictionary()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Shut down the dictionaryFileDictionaryElementFactory
getDictionaryElementFactory()
Exc
getException(POS pos, String derivation)
Lookupderivation
in the exceptions file of part-of-speechpos
and return an Exc object containing the results.Iterator
getExceptionIterator(POS pos)
Return an Iterator over all the Exceptions in the database.protected FileManager
getFileManager()
Get the file manager that backs this database.IndexWord
getIndexWord(POS pos, String lemma)
Look up a word in the database.Iterator
getIndexWordIterator(POS pos)
Return an Iterator over all the IndexWords of part-of-speech pos in the database.Iterator
getIndexWordIterator(POS pos, 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 theSynset
at offsetoffset
from the database.Iterator
getSynsetIterator(POS pos)
Return an Iterator over all the Synsets of part-of-speech pos in the database.void
install(Map params)
Install a FileBackedDictionary from a map of parameters.static void
install(FileManager fileManager, FileDictionaryElementFactory factory)
Construct a Dictionary that retrieves file data fromfileManager
.static void
install(FileManager fileManager, FileDictionaryElementFactory factory, boolean enableCaching)
static void
install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory)
Construct a Dictionary that retrieves file data fromfileManager
.static void
install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory, boolean enableCaching)
-
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
-
-
-
-
Field Detail
-
MORPH
public static final String MORPH
Morphological processor class install parameter. The value should be the class of MorphologicalProcessor to use.- See Also:
- Constant Field Values
-
FILE_MANAGER
public static final String FILE_MANAGER
File manager install parameter. The value should be the class of FileManager to use.- See Also:
- Constant Field Values
-
DICTIONARY_ELEMENT_FACTORY
public static final String DICTIONARY_ELEMENT_FACTORY
The class of FileDictionaryElementFactory to use.- See Also:
- Constant Field Values
-
ENABLE_CACHING
public static final String ENABLE_CACHING
The value should be "true" or "false". The default is "true".- See Also:
- Constant Field Values
-
CACHE_SIZE
public static final String CACHE_SIZE
The default cache size.- See Also:
- Constant Field Values
-
INDEX_WORD_CACHE_SIZE
public static final 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 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 String EXCEPTION_WORD_CACHE_SIZE
Size of the exception cache. Overrides the default cache size- See Also:
- Constant Field Values
-
-
Method Detail
-
install
public static void install(FileManager fileManager, FileDictionaryElementFactory factory)
Construct a Dictionary that retrieves file data fromfileManager
. A client can use this to create a Dictionary backed by a RemoteFileManager.- See Also:
RemoteFileManager
-
install
public static void install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory)
Construct a Dictionary that retrieves file data fromfileManager
. If enableCaching is true, lookup operations will check the relavant cache before doing a lookup and will cache their results after doing a lookup.
-
install
public static void install(FileManager fileManager, FileDictionaryElementFactory factory, boolean enableCaching)
-
install
public static void install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory, boolean enableCaching)
-
install
public void install(Map params) throws JWNLException
Install a FileBackedDictionary from a map of parameters. The keys are chose from the static variables above.- Throws:
JWNLException
-
close
public void close()
Description copied from class:Dictionary
Shut down the dictionary- Specified by:
close
in classDictionary
-
getFileManager
protected FileManager getFileManager()
Get the file manager that backs this database.
-
getDictionaryElementFactory
public FileDictionaryElementFactory getDictionaryElementFactory()
-
getIndexWordIterator
public 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 classDictionary
- Parameters:
pos
- The part-of-speech- Returns:
- An iterator over
IndexWord
s - Throws:
JWNLException
-
getIndexWordIterator
public Iterator getIndexWordIterator(POS pos, 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 classDictionary
- Parameters:
pos
- The part-of-speech.- Returns:
- An iterator over
IndexWord
s. - Throws:
JWNLException
-
getIndexWord
public IndexWord getIndexWord(POS pos, 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, useDictionary.lookupIndexWord(POS, String)
.- Specified by:
getIndexWord
in classDictionary
- 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
-
getRandomIndexWord
public IndexWord getRandomIndexWord(POS pos) throws JWNLException
- Specified by:
getRandomIndexWord
in classDictionary
- Throws:
JWNLException
-
getSynsetIterator
public Iterator getSynsetIterator(POS pos)
Description copied from class:Dictionary
Return an Iterator over all the Synsets of part-of-speech pos in the database.- Specified by:
getSynsetIterator
in classDictionary
- Parameters:
pos
- The part-of-speech.- Returns:
- An iterator over
Synset
s.
-
getSynsetAt
public Synset getSynsetAt(POS pos, long offset) throws JWNLException
Description copied from class:Dictionary
Return theSynset
at offsetoffset
from the database.- Specified by:
getSynsetAt
in classDictionary
- Parameters:
pos
- The part-of-speech file to look inoffset
- The offset of the synset in the file- Returns:
- A synset containing the parsed line from the database
- Throws:
JWNLException
-
getExceptionIterator
public Iterator getExceptionIterator(POS pos)
Description copied from class:Dictionary
Return an Iterator over all the Exceptions in the database.- Specified by:
getExceptionIterator
in classDictionary
- Parameters:
pos
- the part-of-speech- Returns:
- Iterator An iterator over
String
s
-
getException
public Exc getException(POS pos, String derivation) throws JWNLException
Description copied from class:Dictionary
Lookupderivation
in the exceptions file of part-of-speechpos
and return an Exc object containing the results.- Specified by:
getException
in classDictionary
- Parameters:
pos
- the exception file to look inderivation
- the word to look up- Returns:
- Exc the Exc object
- Throws:
JWNLException
-
-