org.dts.spell.dictionary.myspell.wordmaps

Class IndexedFileWordMap

java.lang.Object

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

org.dts.spell.dictionary.myspell.wordmaps.IndexedFileWordMap

Direct Known Subclasses:

IndexedFileWordMapWithCache

public class IndexedFileWordMap
extends WordMap

Author:

DreamTangerine

Constructor Summary

Constructors

Constructor and Description
IndexedFileWordMap(boolean onlyFiles) Creates a new instance of IndexedFileWordMap

Method Summary

Modifier and Type	Method and Description
void	add(HEntry entry) Add a new entry to WordMap.
void	addCustomWord(String word)
void	beginAddEntries(int nEntries) Called to notice the begin of a add series of calls
void	endAddEntries(int nEntries) Called when all no custom word wre added.
HEntry	get(String word)
protected HEntry	getEntry(int index)
protected HEntry	getEntryFromPosition(long position)
protected long	getEntryPosition(int index)
protected String	getWord(int index)
protected int	getWordIndex(String word)
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.
Iterator<HEntry>	iterator()
boolean	needEntries() The word map need the entries of the file.

Methods inherited from class org.dts.spell.dictionary.myspell.wordmaps.WordMap

create

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedFileWordMap

public IndexedFileWordMap(boolean onlyFiles)

Creates a new instance of IndexedFileWordMap

Parameters:

onlyFiles - No memory index is created. All operations are with files, so so there is less waste of memory, but poor perfomance.

Method Detail

init

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

Description copied from class: WordMap

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

Specified by:

init in class WordMap

Throws:

IOException

needEntries

public boolean needEntries()

Description copied from class: WordMap

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.

Specified by:

needEntries in class WordMap

beginAddEntries

public void beginAddEntries(int nEntries)
                     throws IOException

Description copied from class: WordMap

Called to notice the begin of a add series of calls

Specified by:

beginAddEntries in class WordMap

Throws:

IOException

endAddEntries

public void endAddEntries(int nEntries)
                   throws IOException

Description copied from class: WordMap

Called when all no custom word wre added.

Specified by:

endAddEntries in class WordMap

Throws:

IOException

get

public HEntry get(String word)

Specified by:

get in class WordMap

add

public void add(HEntry entry)
         throws IOException

Description copied from class: WordMap

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

Specified by:

add in class WordMap

Throws:

IOException

getEntryPosition

protected long getEntryPosition(int index)

getWordIndex

protected int getWordIndex(String word)

getWord

protected String getWord(int index)

getEntry

protected HEntry getEntry(int index)

getEntryFromPosition

protected HEntry getEntryFromPosition(long position)

addCustomWord

public void addCustomWord(String word)
                   throws IOException

Specified by:

addCustomWord in class WordMap

Throws:

IOException

iterator

public Iterator<HEntry> iterator()

Specified by:

iterator in class WordMap