Class StopAnalyzer

Filters LetterTokenizer with LowerCaseFilter and StopFilter.

You must specify the required Lucene.Net.Util.LuceneVersion compatibility when creating StopAnalyzer:

  • As of 3.1, StopFilter correctly handles Unicode 4.0 supplementary characters in stopwords
  • As of 2.9, position increments are preserved
Inheritance
object
Analyzer
StopwordAnalyzerBase
StopAnalyzer
Implements
Inherited Members
Analyzer.Strategy
Analyzer.Dispose()
Analyzer.GLOBAL_REUSE_STRATEGY
Analyzer.PER_FIELD_REUSE_STRATEGY
Namespace: Lucene.Net.Analysis.Core
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class StopAnalyzer : StopwordAnalyzerBase, IDisposable

Constructors

StopAnalyzer(LuceneVersion)

Builds an analyzer which removes words in ENGLISH_STOP_WORDS_SET.

Declaration
public StopAnalyzer(LuceneVersion matchVersion)
Parameters
Type Name Description
LuceneVersion matchVersion

See Lucene.Net.Util.LuceneVersion

StopAnalyzer(LuceneVersion, CharArraySet)

Builds an analyzer with the stop words from the given set.

Declaration
public StopAnalyzer(LuceneVersion matchVersion, CharArraySet stopWords)
Parameters
Type Name Description
LuceneVersion matchVersion

See Lucene.Net.Util.LuceneVersion
CharArraySet stopWords

Set of stop words

StopAnalyzer(LuceneVersion, FileInfo)

Builds an analyzer with the stop words from the given file.

Declaration
public StopAnalyzer(LuceneVersion matchVersion, FileInfo stopwordsFile)
Parameters
Type Name Description
LuceneVersion matchVersion

See Lucene.Net.Util.LuceneVersion
FileInfo stopwordsFile

File to load stop words from
See Also
GetWordSet(TextReader, LuceneVersion)

StopAnalyzer(LuceneVersion, TextReader)

Builds an analyzer with the stop words from the given reader.

Declaration
public StopAnalyzer(LuceneVersion matchVersion, TextReader stopwords)
Parameters
Type Name Description
LuceneVersion matchVersion

See Lucene.Net.Util.LuceneVersion
TextReader stopwords

TextReader to load stop words from
See Also
GetWordSet(TextReader, LuceneVersion)

Fields

ENGLISH_STOP_WORDS_SET

An unmodifiable set containing some common English words that are not usually useful for searching.

Declaration
public static readonly CharArraySet ENGLISH_STOP_WORDS_SET
Field Value
Type Description
CharArraySet

Methods

CreateComponents(string, TextReader)

Creates Lucene.Net.Analysis.TokenStreamComponents used to tokenize all the text in the provided TextReader.

Declaration
protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
Parameters
Type Name Description
string fieldName
TextReader reader
Returns
Type Description
TokenStreamComponents

Lucene.Net.Analysis.TokenStreamComponents built from a LowerCaseTokenizer filtered with StopFilter
Overrides

Implements