dk.dren.hunspell

Class Hunspell

java.lang.Object

dk.dren.hunspell.Hunspell

All Implemented Interfaces:

com.sun.jna.Library, HunspellLibrary

public class Hunspell
extends Object
implements HunspellLibrary

The simple hunspell library frontend which takes care of creating and singleton'ing the library instance (no need to load it more than once per process) . The Hunspell java bindings are licensed under the same terms as Hunspell itself (GPL/LGPL/MPL tri-license), see the file COPYING.txt in the root of the distribution for the exact terms.

Author:

Flemming Frandsen (flfr at stibo dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Hunspell.Dictionary Class representing a single dictionary.

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Hunspell(String libDir) Constructor for the library, loads the native lib.

Method Summary

Modifier and Type	Method and Description
void	destroyDictionary(String baseFileName) Removes a dictionary from the internal cache.
Hunspell.Dictionary	getDictionary(String baseFileName) Gets an instance of the dictionary.
Hunspell.Dictionary	getDictionary(String baseFileName, boolean isUpdateAllowed) Gets an instance of the dictionary optionally checking to see if it has changed since the last time it was cached.
static Hunspell	getInstance() The instance of the HunspellManager, looks for the native lib in the default directories
static Hunspell	getInstance(String libDir) The instance of the HunspellManager, looks for the native lib in the directory specified.
String	getLibFile()
int	Hunspell_add(com.sun.jna.Pointer pHunspell, byte[] word)
int	Hunspell_analyze(com.sun.jna.Pointer pHunspell, com.sun.jna.ptr.PointerByReference slst, byte[] word) Analyze word morphology
com.sun.jna.Pointer	Hunspell_create(String affpath, String dpath) Create the hunspell instance
void	Hunspell_destroy(com.sun.jna.Pointer pHunspell) Destroy him my robots...
void	Hunspell_free_list(com.sun.jna.Pointer pHunspell, com.sun.jna.ptr.PointerByReference slst, int n) Free the memory used by the lists created as output from the other functions.
String	Hunspell_get_dic_encoding(com.sun.jna.Pointer pHunspell) Get the dictionary encoding
int	Hunspell_remove(com.sun.jna.Pointer pHunspell, byte[] word)
int	Hunspell_spell(com.sun.jna.Pointer pHunspell, byte[] word) spell(word) - spellcheck word
int	Hunspell_stem(com.sun.jna.Pointer pHunspell, com.sun.jna.ptr.PointerByReference slst, byte[] word) Find stem(s) for a word
int	Hunspell_suggest(com.sun.jna.Pointer pHunspell, com.sun.jna.ptr.PointerByReference slst, byte[] word) Search suggestions
static String	libName() Calculate the filename of the native hunspell lib.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hunspell

protected Hunspell(String libDir)
            throws UnsatisfiedLinkError,
                   UnsupportedOperationException

Constructor for the library, loads the native lib. Loading is done in the first of the following three ways that works: 1) Unmodified load in the provided directory. 2) libFile stripped back to the base name (^lib(.*)\.so on unix) 3) The library is searched for in the classpath, extracted to disk and loaded.

Parameters:

libDir - Optional absolute directory where the native lib can be found.

Throws:

UnsupportedOperationException - if the OS or architecture is simply not supported.

UnsatisfiedLinkError

Method Detail

Hunspell_create

public com.sun.jna.Pointer Hunspell_create(String affpath,
                                           String dpath)

Description copied from interface: HunspellLibrary

Create the hunspell instance

Specified by:

Hunspell_create in interface HunspellLibrary

Parameters:

affpath - The affix file

dpath - The dictionary file

Returns:

The hunspell object

Hunspell_destroy

public void Hunspell_destroy(com.sun.jna.Pointer pHunspell)

Description copied from interface: HunspellLibrary

Destroy him my robots...

Specified by:

Hunspell_destroy in interface HunspellLibrary

Parameters:

pHunspell - The Hunspell object returned by Hunspell_create

Hunspell_spell

public int Hunspell_spell(com.sun.jna.Pointer pHunspell,
                          byte[] word)

Description copied from interface: HunspellLibrary

spell(word) - spellcheck word

Specified by:

Hunspell_spell in interface HunspellLibrary

Parameters:

pHunspell - The Hunspell object returned by Hunspell_create

word - The word to spellcheck.

Returns:

0 = bad word, not 0 = good word

Hunspell_get_dic_encoding

public String Hunspell_get_dic_encoding(com.sun.jna.Pointer pHunspell)

Description copied from interface: HunspellLibrary

Get the dictionary encoding

Specified by:

Hunspell_get_dic_encoding in interface HunspellLibrary

Parameters:

pHunspell - : The Hunspell object returned by Hunspell_create

Returns:

The encoding name

Hunspell_suggest

public int Hunspell_suggest(com.sun.jna.Pointer pHunspell,
                            com.sun.jna.ptr.PointerByReference slst,
                            byte[] word)

Description copied from interface: HunspellLibrary

Search suggestions

Specified by:

Hunspell_suggest in interface HunspellLibrary

Parameters:

pHunspell - The Hunspell object returned by Hunspell_create

slst - input: pointer to an array of strings pointer and the (bad) word array of strings pointer (here *slst) may not be initialized output: number of suggestions in string array, and suggestions in a newly allocated array of strings (*slts will be NULL when number of suggestion equals 0.)

word - The word to offer suggestions for.

Hunspell_analyze

public int Hunspell_analyze(com.sun.jna.Pointer pHunspell,
                            com.sun.jna.ptr.PointerByReference slst,
                            byte[] word)

Description copied from interface: HunspellLibrary

Analyze word morphology

Specified by:

Hunspell_analyze in interface HunspellLibrary

Parameters:

pHunspell - The Hunspell object returned by Hunspell_create

slst - input: pointer to an array of strings pointer and the word to analyze array of strings pointer (here *slst) may not be initialized output: number of analyses in string array, and analyses in a newly allocated array of strings (*slts will be NULL when number of analyses equals 0.)

word - The word to analyze.

Hunspell_stem

public int Hunspell_stem(com.sun.jna.Pointer pHunspell,
                         com.sun.jna.ptr.PointerByReference slst,
                         byte[] word)

Description copied from interface: HunspellLibrary

Find stem(s) for a word

Specified by:

Hunspell_stem in interface HunspellLibrary

Parameters:

pHunspell - The Hunspell object returned by Hunspell_create

slst - input: pointer to an array of strings pointer and the word to be stemmed array of strings pointer (here *slst) may not be initialized output: number of stems in string array, and stems in a newly allocated array of strings (*slts will be NULL when number of stems equals 0.)

word - The word to find stems for.

Hunspell_free_list

public void Hunspell_free_list(com.sun.jna.Pointer pHunspell,
                               com.sun.jna.ptr.PointerByReference slst,
                               int n)

Description copied from interface: HunspellLibrary

Free the memory used by the lists created as output from the other functions.

Specified by:

Hunspell_free_list in interface HunspellLibrary

Parameters:

pHunspell - the Hunspell object returned by HunspellLibrary.Hunspell_create(String, String)

slst - the PointerByReference (char***) that is used for the suggestion lists

Hunspell_add

public int Hunspell_add(com.sun.jna.Pointer pHunspell,
                        byte[] word)

Hunspell_remove

public int Hunspell_remove(com.sun.jna.Pointer pHunspell,
                           byte[] word)

getInstance

public static Hunspell getInstance()
                            throws UnsatisfiedLinkError,
                                   UnsupportedOperationException

The instance of the HunspellManager, looks for the native lib in the default directories

Throws:

UnsatisfiedLinkError

UnsupportedOperationException

getInstance

public static Hunspell getInstance(String libDir)
                            throws UnsatisfiedLinkError,
                                   UnsupportedOperationException

The instance of the HunspellManager, looks for the native lib in the directory specified.

Parameters:

libDir - Optional absolute directory where the native lib can be found.

Throws:

UnsatisfiedLinkError

UnsupportedOperationException

getLibFile

public String getLibFile()

libName

public static String libName()
                      throws UnsupportedOperationException

Calculate the filename of the native hunspell lib. The files have completely different names to allow them to live in the same directory and avoid confusion.

Throws:

UnsupportedOperationException

getDictionary

public Hunspell.Dictionary getDictionary(String baseFileName)
                                  throws FileNotFoundException,
                                         UnsupportedEncodingException

Gets an instance of the dictionary. If a cached instance of the dictionary exists it will be returned even if it's contents aren't in sync with the affix/dictionary files. If you would instead prefer a dictionary that reflects the current file contents you should first remove the stale dictionary from the cache and destroy it.

Parameters:

baseFileName - the base name of the dictionary, passing /dict/da_DK means that the files /dict/da_DK.dic and /dict/da_DK.aff get loaded

Throws:

FileNotFoundException

UnsupportedEncodingException

getDictionary

public Hunspell.Dictionary getDictionary(String baseFileName,
                                         boolean isUpdateAllowed)
                                  throws FileNotFoundException,
                                         UnsupportedEncodingException

Gets an instance of the dictionary optionally checking to see if it has changed since the last time it was cached.

Parameters:

baseFileName - the base name of the dictionary, passing /dict/da_DK means that the files /dict/da_DK.dic and /dict/da_DK.aff get loaded

isUpdateAllowed -

Throws:

FileNotFoundException

UnsupportedEncodingException

destroyDictionary

public void destroyDictionary(String baseFileName)

Removes a dictionary from the internal cache. Note: that this will not free up any memory used by the Dictionary itself.

Parameters:

baseFileName - the base name of the dictionary, as passed to getDictionary()