Class MapBackedDictionary
java.lang.Object
net.didion.jwnl.dictionary.Dictionary
net.didion.jwnl.dictionary.MapBackedDictionary
- All Implemented Interfaces:
Installable
A
Dictionary backed by Maps. Warning: this has huge memory requirements.
Make sure to start the interpreter with a large enough free memory pool to accomodate this.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final classprivate static final class -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final MessageLogprivate static final RandomRandom number generator used by getRandomIndexWord()private Mapstatic final StringFile type install parameter.static final StringMorphologicalProcessorclass install parameter.static final StringThe path of the dictionary files -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivateMapBackedDictionary(DictionaryCatalogSet files, MorphologicalProcessor morph) Create aMapBackedDictionarywith the specified set of files. -
Method Summary
Modifier and TypeMethodDescriptionprivate static voidvoidclose()Shut down the dictionarygetException(POS pos, String derivation) Lookupderivationin the exceptions file of part-of-speechposand return an Exc object containing the results.getExceptionIterator(POS pos) Return an Iterator over all the Exceptions in the database.getIndexWord(POS pos, String lemma) Look up a word in the database.getIndexWordIterator(POS pos) Return an Iterator over all the IndexWords of part-of-speech pos in the database.getIndexWordIterator(POS pos, String substring) Return an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.private IteratorgetIterator(Map map) getRandomIndexWord(POS pos) getSenseKey(long offset, String lemma) Not implemented in Map yet.getSynsetAt(POS pos, long offset) Return theSynsetat offsetoffsetfrom the database.getSynsetIterator(POS pos) Return an Iterator over all the Synsets of part-of-speech pos in the database.private MapgetTable(POS pos, DictionaryFileType fileType) intgetUsageCount(long offset, String lemma) Not implemented in Map yet.static voidstatic voidinstall(String searchDir, Class dictionaryFileType, MorphologicalProcessor morph) voidInstall aMapBackedDictionaryfrom a map of parameters.private MaploadDictFile(DictionaryFile file) private voidputTable(POS pos, DictionaryFileType fileType, Map table) Use table for lookups to the file represented by pos and fileType.Methods inherited from class Dictionary
getInstance, getMorphologicalProcessor, lookupAllIndexWords, lookupIndexWord, prepareQueryString, setDictionary, uninstall
-
Field Details
-
_log
-
MORPH
MorphologicalProcessorclass install parameter. The value should be the class ofMorphologicalProcessorto use.- See Also:
-
FILE_TYPE
File type install parameter. The value should be * the name of the appropriate subclass ofDictionaryFileType.- See Also:
-
PATH
-
_rand
Random number generator used by getRandomIndexWord() -
_tableMap
-
-
Constructor Details
-
MapBackedDictionary
public MapBackedDictionary() -
MapBackedDictionary
private MapBackedDictionary(DictionaryCatalogSet files, MorphologicalProcessor morph) throws JWNLException Create aMapBackedDictionarywith the specified set of files.- Throws:
JWNLException
-
-
Method Details
-
install
- Throws:
JWNLException
-
install
public static void install(String searchDir, Class dictionaryFileType, MorphologicalProcessor morph) throws JWNLException - Throws:
JWNLException
-
install
Install aMapBackedDictionaryfrom a map of parameters. The parameters are chosen from the static variables above.- Throws:
JWNLException
-
checkFileType
-
getIndexWord
Description copied from class:DictionaryLook 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:
getIndexWordin classDictionary- Parameters:
pos- The part-of-speech.lemma- The orthographic representation of the word.- Returns:
- An IndexWord representing the word, or
nullif no such entry exists.
-
getIndexWordIterator
Description copied from class:DictionaryReturn an Iterator over all the IndexWords of part-of-speech pos whose lemmas contain substring as a substring.- Specified by:
getIndexWordIteratorin classDictionary- Parameters:
pos- The part-of-speech.- Returns:
- An iterator over
IndexWords.
-
getIndexWordIterator
Description copied from class:DictionaryReturn an Iterator over all the IndexWords of part-of-speech pos in the database.- Specified by:
getIndexWordIteratorin classDictionary- Parameters:
pos- The part-of-speech- Returns:
- An iterator over
IndexWords
-
getRandomIndexWord
- Specified by:
getRandomIndexWordin classDictionary- Throws:
JWNLException
-
getSynsetIterator
Description copied from class:DictionaryReturn an Iterator over all the Synsets of part-of-speech pos in the database.- Specified by:
getSynsetIteratorin classDictionary- Parameters:
pos- The part-of-speech.- Returns:
- An iterator over
Synsets.
-
getExceptionIterator
Description copied from class:DictionaryReturn an Iterator over all the Exceptions in the database.- Specified by:
getExceptionIteratorin classDictionary- Parameters:
pos- the part-of-speech- Returns:
- Iterator An iterator over
Strings
-
getIterator
-
getSynsetAt
Description copied from class:DictionaryReturn theSynsetat offsetoffsetfrom the database.- Specified by:
getSynsetAtin 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
-
getException
Description copied from class:DictionaryLookupderivationin the exceptions file of part-of-speechposand return an Exc object containing the results.- Specified by:
getExceptionin classDictionary- Parameters:
pos- the exception file to look inderivation- the word to look up- Returns:
- Exc the Exc object
-
close
public void close()Description copied from class:DictionaryShut down the dictionary- Specified by:
closein classDictionary
-
loadDictFile
- Throws:
JWNLException
-
putTable
Use table for lookups to the file represented by pos and fileType. -
getTable
-
getUsageCount
Not implemented in Map yet. -
getSenseKey
-