| <!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-beta00008 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Namespace Lucene.Net.Analysis.En |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation "> |
| <meta name="generator" content="docfx 2.50.0.0"> |
| |
| <link rel="shortcut icon" href="../../logo/favicon.ico"> |
| <link rel="stylesheet" href="../../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../../styles/docfx.css"> |
| <link rel="stylesheet" href="../../styles/main.css"> |
| <meta property="docfx:navrel" content="../../toc.html"> |
| <meta property="docfx:tocrel" content="../toc.html"> |
| |
| <meta property="docfx:rel" content="../../"> |
| |
| </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="../../index.html"> |
| <img id="logo" class="svg" src="../../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" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></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><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.Analyzer.html">Analyzer</a> for English.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Analysis.En.EnglishMinimalStemFilter.html">EnglishMinimalStemFilter</a></h4> |
| <section><p>A <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenFilter.html">TokenFilter</a> 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 <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenFilter.html">TokenFilter</a> that sets |
| the <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a> before this <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a>. |
| </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><fieldType name="text_enminstem" class="solr.TextField" positionIncrementGap="100"> |
| <analyzer> |
| <tokenizer class="solr.StandardTokenizerFactory"/> |
| <filter class="solr.LowerCaseFilterFactory"/> |
| <filter class="solr.EnglishMinimalStemFilterFactory"/> |
| </analyzer> |
| </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 "S-Stemmer" 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 's) from words. |
| <p>You must specify the required <a class="xref" href="../Lucene.Net/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a> |
| 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><fieldType name="text_enpossessive" class="solr.TextField" positionIncrementGap="100"> |
| <analyzer> |
| <tokenizer class="solr.StandardTokenizerFactory"/> |
| <filter class="solr.LowerCaseFilterFactory"/> |
| <filter class="solr.EnglishPossessiveFilterFactory"/> |
| </analyzer> |
| </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"> |
| "Viewing Morphology as an Inference Process"</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="../Lucene.Net/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a>. To prevent |
| certain terms from being passed to the stemmer |
| <a class="xref" href="../Lucene.Net/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 <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a>. |
| |
| 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><fieldType name="text_kstem" class="solr.TextField" positionIncrementGap="100"> |
| <analyzer> |
| <tokenizer class="solr.StandardTokenizerFactory"/> |
| <filter class="solr.LowerCaseFilterFactory"/> |
| <filter class="solr.KStemFilterFactory"/> |
| </analyzer> |
| </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'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'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="../Lucene.Net/Lucene.Net.Analysis.TokenAttributes.KeywordAttribute.html">KeywordAttribute</a>. To prevent |
| certain terms from being passed to the stemmer |
| <a class="xref" href="../Lucene.Net/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 <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a>. |
| |
| 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><fieldType name="text_porterstem" class="solr.TextField" positionIncrementGap="100"> |
| <analyzer> |
| <tokenizer class="solr.StandardTokenizerFactory"/> |
| <filter class="solr.LowerCaseFilterFactory"/> |
| <filter class="solr.PorterStemFilterFactory"/> |
| </analyzer> |
| </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-beta00008/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 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="../../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../../styles/docfx.js"></script> |
| <script type="text/javascript" src="../../styles/main.js"></script> |
| </body> |
| </html> |