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

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

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

protected ReusableAnalyzerBase.TokenStreamComponents	createComponents(String fieldName, Reader reader) Creates a ReusableAnalyzerBase.TokenStreamComponents which tokenizes all the text in the provided Reader.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 version

stopwords - 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 a KeywordMarkerFilter before stemming.

Parameters:

matchVersion - lucene compatibility version

stopwords - a stopword set

stemExclusionSet - 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 a ReusableAnalyzerBase.TokenStreamComponents which tokenizes all the text in the provided Reader.

Specified by:

createComponents in class ReusableAnalyzerBase

Parameters:

fieldName - the name of the fields content passed to the ReusableAnalyzerBase.TokenStreamComponents sink as a reader

reader - the reader passed to the Tokenizer constructor

Returns:

A ReusableAnalyzerBase.TokenStreamComponents built from an StandardTokenizer filtered with StandardFilter, LowerCaseFilter, StopFilter , KeywordMarkerFilter if a stem exclusion set is provided and PorterStemFilter.