Class FrenchAnalyzer

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 LuceneVersion compatibility when creating FrenchAnalyzer:

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

Inheritance
System.Object
Analyzer
StopwordAnalyzerBase
FrenchAnalyzer
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Analysis.Fr
Assembly: Lucene.Net.Analysis.Common.dll
Syntax
public sealed class FrenchAnalyzer : StopwordAnalyzerBase, IDisposable

Constructors

| Improve this Doc View Source

FrenchAnalyzer(LuceneVersion)

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

Declaration
public FrenchAnalyzer(LuceneVersion matchVersion)
Parameters
Type Name Description
LuceneVersion matchVersion
| Improve this Doc View Source

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

| Improve this Doc View Source

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

| Improve this Doc View Source

DEFAULT_ARTICLES

Default set of articles for ElisionFilter

Declaration
public static readonly CharArraySet DEFAULT_ARTICLES
Field Value
Type Description
CharArraySet
| Improve this Doc View Source

DEFAULT_STOPWORD_FILE

File containing default French stopwords.

Declaration
public const string DEFAULT_STOPWORD_FILE = "french_stop.txt"
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

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

| Improve this Doc View Source

CreateComponents(String, TextReader)

Creates TokenStreamComponents used to tokenize all the text in the provided System.IO.TextReader.

Declaration
protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader)
Parameters
Type Name Description
System.String fieldName
System.IO.TextReader reader
Returns
Type Description
TokenStreamComponents TokenStreamComponents built from a StandardTokenizer filtered with StandardFilter, ElisionFilter, LowerCaseFilter, StopFilter, SetKeywordMarkerFilter if a stem exclusion set is provided, and FrenchLightStemFilter
Overrides

Implements

System.IDisposable