com.swabunga.spell.engine
public class SpellDictionaryDisk extends SpellDictionaryASpell
SpellDictionary that doesn't cache any words in memory. Avoids the huge
footprint of SpellDictionaryHashMap at the cost of relatively minor latency. A future version
of this class that implements some caching strategies might be a good idea in the future, if there's any
demand for it.
This class makes use of the "classic" Java IO library (java.io). However, it could probably benefit from
the new IO APIs (java.nio) and it is anticipated that a future version of this class, probably called
SpellDictionaryDiskNIO will appear at some point.
Since: 0.5
Version: 0.1
| Field Summary | |
|---|---|
| protected boolean | ready
The flag indicating if the initial preparation or loading of the on
disk dictionary is complete. |
| Constructor Summary | |
|---|---|
| SpellDictionaryDisk(File base, File phonetic, boolean block)
Construct a spell dictionary on disk.
| |
| Method Summary | |
|---|---|
| void | addWord(String word)
Adds another word to the dictionary. |
| protected void | buildNewDictionaryDatabase()
Builds the file words database file and the contents file for the on
disk dictionary. |
| List | getWords(String code)
Returns a list of words that have the same phonetic code. |
| boolean | isReady()
Indicates if the initial preparation or loading of the on disk dictionary
is complete. |
| protected void | loadIndex()
Loads the index file from disk. |
base/words dictionary where base
is the path to words dictionary. The on disk spell
dictionary is created in base/db dictionary and contains
files:
contents list the words files used for spelling.words.db the content of words files organized as
a database of words.words.idx an index file to the words.db
file content.contents file has a list of
filename, size indicating the name and length of each files
in the base/words dictionary. If one of theses files was
changed, added or deleted before the call to the constructor, the process
of producing new or updated words.db and
words.idx files is started again.
The spellchecking process is then worked upon the words.db
and words.idx files.
NOTE: Do *not* create two instances of this class pointing to the same base unless
you are sure that a new dictionary does not have to be created. In the future, some sort of
external locking mechanism may be created that handles this scenario gracefully.
Parameters: base the base directory in which SpellDictionaryDisk can expect to find
its necessary files. phonetic the phonetic file used by the spellchecker. block if a new word db needs to be created, there can be a considerable delay before
the constructor returns. If block is true, this method will block while the db is created
and return when done. If block is false, this method will create a thread to create the new
dictionary and return immediately.
Throws: java.io.FileNotFoundException indicates problems locating the files on the system java.io.IOException indicates problems reading the files
Parameters: word The word to add.
Parameters: code The phonetic code common to the list of words
Returns: A list of words having the same phonetic code
Returns: the indication that the dictionary initial setup is done.