Module org.apache.lucene.analysis.common

Package org.apache.lucene.analysis.hunspell

Class HunspellStemFilterFactory

java.lang.Object

org.apache.lucene.analysis.AbstractAnalysisFactory

org.apache.lucene.analysis.TokenFilterFactory

org.apache.lucene.analysis.hunspell.HunspellStemFilterFactory

All Implemented Interfaces:

ResourceLoaderAware

public class HunspellStemFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware

TokenFilterFactory that creates instances of HunspellStemFilter. Example config for British English:

 <filter class="solr.HunspellStemFilterFactory"
         dictionary="en_GB.dic,my_custom.dic"
         affix="en_GB.aff"
         ignoreCase="false"
         longestOnly="false" />

Both parameters dictionary and affix are mandatory. Dictionaries for many languages are available through the OpenOffice project.

See http://wiki.apache.org/solr/Hunspell

Since:

3.5.0

Field Summary

Fields

Modifier and Type	Field	Description
private final String	affixFile
private Dictionary	dictionary
private final String	dictionaryFiles
private final boolean	ignoreCase
private final boolean	longestOnly
static final String	NAME	SPI name
private static final String	PARAM_AFFIX
private static final String	PARAM_DICTIONARY
private static final String	PARAM_IGNORE_CASE
private static final String	PARAM_LONGEST_ONLY

Fields inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor	Description
HunspellStemFilterFactory()	Default ctor for compatibility with SPI
HunspellStemFilterFactory(Map<String,String> args)	Creates a new HunspellStemFilterFactory

Method Summary

Modifier and Type	Method	Description
TokenStream	create(TokenStream tokenStream)	Transform the specified input TokenStream
void	inform(ResourceLoader loader)	Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).

Methods inherited from class org.apache.lucene.analysis.TokenFilterFactory

availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters

Methods inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory

defaultCtorException, get, get, get, get, get, getBoolean, getChar, getClassArg, getFloat, getInt, getLines, getLuceneMatchVersion, getOriginalArgs, getPattern, getSet, getSnowballWordSet, getWordSet, isExplicitLuceneMatchVersion, require, require, require, requireBoolean, requireChar, requireFloat, requireInt, setExplicitLuceneMatchVersion, splitAt, splitFileNames

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

SPI name

See Also:

• Constant Field Values

PARAM_DICTIONARY

private static final String PARAM_DICTIONARY

See Also:

• Constant Field Values

PARAM_AFFIX

private static final String PARAM_AFFIX

See Also:

• Constant Field Values

PARAM_IGNORE_CASE

private static final String PARAM_IGNORE_CASE

See Also:

• Constant Field Values

PARAM_LONGEST_ONLY

private static final String PARAM_LONGEST_ONLY

See Also:

• Constant Field Values

dictionaryFiles

private final String dictionaryFiles

affixFile

private final String affixFile

ignoreCase

private final boolean ignoreCase

longestOnly

private final boolean longestOnly

dictionary

private Dictionary dictionary

Constructor Details

HunspellStemFilterFactory

public HunspellStemFilterFactory(Map<String,String> args)

Creates a new HunspellStemFilterFactory

HunspellStemFilterFactory

public HunspellStemFilterFactory()

Default ctor for compatibility with SPI

Method Details

inform

public void inform(ResourceLoader loader)
            throws IOException

Description copied from interface: ResourceLoaderAware

Initializes this component with the provided ResourceLoader (used for loading classes, files, etc).

Specified by:

inform in interface ResourceLoaderAware

Throws:

IOException

create

public TokenStream create(TokenStream tokenStream)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory