blob: c39d91c722ccf95babd8a50b27996746e47d8b28 [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.En
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Lucene.Net.Analysis.En
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.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">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<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.En">
<h1 id="Lucene_Net_Analysis_En" data-uid="Lucene.Net.Analysis.En" class="text-break">Namespace Lucene.Net.Analysis.En
</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 English.</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.En.EnglishAnalyzer.html">EnglishAnalyzer</a></h4>
<section><p><span class="xref">Lucene.Net.Analysis.Analyzer</span> for English.</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.EnglishMinimalStemFilter.html">EnglishMinimalStemFilter</a></h4>
<section><p>A <span class="xref">Lucene.Net.Analysis.TokenFilter</span> that applies <a class="xref" href="Lucene.Net.Analysis.En.EnglishMinimalStemmer.html">EnglishMinimalStemmer</a> to stem
English 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="https://lucenenet.apache.org/docs/4.8.0-beta00013/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.En.EnglishMinimalStemFilterFactory.html">EnglishMinimalStemFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.En.EnglishMinimalStemFilter.html">EnglishMinimalStemFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_enminstem&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.EnglishMinimalStemFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.EnglishMinimalStemmer.html">EnglishMinimalStemmer</a></h4>
<section><p>Minimal plural stemmer for English.
<p>
This stemmer implements the &quot;S-Stemmer&quot; from
<code>How Effective Is Suffixing?</code>
Donna Harman.
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.EnglishPossessiveFilter.html">EnglishPossessiveFilter</a></h4>
<section><p>TokenFilter that removes possessives (trailing &apos;s) from words.
<p>You must specify the required <span class="xref">Lucene.Net.Util.LuceneVersion</span>
compatibility when creating <a class="xref" href="Lucene.Net.Analysis.En.EnglishPossessiveFilter.html">EnglishPossessiveFilter</a>:
<ul><li> As of 3.6, U+2019 RIGHT SINGLE QUOTATION MARK and
U+FF07 FULLWIDTH APOSTROPHE are also treated as
quotation marks.</li></ul>
</p></p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.EnglishPossessiveFilterFactory.html">EnglishPossessiveFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.En.EnglishPossessiveFilter.html">EnglishPossessiveFilter</a>. </p>
<pre><code>&lt;fieldType name=&quot;text_enpossessive&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.EnglishPossessiveFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.KStemFilter.html">KStemFilter</a></h4>
<section><p>A high-performance kstem filter for english.
<p>
See <a href="http://ciir.cs.umass.edu/pubfiles/ir-35.pdf">
&quot;Viewing Morphology as an Inference Process&quot;</a>
(Krovetz, R., Proceedings of the Sixteenth Annual International ACM SIGIR
Conference on Research and Development in Information Retrieval, 191-203, 1993).
<p>
All terms must already be lowercased for this filter to work correctly.</p>
<p>
Note: This filter is aware of the <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a>. To prevent
certain terms from being passed to the stemmer
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html#Lucene_Net_Analysis_TokenAttributes_KeywordAttribute_IsKeyword">IsKeyword</a> should be set to <pre><code>true</code></pre>
in a previous <span class="xref">Lucene.Net.Analysis.TokenStream</span>.
Note: For including the original term as well as the stemmed version, see
<a class="xref" href="Lucene.Net.Analysis.Miscellaneous.KeywordRepeatFilterFactory.html">KeywordRepeatFilterFactory</a>
</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.KStemFilterFactory.html">KStemFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.En.KStemFilter.html">KStemFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_kstem&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.KStemFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.KStemmer.html">KStemmer</a></h4>
<section><p>This class implements the Kstem algorithm</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.PorterStemFilter.html">PorterStemFilter</a></h4>
<section><p>Transforms the token stream as per the Porter stemming algorithm.
<p>
Note: the input to the stemming filter must already be in lower case,
so you will need to use LowerCaseFilter or LowerCaseTokenizer farther
down the Tokenizer chain in order for this to work properly!
<p>
To use this filter with other analyzers, you&apos;ll want to write an
Analyzer class that sets up the TokenStream chain as you want it.
To use this with LowerCaseTokenizer, for example, you&apos;d write an
analyzer like this:
<p>
<pre><code>class MyAnalyzer : Analyzer {
protected override TokenStreamComponents CreateComponents(string fieldName, TextReader reader) {
Tokenizer source = new LowerCaseTokenizer(version, reader);
return new TokenStreamComponents(source, new PorterStemFilter(source));
}
}</code></pre>
<p>
Note: This filter is aware of the <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a>. To prevent
certain terms from being passed to the stemmer
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html#Lucene_Net_Analysis_TokenAttributes_KeywordAttribute_IsKeyword">IsKeyword</a> should be set to <pre><code>true</code></pre>
in a previous <span class="xref">Lucene.Net.Analysis.TokenStream</span>.
Note: For including the original term as well as the stemmed version, see
<a class="xref" href="Lucene.Net.Analysis.Miscellaneous.KeywordRepeatFilterFactory.html">KeywordRepeatFilterFactory</a>
</p>
</section>
<h4><a class="xref" href="Lucene.Net.Analysis.En.PorterStemFilterFactory.html">PorterStemFilterFactory</a></h4>
<section><p>Factory for <a class="xref" href="Lucene.Net.Analysis.En.PorterStemFilter.html">PorterStemFilter</a>.</p>
<pre><code>&lt;fieldType name=&quot;text_porterstem&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.PorterStemFilterFactory&quot;/>
&lt;/analyzer>
&lt;/fieldType></code></pre>
</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-beta00013/src/Lucene.Net.Analysis.Common/Analysis/En/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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</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>