com.atlascopco.hunspell

Class Hunspell

java.lang.Object

com.atlascopco.hunspell.Hunspell

All Implemented Interfaces:

Closeable, AutoCloseable

public class Hunspell
extends Object
implements Closeable

This class implements an object-oriented interface to the C API for Hunspell.

Author:

Thomas Joiner

Constructor Summary

Constructors

Constructor and Description
Hunspell(String dictionaryPath, String affixPath) Instantiate a hunspell object with the given dictionary and affix file
Hunspell(String dictionaryPath, String affixPath, String key) Instantiate a hunspell object with the given hunzipped dictionary and affix files.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String word) Add a word to the runtime dictionary.
void	addDic(String dpath) Add an additional dictionary file (.dic file only, no affix file) to the runtime dictionary.
void	addWithAffix(String word, String exampleWord) Add the word to the runtime dictionary with the affix flags of the given example word so that affixed versions will be recognized as well.
List<String>	analyze(String word) Morphological analysis of the given word.
void	close() This method will handle the destruction of the Hunspell instance and ensure that the memory is reclaimed.
protected void	finalize()
List<String>	generate(String word, List<String> basedOnAnalysis) Generate a form for the given word based on the analysis of a second word.
List<String>	generate(String word, String basedOn) Generate a form for the first word based on the second word.
String	getDictionaryEncoding() Get the dictionary encoding for this object.
boolean	isCorrect(String word) Same as spell(String)
void	remove(String word) Remove a word from the runtime dictionary.
boolean	spell(String word) Spellcheck the given word.
List<String>	stem(List<String> analysis) Gets the stems of a word from the results of analyze(String).
List<String>	stem(String word) Gets the stems of the word.
List<String>	suggest(String word) Suggest a list of corrections for the given word.
org.bridj.Pointer<org.bridj.Pointer<Byte>>	toEncodedCStringList(List<String> strings) Convert a list of strings to a list of cstrings in the dictionary encoding.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hunspell

public Hunspell(String dictionaryPath,
        String affixPath)

Instantiate a hunspell object with the given dictionary and affix file

Parameters:

dictionaryPath - the path to the dictionary

affixPath - the path to the affix file

Hunspell

public Hunspell(String dictionaryPath,
        String affixPath,
        String key)

Instantiate a hunspell object with the given hunzipped dictionary and affix files.

This is, however more complicated than it looks. Note that the paths aren't actually to the hunzipped dictionary and affix files, they are the paths to what they would be named if they weren't hunzipped. In other words, if you have the files /path/to/dictionary.dic.hz and /path/to/dictionary.aff.hz you would call new Hunspell("/path/to/dictionary.dic", "/path/to/dictionary.aff", "password") . Note, however, that if the paths that you give actually exist, those will be prioritized over the hunzipped versions and will be used instead.

Parameters:

dictionaryPath - the path to the dictionary

affixPath - the path to the affix file

key - the key used to encrypt the dictionary files

Method Detail

spell

public boolean spell(String word)

Spellcheck the given word.

Parameters:

word - the word to check

Returns:

true if it is spelled correctly

See Also:

HunspellLibrary.Hunspell_spell(Pointer, Pointer)

isCorrect

public boolean isCorrect(String word)

Same as spell(String)

Parameters:

word - the word to check.

Returns:

true if it correct

See Also:

spell(String)

getDictionaryEncoding

public String getDictionaryEncoding()

Get the dictionary encoding for this object.

Returns:

the encoding for the dictionary

See Also:

HunspellLibrary.Hunspell_get_dic_encoding(Pointer)

suggest

public List<String> suggest(String word)

Suggest a list of corrections for the given word.

Parameters:

word - the word to get suggestions for

Returns:

the list of suggestions

See Also:

HunspellLibrary.Hunspell_suggest(Pointer, Pointer, Pointer)

analyze

public List<String> analyze(String word)

Morphological analysis of the given word.

Parameters:

word - the word to analyze

Returns:

the analysis

See Also:

HunspellLibrary.Hunspell_analyze(Pointer, Pointer, Pointer)

stem

public List<String> stem(String word)

Gets the stems of the word.

Parameters:

word - the word

Returns:

stems for the word

See Also:

HunspellLibrary.Hunspell_stem(Pointer, Pointer, Pointer)

stem

public List<String> stem(List<String> analysis)

Gets the stems of a word from the results of analyze(String).

Parameters:

analysis - the results of analyze(String)

Returns:

the stem information

See Also:

HunspellLibrary.Hunspell_stem2(Pointer, Pointer, Pointer, int)

generate

public List<String> generate(String word,
                    String basedOn)

Generate a form for the first word based on the second word.

Parameters:

word - the word to generate the form for

basedOn - the word to base the generation on

Returns:

the generated form

See Also:

HunspellLibrary.Hunspell_generate(Pointer, Pointer, Pointer, Pointer)

generate

public List<String> generate(String word,
                    List<String> basedOnAnalysis)

Generate a form for the given word based on the analysis of a second word.

Parameters:

word - the word for which to generate the form

basedOnAnalysis - the analysis of the word that it is based on

Returns:

the generated form(s)

See Also:

HunspellLibrary.Hunspell_generate2(Pointer, Pointer, Pointer, Pointer, int)

addDic

public void addDic(String dpath)

Add an additional dictionary file (.dic file only, no affix file) to the runtime dictionary.

Parameters:

dpath - the Path to the dictionary file.

See Also:

HunspellLibrary.Hunspell_add_dic(Pointer, Pointer)

add

public void add(String word)

Add a word to the runtime dictionary.

Parameters:

word - the word to add

See Also:

HunspellLibrary.Hunspell_add(Pointer, Pointer)

addWithAffix

public void addWithAffix(String word,
                String exampleWord)

Add the word to the runtime dictionary with the affix flags of the given example word so that affixed versions will be recognized as well.

Parameters:

word - the word

exampleWord - a word that shows an example of what affix rules apply

See Also:

HunspellLibrary.Hunspell_add_with_affix(Pointer, Pointer, Pointer)

remove

public void remove(String word)

Remove a word from the runtime dictionary.

Parameters:

word - the word to remove

See Also:

HunspellLibrary.Hunspell_remove(Pointer, Pointer)

close

public void close()

This method will handle the destruction of the Hunspell instance and ensure that the memory is reclaimed.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

toEncodedCStringList

public org.bridj.Pointer<org.bridj.Pointer<Byte>> toEncodedCStringList(List<String> strings)

Convert a list of strings to a list of cstrings in the dictionary encoding.

Parameters:

strings - the strings to encode

Returns:

the pointer

See Also:

Pointer.pointerToCStrings(String...)