org.dts.spell.dictionary.openoffice

Class OpenOfficeSpellDictionary

java.lang.Object

org.dts.spell.dictionary.openoffice.OpenOfficeSpellDictionary

All Implemented Interfaces:

SpellDictionary

public class OpenOfficeSpellDictionary
extends Object
implements SpellDictionary

Author:

DreamTangerine

Constructor Summary

Constructors

Constructor and Description
OpenOfficeSpellDictionary()
OpenOfficeSpellDictionary(File file)
OpenOfficeSpellDictionary(File file, boolean inBackground)
OpenOfficeSpellDictionary(File dictFile, File affFile)
OpenOfficeSpellDictionary(File dictFile, File affFile, boolean inBackground)
OpenOfficeSpellDictionary(InputStream zipStream, File personalDict)
OpenOfficeSpellDictionary(InputStream zipStream, File personalDict, boolean inBackground)
OpenOfficeSpellDictionary(InputStream affIS, InputStream dicIS)
OpenOfficeSpellDictionary(InputStream affIS, InputStream dicIS, boolean inBackground)
OpenOfficeSpellDictionary(InputStream affIS, InputStream dicIS, File personalDict, boolean inBackground)
OpenOfficeSpellDictionary(Locale locale)
OpenOfficeSpellDictionary(ZipFile zipFile)
OpenOfficeSpellDictionary(ZipFile zipFile, boolean inBackground)

Method Summary

Modifier and Type	Method and Description
void	addProgressListener(ProgressListener listener) Add a listener to monitor dictionary load.
void	addWord(String word) Add a word permanently to the dictionary.
Locale	getLocale() The locale for what this dictionary is for.
List<String>	getSuggestions(String word) Returns a list of String that are the suggestions to any word.
List<String>	getSuggestions(String word, int nMax) Returns a list of String that are the suggestions to any word.
boolean	isCorrect(String word) Returns true if the word is correctly spelled against the dictionary.
boolean	isLoad()
void	load()
void	load(File file, boolean inBackground)
void	load(File dictFile, File affFile, boolean inBackground)
void	load(InputStream zipStream, File personalDict, boolean inBackground)
void	load(InputStream affIS, InputStream dicIS, boolean inBackground)
void	load(InputStream affIS, InputStream dicIS, File personalDict, boolean inBackground)
void	load(ZipFile zipFile, boolean inBackground)
void	removeProgressListener(ProgressListener listener) Remove a listener to monitor dictionary load
void	setDictionarySource(URL url)
void	setLocale(Locale locale)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary()

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(Locale locale)

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(InputStream affIS,
                                 InputStream dicIS)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(InputStream affIS,
                                 InputStream dicIS,
                                 boolean inBackground)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(InputStream affIS,
                                 InputStream dicIS,
                                 File personalDict,
                                 boolean inBackground)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(ZipFile zipFile)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(ZipFile zipFile,
                                 boolean inBackground)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(InputStream zipStream,
                                 File personalDict)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(InputStream zipStream,
                                 File personalDict,
                                 boolean inBackground)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(File file)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(File file,
                                 boolean inBackground)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(File dictFile,
                                 File affFile)
                          throws IOException

Throws:

IOException

OpenOfficeSpellDictionary

public OpenOfficeSpellDictionary(File dictFile,
                                 File affFile,
                                 boolean inBackground)
                          throws IOException

Throws:

IOException

Method Detail

addWord

public void addWord(String word)
             throws SpellDictionaryException

Description copied from interface: SpellDictionary

Add a word permanently to the dictionary. In general, to the personal dictionary associated with this main dictionary.

Specified by:

addWord in interface SpellDictionary

Parameters:

word - a word to add.

Throws:

SpellDictionaryException

isCorrect

public boolean isCorrect(String word)

Description copied from interface: SpellDictionary

Returns true if the word is correctly spelled against the dictionary.

Specified by:

isCorrect in interface SpellDictionary

Parameters:

word - a word to check.

getSuggestions

public List<String> getSuggestions(String word)

Description copied from interface: SpellDictionary

Returns a list of String that are the suggestions to any word. If the word is correctly spelled, then this method could return just that one word, or it could still return a list of words with similar spellings.

Specified by:

getSuggestions in interface SpellDictionary

Parameters:

word - the word that we want to get a list of spelling suggestions for.

Returns:

List a List of suggested words. It can't be null. An empty list must be return no suggestions.

getSuggestions

public List<String> getSuggestions(String word,
                                   int nMax)

Description copied from interface: SpellDictionary

Returns a list of String that are the suggestions to any word. If the word is correctly spelled, then this method could return just that one word, or it could still return a list of words with similar spellings.

Specified by:

getSuggestions in interface SpellDictionary

Parameters:

word - the word that we want to get a list of spelling suggestions for.

nMax - the maximun number of word to return

Returns:

List a List of suggested words. It can't be null. An empty list must be return no suggestions.

isLoad

public boolean isLoad()

Specified by:

isLoad in interface SpellDictionary

Returns:

if dictionary is load and ready to use.

load

public void load(InputStream affIS,
                 InputStream dicIS,
                 boolean inBackground)
          throws IOException

Throws:

IOException

load

public void load(InputStream affIS,
                 InputStream dicIS,
                 File personalDict,
                 boolean inBackground)
          throws IOException

Throws:

IOException

load

public void load(ZipFile zipFile,
                 boolean inBackground)
          throws IOException

Throws:

IOException

load

public void load(InputStream zipStream,
                 File personalDict,
                 boolean inBackground)
          throws IOException

Throws:

IOException

load

public void load(File dictFile,
                 File affFile,
                 boolean inBackground)
          throws IOException

Throws:

IOException

load

public void load(File file,
                 boolean inBackground)
          throws IOException

Throws:

IOException

setDictionarySource

public void setDictionarySource(URL url)

load

public void load()
          throws IOException

Specified by:

load in interface SpellDictionary

Throws:

IOException

addProgressListener

public void addProgressListener(ProgressListener listener)

Description copied from interface: SpellDictionary

Add a listener to monitor dictionary load.

Specified by:

addProgressListener in interface SpellDictionary

Parameters:

listener - the listener to add

removeProgressListener

public void removeProgressListener(ProgressListener listener)

Description copied from interface: SpellDictionary

Remove a listener to monitor dictionary load

Specified by:

removeProgressListener in interface SpellDictionary

setLocale

public void setLocale(Locale locale)

getLocale

public Locale getLocale()

Description copied from interface: SpellDictionary

The locale for what this dictionary is for.

Specified by:

getLocale in interface SpellDictionary

Returns:

the locale for this dictionary.