Package org.apache.lucene.analysis.core
Class StopFilterFactory
java.lang.Object
org.apache.lucene.analysis.AbstractAnalysisFactory
org.apache.lucene.analysis.TokenFilterFactory
org.apache.lucene.analysis.en.AbstractWordsFileFilterFactory
org.apache.lucene.analysis.core.StopFilterFactory
- All Implemented Interfaces:
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:
ignoreCasedefaults tofalsewordsshould be the name of a stopwords file to parse, if not specified the factory will useEnglishAnalyzer.ENGLISH_STOP_WORDS_SETformatdefines how thewordsfile will be parsed, and defaults towordset. Ifwordsis not specified, thenformatmust 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 beginning with the "#" character. Blank lines are ignored. SeeWordlistLoader.getLinesfor 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. SeeWordlistLoader.getSnowballWordSetfor details.
- Since:
- 3.1
- SPI Name (case-insensitive: if the name is 'htmlStrip', 'htmlstrip' can be used when looking up the service).
- "stop"
-
Field Summary
FieldsFields inherited from class org.apache.lucene.analysis.en.AbstractWordsFileFilterFactory
FORMAT_SNOWBALL, FORMAT_WORDSETFields inherited from class org.apache.lucene.analysis.AbstractAnalysisFactory
LUCENE_MATCH_VERSION_PARAM, luceneMatchVersion -
Constructor Summary
ConstructorsConstructorDescriptionDefault ctor for compatibility with SPIStopFilterFactory(Map<String, String> args) Creates a new StopFilterFactory -
Method Summary
Modifier and TypeMethodDescriptioncreate(TokenStream input) protected CharArraySetDefault word set implementation.Methods inherited from class org.apache.lucene.analysis.en.AbstractWordsFileFilterFactory
getFormat, getWordFiles, getWords, inform, isIgnoreCaseMethods inherited from class org.apache.lucene.analysis.TokenFilterFactory
availableTokenFilters, findSPIName, forName, lookupClass, normalize, reloadTokenFiltersMethods 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
-
Field Details
-
NAME
SPI name- See Also:
-
-
Constructor Details
-
StopFilterFactory
Creates a new StopFilterFactory -
StopFilterFactory
public StopFilterFactory()Default ctor for compatibility with SPI
-
-
Method Details
-
getStopWords
-
createDefaultWords
Description copied from class:AbstractWordsFileFilterFactoryDefault word set implementation.- Specified by:
createDefaultWordsin classAbstractWordsFileFilterFactory
-
create
- Specified by:
createin classTokenFilterFactory
-