org.apache.lucene.analysis.snowball

Class SnowballPorterFilterFactory

java.lang.Object

org.apache.lucene.analysis.util.AbstractAnalysisFactory

org.apache.lucene.analysis.util.TokenFilterFactory

org.apache.lucene.analysis.snowball.SnowballPorterFilterFactory

All Implemented Interfaces:

ResourceLoaderAware

public class SnowballPorterFilterFactory
extends TokenFilterFactory
implements ResourceLoaderAware

Factory for SnowballFilter, with configurable language

Note: Use of the "Lovins" stemmer is not recommended, as it is implemented with reflection.

 <fieldType name="text_snowballstem" class="solr.TextField" positionIncrementGap="100">
   <analyzer>
     <tokenizer class="solr.StandardTokenizerFactory"/>
     <filter class="solr.LowerCaseFilterFactory"/>
     <filter class="solr.SnowballPorterFilterFactory" protected="protectedkeyword.txt" language="English"/>
   </analyzer>
 </fieldType>

Since:

3.1

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	language
static java.lang.String	NAME SPI name
static java.lang.String	PROTECTED_TOKENS
private CharArraySet	protectedWords
private java.lang.Class<? extends SnowballProgram>	stemClass
private java.lang.String	wordFiles

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

LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion

Constructor Summary

Constructors

Constructor and Description
SnowballPorterFilterFactory(java.util.Map<java.lang.String,java.lang.String> args) Creates a new SnowballPorterFilterFactory

Method Summary

Modifier and Type	Method and Description
TokenFilter	create(TokenStream input) 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.util.TokenFilterFactory

availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFilters

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

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 Detail

NAME

public static final java.lang.String NAME

SPI name

See Also:

Constant Field Values

PROTECTED_TOKENS

public static final java.lang.String PROTECTED_TOKENS

See Also:

Constant Field Values

language

private final java.lang.String language

wordFiles

private final java.lang.String wordFiles

stemClass

private java.lang.Class<? extends SnowballProgram> stemClass

protectedWords

private CharArraySet protectedWords

Constructor Detail

SnowballPorterFilterFactory

public SnowballPorterFilterFactory(java.util.Map<java.lang.String,java.lang.String> args)

Creates a new SnowballPorterFilterFactory

Method Detail

inform

public void inform(ResourceLoader loader)
            throws java.io.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:

java.io.IOException

create

public TokenFilter create(TokenStream input)

Description copied from class: TokenFilterFactory

Transform the specified input TokenStream

Specified by:

create in class TokenFilterFactory