Package org.apache.lucene.analysis.core
Class StopAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.core.StopAnalyzer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class StopAnalyzer extends StopwordAnalyzerBase
- Since:
- 3.1
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.analysis.Analyzer
Analyzer.ReuseStrategy, Analyzer.TokenStreamComponents
-
-
Field Summary
Fields Modifier and Type Field Description static CharArraySet
ENGLISH_STOP_WORDS_SET
Deprecated.-
Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
stopwords
-
Fields inherited from class org.apache.lucene.analysis.Analyzer
GLOBAL_REUSE_STRATEGY, PER_FIELD_REUSE_STRATEGY
-
-
Constructor Summary
Constructors Constructor Description StopAnalyzer()
Deprecated.Use a constructor with a specific stop word setStopAnalyzer(Reader stopwords)
Builds an analyzer with the stop words from the given reader.StopAnalyzer(Path stopwordsFile)
Builds an analyzer with the stop words from the given path.StopAnalyzer(CharArraySet stopWords)
Builds an analyzer with the stop words from the given set.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Analyzer.TokenStreamComponents
createComponents(String fieldName)
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.protected TokenStream
normalize(String fieldName, TokenStream in)
-
Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet
-
Methods inherited from class org.apache.lucene.analysis.Analyzer
attributeFactory, close, getOffsetGap, getPositionIncrementGap, getReuseStrategy, getVersion, initReader, initReaderForNormalization, normalize, setVersion, tokenStream, tokenStream
-
-
-
-
Field Detail
-
ENGLISH_STOP_WORDS_SET
@Deprecated public static final CharArraySet ENGLISH_STOP_WORDS_SET
Deprecated.An unmodifiable set containing some common English words that are not usually useful for searching.
-
-
Constructor Detail
-
StopAnalyzer
@Deprecated public StopAnalyzer()
Deprecated.Use a constructor with a specific stop word setBuilds an analyzer which removes words inENGLISH_STOP_WORDS_SET
.
-
StopAnalyzer
public StopAnalyzer(CharArraySet stopWords)
Builds an analyzer with the stop words from the given set.- Parameters:
stopWords
- Set of stop words
-
StopAnalyzer
public StopAnalyzer(Path stopwordsFile) throws IOException
Builds an analyzer with the stop words from the given path.- Parameters:
stopwordsFile
- File to load stop words from- Throws:
IOException
- See Also:
WordlistLoader.getWordSet(Reader)
-
StopAnalyzer
public StopAnalyzer(Reader stopwords) throws IOException
Builds an analyzer with the stop words from the given reader.- Parameters:
stopwords
- Reader to load stop words from- Throws:
IOException
- See Also:
WordlistLoader.getWordSet(Reader)
-
-
Method Detail
-
createComponents
protected Analyzer.TokenStreamComponents createComponents(String fieldName)
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classAnalyzer
- Returns:
Analyzer.TokenStreamComponents
built from aLowerCaseTokenizer
filtered withStopFilter
-
normalize
protected TokenStream normalize(String fieldName, TokenStream in)
-
-