org.apache.lucene.analysis.core
Class StopFilterFactory
java.lang.Object
org.apache.lucene.analysis.util.AbstractAnalysisFactory
org.apache.lucene.analysis.util.TokenFilterFactory
org.apache.lucene.analysis.core.StopFilterFactory
- All Implemented Interfaces:
- ResourceLoaderAware
public class StopFilterFactory
- extends TokenFilterFactory
- implements ResourceLoaderAware
Factory for StopFilter
.
<fieldType name="text_stop" class="solr.TextField" positionIncrementGap="100" autoGeneratePhraseQueries="true">
<analyzer>
<tokenizer class="solr.WhitespaceTokenizerFactory"/>
<filter class="solr.StopFilterFactory" ignoreCase="true"
words="stopwords.txt" format="wordset" />
</analyzer>
</fieldType>
All attributes are optional:
ignoreCase
defaults to false
words
should be the name of a stopwords file to parse, if not
specified the factory will use StopAnalyzer.ENGLISH_STOP_WORDS_SET
format
defines how the words
file will be parsed,
and defaults to wordset
. If words
is not specified,
then format
must not be specified.
The valid values for the format
option are:
wordset
- This is the default format, which supports one word per
line (including any intra-word whitespace) and allows whole line comments
begining with the "#" character. Blank lines are ignored. See
WordlistLoader.getLines
for details.
snowball
- This format allows for multiple words specified on each
line, and trailing comments may be specified using the vertical line ("|").
Blank lines are ignored. See
WordlistLoader.getSnowballWordSet
for details.
Methods inherited from class org.apache.lucene.analysis.util.AbstractAnalysisFactory |
assureMatchVersion, 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, splitFileNames |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
FORMAT_WORDSET
public static final String FORMAT_WORDSET
- See Also:
- Constant Field Values
FORMAT_SNOWBALL
public static final String FORMAT_SNOWBALL
- See Also:
- Constant Field Values
StopFilterFactory
public StopFilterFactory(Map<String,String> args)
- Creates a new StopFilterFactory
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
isEnablePositionIncrements
public boolean isEnablePositionIncrements()
isIgnoreCase
public boolean isIgnoreCase()
getStopWords
public CharArraySet getStopWords()
create
public TokenStream create(TokenStream input)
- Description copied from class:
TokenFilterFactory
- Transform the specified input TokenStream
- Specified by:
create
in class TokenFilterFactory
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.