Class HunspellDictionary

java.lang.Object

opennlp.tools.stemmer.hunspell.HunspellDictionary

@ThreadSafe
public final class HunspellDictionary
extends Object

An immutable, in-memory Hunspell-format dictionary loaded from user-supplied .aff and .dic files. OpenNLP includes no dictionary data.

Supported affix features are PFX and SFX rules with strip strings, character-class conditions, cross-product combinations, and a double suffix connected by continuation classes; FLAG modes char, UTF-8, long, and num; the AF alias table; and the SET encoding declaration. Compound decomposition supports COMPOUNDFLAG, COMPOUNDBEGIN, COMPOUNDMIDDLE, COMPOUNDEND, COMPOUNDMIN, COMPOUNDWORDMAX, COMPOUNDPERMITFLAG, COMPOUNDFORBIDFLAG, CHECKCOMPOUNDDUP, CHECKCOMPOUNDCASE, and CHECKCOMPOUNDTRIPLE. The blocking flags NEEDAFFIX (also named PSEUDOROOT), ONLYINCOMPOUND, and FORBIDDENWORD, plus CIRCUMFIX and FULLSTRIP, are also applied.

Other directives are skipped. Their spelling, conversion, suggestion, or advanced compound behavior is not applied by this affix stemmer. Dictionary morphology fields are also ignored.

Instances are immutable and safe to share between threads.

Since:

3.0.0

See Also:

• HunspellStemmer
• HunspellStemmerFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AFFIX_FILE_SUFFIX	The file suffix for a Hunspell affix file.
static final String	DICTIONARY_FILE_SUFFIX	The file suffix for a Hunspell word-list file.
static final int	MAX_STREAM_BYTES	Inclusive upper bound on bytes buffered from one affix or dictionary stream during load(InputStream, InputStream).

Method Summary

Modifier and Type	Method	Description
static HunspellDictionary	load(InputStream affixStream, InputStream dictionaryStream)	Loads a dictionary from its two streams.
static HunspellDictionary	load(Path affixFile, Path dictionaryFile)	Loads a dictionary from its two files.

Methods inherited from class Object

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

Field Details

AFFIX_FILE_SUFFIX

public static final String AFFIX_FILE_SUFFIX

The file suffix for a Hunspell affix file.

See Also:

• Constant Field Values

DICTIONARY_FILE_SUFFIX

public static final String DICTIONARY_FILE_SUFFIX

The file suffix for a Hunspell word-list file.

See Also:

• Constant Field Values

MAX_STREAM_BYTES

public static final int MAX_STREAM_BYTES

Inclusive upper bound on bytes buffered from one affix or dictionary stream during load(InputStream, InputStream). The limit is 64 MiB. Larger streams fail with IOException.

See Also:

• Constant Field Values

Method Details

load

public static HunspellDictionary load(Path affixFile,
 Path dictionaryFile)
                               throws IOException

Loads a dictionary from its two files.

Parameters:

affixFile - The .aff affix file. Must not be null.

dictionaryFile - The .dic word list. Must not be null.

Returns:

The loaded dictionary. Never null.

Throws:

IOException - Thrown if reading fails or a file is malformed.

IllegalArgumentException - Thrown if a parameter is null.

load

public static HunspellDictionary load(InputStream affixStream,
 InputStream dictionaryStream)
                               throws IOException

Loads a dictionary from its two streams. Each stream is buffered up to MAX_STREAM_BYTES bytes; a larger stream fails with IOException.

Parameters:

affixStream - The .aff affix content. Must not be null. Not closed.

dictionaryStream - The .dic word list content. Must not be null. Not closed.

Returns:

The loaded dictionary. Never null.

Throws:

IOException - Thrown if reading fails, a stream exceeds MAX_STREAM_BYTES, or the content is malformed.

IllegalArgumentException - Thrown if a parameter is null.