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:
java.io.Closeable
,java.lang.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 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(java.io.Reader stopwords)
Builds an analyzer with the stop words from the given reader.StopAnalyzer(java.nio.file.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(java.lang.String fieldName)
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.protected TokenStream
normalize(java.lang.String fieldName, TokenStream in)
Wrap the givenTokenStream
in order to apply normalization filters.-
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, initReader, initReaderForNormalization, normalize, tokenStream, tokenStream
-
-
-
-
Constructor Detail
-
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(java.nio.file.Path stopwordsFile) throws java.io.IOException
Builds an analyzer with the stop words from the given path.- Parameters:
stopwordsFile
- File to load stop words from- Throws:
java.io.IOException
- See Also:
WordlistLoader.getWordSet(Reader)
-
StopAnalyzer
public StopAnalyzer(java.io.Reader stopwords) throws java.io.IOException
Builds an analyzer with the stop words from the given reader.- Parameters:
stopwords
- Reader to load stop words from- Throws:
java.io.IOException
- See Also:
WordlistLoader.getWordSet(Reader)
-
-
Method Detail
-
createComponents
protected Analyzer.TokenStreamComponents createComponents(java.lang.String fieldName)
CreatesAnalyzer.TokenStreamComponents
used to tokenize all the text in the providedReader
.- Specified by:
createComponents
in classAnalyzer
- Parameters:
fieldName
- the name of the fields content passed to theAnalyzer.TokenStreamComponents
sink as a reader- Returns:
Analyzer.TokenStreamComponents
built from aLetterTokenizer
filtered withStopFilter
-
normalize
protected TokenStream normalize(java.lang.String fieldName, TokenStream in)
Description copied from class:Analyzer
Wrap the givenTokenStream
in order to apply normalization filters. The default implementation returns theTokenStream
as-is. This is used byAnalyzer.normalize(String, String)
.
-
-