Lucene.Net.Analysis.StopAnalyzer Class Reference

Filters LetterTokenizer with LowerCaseFilter and StopFilter. More...

Inherits Lucene.Net.Analysis.Analyzer.

Public Member Functions
	StopAnalyzer (Version matchVersion)
	Builds an analyzer which removes words in ENGLISH_STOP_WORDS.
	StopAnalyzer (Version matchVersion, ISet< string > stopWords)
	Builds an analyzer with the stop words from the given set.
	StopAnalyzer (Version matchVersion, System.IO.FileInfo stopwordsFile)
	Builds an analyzer with the stop words from the given file.
	StopAnalyzer (Version matchVersion, System.IO.TextReader stopwords)
	Builds an analyzer with the stop words from the given reader.
override TokenStream	TokenStream (System.String fieldName, System.IO.TextReader reader)
	Filters LowerCaseTokenizer with StopFilter.
override TokenStream	ReusableTokenStream (System.String fieldName, System.IO.TextReader reader)
Public Member Functions inherited from Lucene.Net.Analysis.Analyzer
abstract TokenStream	TokenStream (String fieldName, System.IO.TextReader reader)
	Creates a TokenStream which tokenizes all the text in the provided Reader. Must be able to handle null field name for backward compatibility.
virtual TokenStream	ReusableTokenStream (String fieldName, System.IO.TextReader reader)
	Creates a TokenStream that is allowed to be re-used from the previous time that the same thread called this method. Callers that do not need to use more than one TokenStream at the same time from this analyzer should use this method for better performance.
virtual int	GetPositionIncrementGap (String fieldName)
	Invoked before indexing a Fieldable instance if terms have already been added to that field. This allows custom analyzers to place an automatic position increment gap between Fieldable instances using the same field name. The default value position increment gap is 0. With a 0 position increment gap and the typical default token position increment of 1, all terms in a field, including across Fieldable instances, are in successive positions, allowing exact PhraseQuery matches, for instance, across Fieldable instance boundaries.
virtual int	GetOffsetGap (IFieldable field)
	Just like GetPositionIncrementGap, except for Token offsets instead. By default this returns 1 for tokenized fields and, as if the fields were joined with an extra space character, and 0 for un-tokenized fields. This method is only called if the field produced at least one token for indexing.
void	Close ()
	Frees persistent resources used by this Analyzer
virtual void	Dispose ()

Static Public Attributes
static ISet< string >	ENGLISH_STOP_WORDS_SET
	An unmodifiable set containing some common English words that are not usually useful for searching.

Additional Inherited Members
Protected Member Functions inherited from Lucene.Net.Analysis.Analyzer
virtual void	Dispose (bool disposing)

Detailed Description

Filters LetterTokenizer with LowerCaseFilter and StopFilter.

You must specify the required Version compatibility when creating StopAnalyzer:

• As of 2.9, position increments are preserved

Definition at line 36 of file StopAnalyzer.cs.

Constructor & Destructor Documentation

Lucene.Net.Analysis.StopAnalyzer.StopAnalyzer

(

Version

matchVersion

)

Builds an analyzer which removes words in ENGLISH_STOP_WORDS.

Definition at line 47 of file StopAnalyzer.cs.

Lucene.Net.Analysis.StopAnalyzer.StopAnalyzer	(	Version	matchVersion,
		ISet< string >	stopWords
	)

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

Definition at line 54 of file StopAnalyzer.cs.

Lucene.Net.Analysis.StopAnalyzer.StopAnalyzer	(	Version	matchVersion,
		System.IO.FileInfo	stopwordsFile
	)

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

See Also

WordlistLoader.GetWordSet(System.IO.FileInfo)

Parameters

matchVersion	See above
stopwordsFile	File to load stop words from

Definition at line 69 of file StopAnalyzer.cs.

Lucene.Net.Analysis.StopAnalyzer.StopAnalyzer	(	Version	matchVersion,
		System.IO.TextReader	stopwords
	)

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

See Also

WordlistLoader.GetWordSet(System.IO.TextReader)

Parameters

matchVersion	See above
stopwords	Reader to load stop words from

Definition at line 82 of file StopAnalyzer.cs.

Member Function Documentation

override TokenStream Lucene.Net.Analysis.StopAnalyzer.ReusableTokenStream	(	System.String	fieldName,
		System.IO.TextReader	reader
	)

Definition at line 118 of file StopAnalyzer.cs.

override TokenStream Lucene.Net.Analysis.StopAnalyzer.TokenStream	(	System.String	fieldName,
		System.IO.TextReader	reader
	)

Filters LowerCaseTokenizer with StopFilter.

Definition at line 89 of file StopAnalyzer.cs.

Member Data Documentation

ISet<string> Lucene.Net.Analysis.StopAnalyzer.ENGLISH_STOP_WORDS_SET

static

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

Definition at line 44 of file StopAnalyzer.cs.

---

The documentation for this class was generated from the following file:

• core/Analysis/StopAnalyzer.cs