|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.didion.jwnl.dictionary.Dictionary
net.didion.jwnl.dictionary.AbstractCachingDictionary
net.didion.jwnl.dictionary.FileBackedDictionary
public class FileBackedDictionary
A Dictionary
that retrieves objects from the text files
in the WordNet distribution directory.
Field Summary | |
---|---|
static java.lang.String |
CACHE_SIZE
The default cache size. |
static java.lang.String |
DICTIONARY_ELEMENT_FACTORY
The class of FileDictionaryElementFactory to use. |
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 |
MORPH
Morphological processor class install parameter. |
static java.lang.String |
SYNSET_WORD_CACHE_SIZE
Size of the synset cache. |
Constructor Summary | |
---|---|
FileBackedDictionary()
|
Method Summary | |
---|---|
void |
close()
Shut down the dictionary |
FileDictionaryElementFactory |
getDictionaryElementFactory()
|
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)
|
java.lang.String |
getSenseKey(long offset,
java.lang.String lemma)
Gets the sense key for this combination. |
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. |
int |
getUsageCount(long offset,
java.lang.String lemma)
Gets the usage count for this offset/lemma combination. |
static void |
install(FileManager fileManager,
FileDictionaryElementFactory factory)
Construct a Dictionary that retrieves file data from fileManager . |
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 from fileManager . |
static void |
install(FileManager fileManager,
MorphologicalProcessor morph,
FileDictionaryElementFactory factory,
boolean enableCaching)
|
void |
install(java.util.Map params)
Install a FileBackedDictionary from a map of parameters. |
Methods inherited from class net.didion.jwnl.dictionary.AbstractCachingDictionary |
---|
clearCache, clearCache, getCacheCapacity, getCacheSizes, isCachingEnabled, setCacheCapacity, setCacheCapacity, setCachingEnabled |
Methods inherited from class net.didion.jwnl.dictionary.Dictionary |
---|
getInstance, getMorphologicalProcessor, lookupAllIndexWords, lookupIndexWord, uninstall |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String MORPH
public static final java.lang.String FILE_MANAGER
public static final java.lang.String DICTIONARY_ELEMENT_FACTORY
public static final java.lang.String ENABLE_CACHING
public static final java.lang.String CACHE_SIZE
public static final java.lang.String INDEX_WORD_CACHE_SIZE
public static final java.lang.String SYNSET_WORD_CACHE_SIZE
public static final java.lang.String EXCEPTION_WORD_CACHE_SIZE
Constructor Detail |
---|
public FileBackedDictionary()
Method Detail |
---|
public static void install(FileManager fileManager, FileDictionaryElementFactory factory)
fileManager
.
A client can use this to create a Dictionary backed by a RemoteFileManager.
RemoteFileManager
public static void install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory)
fileManager
.
If enableCaching is true, lookup operations will check the relavant cache before
doing a lookup and will cache their results after doing a lookup.
public static void install(FileManager fileManager, FileDictionaryElementFactory factory, boolean enableCaching)
public static void install(FileManager fileManager, MorphologicalProcessor morph, FileDictionaryElementFactory factory, boolean enableCaching)
public void install(java.util.Map params) throws JWNLException
JWNLException
public void close()
Dictionary
close
in class Dictionary
public FileDictionaryElementFactory getDictionaryElementFactory()
public java.util.Iterator getIndexWordIterator(POS pos) throws JWNLException
Dictionary
getIndexWordIterator
in class Dictionary
pos
- The part-of-speech
IndexWord
s
JWNLException
public java.util.Iterator getIndexWordIterator(POS pos, java.lang.String substring) throws JWNLException
Dictionary
getIndexWordIterator
in class Dictionary
pos
- The part-of-speech.
IndexWord
s.
JWNLException
public IndexWord getIndexWord(POS pos, java.lang.String lemma) throws JWNLException
Dictionary
Dictionary.lookupIndexWord(POS, String)
.
getIndexWord
in class Dictionary
pos
- The part-of-speech.lemma
- The orthographic representation of the word.
null
if
no such entry exists.
JWNLException
public IndexWord getRandomIndexWord(POS pos) throws JWNLException
getRandomIndexWord
in class Dictionary
JWNLException
public java.util.Iterator getSynsetIterator(POS pos)
Dictionary
getSynsetIterator
in class Dictionary
pos
- The part-of-speech.
Synset
s.public Synset getSynsetAt(POS pos, long offset) throws JWNLException
Dictionary
Synset
at offset offset
from the database.
getSynsetAt
in class Dictionary
pos
- The part-of-speech file to look inoffset
- The offset of the synset in the file
JWNLException
public java.util.Iterator getExceptionIterator(POS pos)
Dictionary
getExceptionIterator
in class Dictionary
pos
- the part-of-speech
String
spublic Exc getException(POS pos, java.lang.String derivation) throws JWNLException
Dictionary
derivation
in the exceptions file of part-of-speech
pos
and return an Exc object containing the results.
getException
in class Dictionary
pos
- the exception file to look inderivation
- the word to look up
JWNLException
public int getUsageCount(long offset, java.lang.String lemma)
getUsageCount
in class Dictionary
public java.lang.String getSenseKey(long offset, java.lang.String lemma)
getSenseKey
in class Dictionary
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |