Package org.apache.lucene.analysis.en
Class EnglishAnalyzer
- java.lang.Object
-
- org.apache.lucene.analysis.Analyzer
-
- org.apache.lucene.analysis.StopwordAnalyzerBase
-
- org.apache.lucene.analysis.en.EnglishAnalyzer
-
- All Implemented Interfaces:
Closeable,AutoCloseable
public final class EnglishAnalyzer extends StopwordAnalyzerBase
Analyzerfor English.- 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 CharArraySetENGLISH_STOP_WORDS_SETAn unmodifiable set containing some common English words that are not usually useful for searching.-
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 EnglishAnalyzer()Builds an analyzer with the default stop words:getDefaultStopSet().EnglishAnalyzer(CharArraySet stopwords)Builds an analyzer with the given stop words.EnglishAnalyzer(CharArraySet stopwords, CharArraySet 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 Analyzer.TokenStreamComponentscreateComponents(String fieldName)Creates aAnalyzer.TokenStreamComponentswhich tokenizes all the text in the providedReader.static CharArraySetgetDefaultStopSet()Returns an unmodifiable instance of the default stop words set.protected TokenStreamnormalize(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, initReader, initReaderForNormalization, normalize, tokenStream, tokenStream
-
-
-
-
Field Detail
-
ENGLISH_STOP_WORDS_SET
public static final CharArraySet ENGLISH_STOP_WORDS_SET
An unmodifiable set containing some common English words that are not usually useful for searching.
-
-
Constructor Detail
-
EnglishAnalyzer
public EnglishAnalyzer()
Builds an analyzer with the default stop words:getDefaultStopSet().
-
EnglishAnalyzer
public EnglishAnalyzer(CharArraySet stopwords)
Builds an analyzer with the given stop words.- Parameters:
stopwords- a stopword set
-
EnglishAnalyzer
public EnglishAnalyzer(CharArraySet stopwords, CharArraySet stemExclusionSet)
Builds an analyzer with the given stop words. If a non-empty stem exclusion set is provided this analyzer will add aSetKeywordMarkerFilterbefore stemming.- Parameters:
stopwords- a stopword setstemExclusionSet- a set of terms not to be stemmed
-
-
Method Detail
-
getDefaultStopSet
public static CharArraySet getDefaultStopSet()
Returns an unmodifiable instance of the default stop words set.- Returns:
- default stop words set.
-
createComponents
protected Analyzer.TokenStreamComponents createComponents(String fieldName)
Creates aAnalyzer.TokenStreamComponentswhich tokenizes all the text in the providedReader.- Specified by:
createComponentsin classAnalyzer- Returns:
- A
Analyzer.TokenStreamComponentsbuilt from anStandardTokenizerfiltered withEnglishPossessiveFilter,LowerCaseFilter,StopFilter,SetKeywordMarkerFilterif a stem exclusion set is provided andPorterStemFilter.
-
normalize
protected TokenStream normalize(String fieldName, TokenStream in)
-
-