org.dts.spell.dictionary.myspell.wordmaps

Class WordMap

java.lang.Object

org.dts.spell.dictionary.myspell.wordmaps.WordMap

Direct Known Subclasses:

AllLinealInMemoryWordMap, IndexedFileWordMap, WordMapWithCharMap

public abstract class WordMap
extends Object

Author:

DreamTangerine

Constructor Summary

Constructors

Constructor and Description
WordMap()

Method Summary

Modifier and Type	Method and Description
abstract void	add(HEntry entry) Add a new entry to WordMap.
abstract void	addCustomWord(String word)
abstract void	beginAddEntries(int nEntries) Called to notice the begin of a add series of calls
static WordMap	create()
abstract void	endAddEntries(int nEntries) Called when all no custom word wre added.
abstract HEntry	get(String word)
abstract void	init(long lastModificationTime, String wordMapName, String encoding) initialize the word map for example from a cache file, it can compare the dates to know if needEntries.
abstract Iterator<HEntry>	iterator()
abstract boolean	needEntries() The word map need the entries of the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordMap

public WordMap()

Method Detail

create

public static WordMap create()
                      throws IOException

Throws:

IOException

init

public abstract void init(long lastModificationTime,
                          String wordMapName,
                          String encoding)
                   throws IOException

initialize the word map for example from a cache file, it can compare the dates to know if needEntries.

Parameters:

lastModificationTime -

Throws:

IOException

needEntries

public abstract boolean needEntries()

The word map need the entries of the file. The idea is that some WordMap create "cache" files in the user directory and need to be recreated if the modification date is outdated.

beginAddEntries

public abstract void beginAddEntries(int nEntries)
                              throws IOException

Called to notice the begin of a add series of calls

Throws:

IOException

endAddEntries

public abstract void endAddEntries(int nEntries)
                            throws IOException

Called when all no custom word wre added.

Throws:

IOException

get

public abstract HEntry get(String word)

add

public abstract void add(HEntry entry)
                  throws IOException

Add a new entry to WordMap. init must be called first

Throws:

IOException

addCustomWord

public abstract void addCustomWord(String word)
                            throws IOException

Throws:

IOException

iterator

public abstract Iterator<HEntry> iterator()