blob: 7535a6e228e7521cca8e65eadb3b57c8cd81d56c [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace Lucene.Net.Analysis.Fr
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Analysis.Fr
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="analysis-common/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.Analysis.Fr">
<h1 id="Lucene_Net_Analysis_Fr" data-uid="Lucene.Net.Analysis.Fr" class="text-break">Namespace Lucene.Net.Analysis.Fr
</h1>
<div class="markdown level0 summary"><!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<p>Analyzer for French.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchAnalyzer.html">FrenchAnalyzer</a></h4>
<section><p><span class="xref">Lucene.Net.Analysis.Analyzer</span> for French language.
<p>
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.
</p>
<p>You must specify the required <span class="xref">Lucene.Net.Util.LuceneVersion</span>
compatibility when creating FrenchAnalyzer:
<ul><li> As of 3.6, <a class="xref" href="Lucene.Net.Analysis.Fr.FrenchLightStemFilter.html">FrenchLightStemFilter</a> is used for less aggressive stemming.</li><li> As of 3.1, Snowball stemming is done with <a class="xref" href="Lucene.Net.Analysis.Snowball.SnowballFilter.html">SnowballFilter</a>,
<a class="xref" href="Lucene.Net.Analysis.Core.LowerCaseFilter.html">LowerCaseFilter</a> is used prior to <a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html">StopFilter</a>, and <a class="xref" href="Lucene.Net.Analysis.Util.ElisionFilter.html">ElisionFilter</a> and
Snowball stopwords are used by default.</li><li> As of 2.9, <a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html">StopFilter</a> preserves position
increments</li></ul></p>
<p>
<p><strong>NOTE</strong>: This class uses the same <span class="xref">Lucene.Net.Util.LuceneVersion</span>
dependent settings as <a class="xref" href="Lucene.Net.Analysis.Standard.StandardAnalyzer.html">StandardAnalyzer</a>.</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchLightStemFilter.html">FrenchLightStemFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that applies <a class="xref" href="Lucene.Net.Analysis.Fr.FrenchLightStemmer.html">FrenchLightStemmer</a> to stem French
words.
<p>
To prevent terms from being stemmed use an instance of
<a class="xref" href="Lucene.Net.Analysis.Miscellaneous.SetKeywordMarkerFilter.html">SetKeywordMarkerFilter</a> or a custom <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that sets
the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a> before this <span class="xref">Lucene.Net.Analysis.TokenStream</span>.
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchLightStemFilterFactory.html">FrenchLightStemFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Fr.FrenchLightStemFilter.html">FrenchLightStemFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_frlgtstem&quot; class=&quot;solr.TextField&quot; positionIncrementGap=&quot;100&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.StandardTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.LowerCaseFilterFactory&quot;/>
&lt;filter class=&quot;solr.ElisionFilterFactory&quot;/>
&lt;filter class=&quot;solr.FrenchLightStemFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchLightStemmer.html">FrenchLightStemmer</a></h4>
<section><p>Light Stemmer for French.
<p>
This stemmer implements the &quot;UniNE&quot; algorithm in:
<code>Light Stemming Approaches for the French, Portuguese, German and Hungarian Languages</code>
Jacques Savoy
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchMinimalStemFilter.html">FrenchMinimalStemFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that applies <a class="xref" href="Lucene.Net.Analysis.Fr.FrenchMinimalStemmer.html">FrenchMinimalStemmer</a> to stem French
words.
<p>
To prevent terms from being stemmed use an instance of
<a class="xref" href="Lucene.Net.Analysis.Miscellaneous.SetKeywordMarkerFilter.html">SetKeywordMarkerFilter</a> or a custom <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that sets
the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a> before this <span class="xref">Lucene.Net.Analysis.TokenStream</span>.
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchMinimalStemFilterFactory.html">FrenchMinimalStemFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.Fr.FrenchMinimalStemFilter.html">FrenchMinimalStemFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_frminstem&quot; class=&quot;solr.TextField&quot; positionIncrementGap=&quot;100&quot;>
&lt;analyzer>
&lt;tokenizer class=&quot;solr.StandardTokenizerFactory&quot;/>
&lt;filter class=&quot;solr.LowerCaseFilterFactory&quot;/>
&lt;filter class=&quot;solr.ElisionFilterFactory&quot;/>
&lt;filter class=&quot;solr.FrenchMinimalStemFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchMinimalStemmer.html">FrenchMinimalStemmer</a></h4>
<section><p>Light Stemmer for French.
<p>
This stemmer implements the following algorithm:
<code>A Stemming procedure and stopword list for general French corpora.</code>
Jacques Savoy.
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchStemFilter.html">FrenchStemFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that stems french words.
<p>
The used stemmer can be changed at runtime after the
filter object is created (as long as it is a <a class="xref" href="Lucene.Net.Analysis.Fr.FrenchStemmer.html">FrenchStemmer</a>).
</p>
<p>
To prevent terms from being stemmed use an instance of
<a class="xref" href="Lucene.Net.Analysis.Miscellaneous.KeywordMarkerFilter.html">KeywordMarkerFilter</a> or a custom <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that sets
the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a> before this <span class="xref">Lucene.Net.Analysis.TokenStream</span>.
</p> </p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchStemmer.html">FrenchStemmer</a></h4>
<section><p>A stemmer for French words.
<p>
The algorithm is based on the work of
Dr Martin Porter on his snowball project<p>
refer to <a href="http://snowball.sourceforge.net/french/stemmer.html">http://snowball.sourceforge.net/french/stemmer.html</a>
(French stemming algorithm) for details</p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/blob/docs/4.8.0-beta00010/src/Lucene.Net.Analysis.Common/Analysis/Fr/package.md/#L2" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 Licensed to the Apache Software Foundation (ASF)
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>