Package org.apache.lucene.analysis.en
Class EnglishAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.ReusableAnalyzerBase
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.en.EnglishAnalyzer
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
public final class EnglishAnalyzer extends StopwordAnalyzerBase
Analyzer
for English.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase
ReusableAnalyzerBase.TokenStreamComponents
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
matchVersion, stopwords
-
-
Constructor Summary
Constructors Constructor Description EnglishAnalyzer(Version matchVersion)
Builds an analyzer with the default stop words:getDefaultStopSet()
.EnglishAnalyzer(Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop words.EnglishAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)
Builds an analyzer with the given stop words.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected ReusableAnalyzerBase.TokenStreamComponents
createComponents(String fieldName, Reader reader)
Creates aReusableAnalyzerBase.TokenStreamComponents
which tokenizes all the text in the providedReader
.static Set<?>
getDefaultStopSet()
Returns an unmodifiable instance of the default stop words set.-
Methods inherited from class org.apache.lucene.analysis.StopwordAnalyzerBase
getStopwordSet, loadStopwordSet, loadStopwordSet, loadStopwordSet
-
Methods inherited from class org.apache.lucene.analysis.ReusableAnalyzerBase
initReader, reusableTokenStream, tokenStream
-
Methods inherited from class org.apache.lucene.analysis.Analyzer
close, getOffsetGap, getPositionIncrementGap, getPreviousTokenStream, setPreviousTokenStream
-
-
-
-
Constructor Detail
-
EnglishAnalyzer
public EnglishAnalyzer(Version matchVersion)
Builds an analyzer with the default stop words:getDefaultStopSet()
.
-
EnglishAnalyzer
public EnglishAnalyzer(Version matchVersion, Set<?> stopwords)
Builds an analyzer with the given stop words.- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword set
-
EnglishAnalyzer
public EnglishAnalyzer(Version matchVersion, Set<?> stopwords, Set<?> stemExclusionSet)
Builds an analyzer with the given stop words. If a non-empty stem exclusion set is provided this analyzer will add aKeywordMarkerFilter
before stemming.- Parameters:
matchVersion
- lucene compatibility versionstopwords
- a stopword setstemExclusionSet
- a set of terms not to be stemmed
-
-
Method Detail
-
getDefaultStopSet
public static Set<?> getDefaultStopSet()
Returns an unmodifiable instance of the default stop words set.- Returns:
- default stop words set.
-
createComponents
protected ReusableAnalyzerBase.TokenStreamComponents createComponents(String fieldName, Reader reader)
Creates aReusableAnalyzerBase.TokenStreamComponents
which tokenizes all the text in the providedReader
.- Specified by:
createComponents
in classReusableAnalyzerBase
- Parameters:
fieldName
- the name of the fields content passed to theReusableAnalyzerBase.TokenStreamComponents
sink as a readerreader
- the reader passed to theTokenizer
constructor- Returns:
- A
ReusableAnalyzerBase.TokenStreamComponents
built from anStandardTokenizer
filtered withStandardFilter
,LowerCaseFilter
,StopFilter
,KeywordMarkerFilter
if a stem exclusion set is provided andPorterStemFilter
.
-
-