Class FrenchAnalyzer

Lucene.Net.Analysis.Analyzer for French language.

Supports an external list of stopwords (words that will not be indexed at all) and an external list of exclusions (word that will not be stemmed, but indexed). A default set of stopwords is used unless an alternative list is specified, but the exclusion list is empty by default.

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

• As of 3.6, FrenchLightStemFilter is used for less aggressive stemming.
• As of 3.1, Snowball stemming is done with SnowballFilter, LowerCaseFilter is used prior to StopFilter, and ElisionFilter and Snowball stopwords are used by default.
• As of 2.9, StopFilter preserves position increments

NOTE: This class uses the same Lucene.Net.Util.LuceneVersion dependent settings as StandardAnalyzer.

Inheritance

object

Analyzer

StopwordAnalyzerBase

FrenchAnalyzer

Implements

IDisposable

Inherited Members

StopwordAnalyzerBase.StopwordSet

Analyzer.NewAnonymous(Func<string, TextReader, TokenStreamComponents>)

Analyzer.NewAnonymous(Func<string, TextReader, TokenStreamComponents>, ReuseStrategy)

Analyzer.NewAnonymous(Func<string, TextReader, TokenStreamComponents>, Func<string, TextReader, TextReader>)

Analyzer.NewAnonymous(Func<string, TextReader, TokenStreamComponents>, Func<string, TextReader, TextReader>, ReuseStrategy)

Analyzer.GetTokenStream(string, TextReader)

Analyzer.GetTokenStream(string, string)

Analyzer.GetPositionIncrementGap(string)

Analyzer.GetOffsetGap(string)

Analyzer.Strategy

Analyzer.Dispose()

Analyzer.GLOBAL_REUSE_STRATEGY

Analyzer.PER_FIELD_REUSE_STRATEGY

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Analysis.Fr

Assembly: Lucene.Net.Analysis.Common.dll

Syntax

public sealed class FrenchAnalyzer : StopwordAnalyzerBase, IDisposable

Constructors

FrenchAnalyzer(LuceneVersion)

Builds an analyzer with the default stop words (DefaultStopSet).

Declaration

public FrenchAnalyzer(LuceneVersion matchVersion)

Parameters

Type	Name	Description
LuceneVersion	matchVersion

FrenchAnalyzer(LuceneVersion, CharArraySet)

Builds an analyzer with the given stop words

Declaration

public FrenchAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords)

Parameters

Type	Name	Description
LuceneVersion	matchVersion	lucene compatibility version
CharArraySet	stopwords	a stopword set

FrenchAnalyzer(LuceneVersion, CharArraySet, CharArraySet)

Builds an analyzer with the given stop words

Declaration

public FrenchAnalyzer(LuceneVersion matchVersion, CharArraySet stopwords, CharArraySet stemExclutionSet)

Parameters

Type	Name	Description
LuceneVersion	matchVersion	lucene compatibility version
CharArraySet	stopwords	a stopword set
CharArraySet	stemExclutionSet	a stemming exclusion set

Fields

DEFAULT_ARTICLES

Default set of articles for ElisionFilter

Declaration

public static readonly CharArraySet DEFAULT_ARTICLES

Field Value

Type	Description
CharArraySet

DEFAULT_STOPWORD_FILE

File containing default French stopwords.

Declaration

public const string DEFAULT_STOPWORD_FILE = "french_stop.txt"

Field Value

Type	Description
string

Properties

DefaultStopSet

Returns an unmodifiable instance of the default stop-words set.

Declaration

public static CharArraySet DefaultStopSet { get; }

Property Value

Type	Description
CharArraySet	an unmodifiable instance of the default stop-words set.

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 StandardTokenizer filtered with StandardFilter, ElisionFilter, LowerCaseFilter, StopFilter, SetKeywordMarkerFilter if a stem exclusion set is provided, and FrenchLightStemFilter

Overrides

Analyzer.CreateComponents(string, TextReader)

Implements

IDisposable