| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class StopFilter |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class StopFilter |
| | 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.Core.StopFilter"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Core_StopFilter" data-uid="Lucene.Net.Analysis.Core.StopFilter" class="text-break">Class StopFilter |
| </h1> |
| <div class="markdown level0 summary"><p>Removes stop words from a token stream. |
| <p> |
| You must specify the required <span class="xref">Lucene.Net.Util.LuceneVersion</span> |
| compatibility when creating <a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html">StopFilter</a>: |
| <ul><li>As of 3.1, StopFilter correctly handles Unicode 4.0 |
| supplementary characters in stopwords and position |
| increments are preserved</li></ul> |
| </p></p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">Lucene.Net.Util.AttributeSource</span></div> |
| <div class="level2"><span class="xref">Lucene.Net.Analysis.TokenStream</span></div> |
| <div class="level3"><span class="xref">Lucene.Net.Analysis.TokenFilter</span></div> |
| <div class="level4"><a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html">FilteringTokenFilter</a></div> |
| <div class="level5"><span class="xref">StopFilter</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html#Lucene_Net_Analysis_Util_FilteringTokenFilter_m_version">FilteringTokenFilter.m_version</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html#Lucene_Net_Analysis_Util_FilteringTokenFilter_IncrementToken">FilteringTokenFilter.IncrementToken()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html#Lucene_Net_Analysis_Util_FilteringTokenFilter_Reset">FilteringTokenFilter.Reset()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html#Lucene_Net_Analysis_Util_FilteringTokenFilter_EnablePositionIncrements">FilteringTokenFilter.EnablePositionIncrements</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html#Lucene_Net_Analysis_Util_FilteringTokenFilter_SetEnablePositionIncrements_System_Boolean_">FilteringTokenFilter.SetEnablePositionIncrements(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html#Lucene_Net_Analysis_Util_FilteringTokenFilter_End">FilteringTokenFilter.End()</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.TokenFilter.m_input</span> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.TokenFilter.html#Lucene_Net_Analysis_TokenFilter_Dispose_System_Boolean_">TokenFilter.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.TokenStream.Dispose()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeFactory()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeClassesEnumerator()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeImplsEnumerator()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.AddAttributeImpl(Lucene.Net.Util.Attribute)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.AddAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.HasAttributes</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.HasAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ClearAttributes()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CaptureState()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.RestoreState(Lucene.Net.Util.AttributeSource.State)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetHashCode()</span> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_Equals_System_Object_">AttributeSource.Equals(Object)</a> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ReflectAsString_System_Boolean_">AttributeSource.ReflectAsString(Boolean)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ReflectWith(Lucene.Net.Util.IAttributeReflector)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CloneAttributes()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CopyTo(Lucene.Net.Util.AttributeSource)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Core.html">Lucene.Net.Analysis.Core</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Core_StopFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class StopFilter : FilteringTokenFilter, IDisposable</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Core_StopFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Util_CharArraySet_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Core.StopFilter.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Analysis.TokenStream%2CLucene.Net.Analysis.Util.CharArraySet)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Core/StopFilter.cs/#L54">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Core_StopFilter__ctor_" data-uid="Lucene.Net.Analysis.Core.StopFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Core_StopFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Util_CharArraySet_" data-uid="Lucene.Net.Analysis.Core.StopFilter.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.TokenStream,Lucene.Net.Analysis.Util.CharArraySet)">StopFilter(LuceneVersion, TokenStream, CharArraySet)</h4> |
| <div class="markdown level1 summary"><p>Constructs a filter which removes words from the input <span class="xref">Lucene.Net.Analysis.TokenStream</span> that are |
| named in the <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public StopFilter(LuceneVersion matchVersion, TokenStream in, CharArraySet stopWords)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td><p>Lucene version to enable correct Unicode 4.0 behavior in the stop |
| set if Version > 3.0. See <span class="xref">Lucene.Net.Util.LuceneVersion</span>> for details. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Analysis.TokenStream</span></td> |
| <td><span class="parametername">in</span></td> |
| <td><p>Input <span class="xref">Lucene.Net.Analysis.TokenStream</span> </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><span class="parametername">stopWords</span></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> representing the stopwords. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_Core_StopFilter__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Util_CharArraySet__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html#Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String___">MakeStopSet(LuceneVersion, String[])</a></div> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Core_StopFilter_Accept.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Core.StopFilter.Accept%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Core/StopFilter.cs/#L120">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Core_StopFilter_Accept_" data-uid="Lucene.Net.Analysis.Core.StopFilter.Accept*"></a> |
| <h4 id="Lucene_Net_Analysis_Core_StopFilter_Accept" data-uid="Lucene.Net.Analysis.Core.StopFilter.Accept">Accept()</h4> |
| <div class="markdown level1 summary"><p>Returns the next input Token whose Term is not a stop word.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected override bool Accept()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Analysis.Util.FilteringTokenFilter.html#Lucene_Net_Analysis_Util_FilteringTokenFilter_Accept">FilteringTokenFilter.Accept()</a></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Core.StopFilter.MakeStopSet(Lucene.Net.Util.LuceneVersion%2CSystem.String%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Core/StopFilter.cs/#L70">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet*"></a> |
| <h4 id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String___" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet(Lucene.Net.Util.LuceneVersion,System.String[])">MakeStopSet(LuceneVersion, String[])</h4> |
| <div class="markdown level1 summary"><p>Builds a <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> from an array of stop words, |
| appropriate for passing into the <a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html">StopFilter</a> constructor. |
| This permits this <code data-dev-comment-type="paramref" class="paramref">stopWords</code> construction to be cached once when |
| an <span class="xref">Lucene.Net.Analysis.Analyzer</span> is constructed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static CharArraySet MakeStopSet(LuceneVersion matchVersion, params string[] stopWords)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td><p><span class="xref">Lucene.Net.Util.LuceneVersion</span> to enable correct Unicode 4.0 behavior in the returned set if Version > 3.0 </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">stopWords</span></td> |
| <td><p>An array of stopwords </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String____seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html#Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String___System_Boolean_">MakeStopSet(LuceneVersion, String[], Boolean)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String___System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Core.StopFilter.MakeStopSet(Lucene.Net.Util.LuceneVersion%2CSystem.String%5B%5D%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Core/StopFilter.cs/#L97">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet*"></a> |
| <h4 id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String___System_Boolean_" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet(Lucene.Net.Util.LuceneVersion,System.String[],System.Boolean)">MakeStopSet(LuceneVersion, String[], Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a stopword set from the given stopword array.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static CharArraySet MakeStopSet(LuceneVersion matchVersion, string[] stopWords, bool ignoreCase)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td><p><span class="xref">Lucene.Net.Util.LuceneVersion</span> to enable correct Unicode 4.0 behavior in the returned set if Version > 3.0 </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">stopWords</span></td> |
| <td><p>An array of stopwords </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">ignoreCase</span></td> |
| <td><p>If true, all words are lower cased first. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><p>a Set (<a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a>) containing the words </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Core_StopFilter_MakeStopSet__1_Lucene_Net_Util_LuceneVersion_System_Collections_Generic_IList___0__.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Core.StopFilter.MakeStopSet%60%601(Lucene.Net.Util.LuceneVersion%2CSystem.Collections.Generic.IList%7B%60%600%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Core/StopFilter.cs/#L85">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet*"></a> |
| <h4 id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet__1_Lucene_Net_Util_LuceneVersion_System_Collections_Generic_IList___0__" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet``1(Lucene.Net.Util.LuceneVersion,System.Collections.Generic.IList{``0})">MakeStopSet<T1>(LuceneVersion, IList<T1>)</h4> |
| <div class="markdown level1 summary"><p>Builds a <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> from an array of stop words, |
| appropriate for passing into the <a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html">StopFilter</a> constructor. |
| This permits this <code data-dev-comment-type="paramref" class="paramref">stopWords</code> construction to be cached once when |
| an <span class="xref">Lucene.Net.Analysis.Analyzer</span> is constructed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static CharArraySet MakeStopSet<T1>(LuceneVersion matchVersion, IList<T1> stopWords)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td><p><span class="xref">Lucene.Net.Util.LuceneVersion</span> to enable correct Unicode 4.0 behavior in the returned set if Version > 3.0 </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IList</span><T1></td> |
| <td><span class="parametername">stopWords</span></td> |
| <td><p>A List of <span class="xref">System.String</span>s or <span class="xref">char[]</span> or any other ToString()-able list representing the stopwords </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><p>A Set (<a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a>) containing the words </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T1</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet__1_Lucene_Net_Util_LuceneVersion_System_Collections_Generic_IList___0___seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Analysis.Core.StopFilter.html#Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_Lucene_Net_Util_LuceneVersion_System_String___System_Boolean_">MakeStopSet(LuceneVersion, String[], Boolean)</a></div> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Core_StopFilter_MakeStopSet__1_Lucene_Net_Util_LuceneVersion_System_Collections_Generic_IList___0__System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Core.StopFilter.MakeStopSet%60%601(Lucene.Net.Util.LuceneVersion%2CSystem.Collections.Generic.IList%7B%60%600%7D%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Core/StopFilter.cs/#L110">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet_" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet*"></a> |
| <h4 id="Lucene_Net_Analysis_Core_StopFilter_MakeStopSet__1_Lucene_Net_Util_LuceneVersion_System_Collections_Generic_IList___0__System_Boolean_" data-uid="Lucene.Net.Analysis.Core.StopFilter.MakeStopSet``1(Lucene.Net.Util.LuceneVersion,System.Collections.Generic.IList{``0},System.Boolean)">MakeStopSet<T1>(LuceneVersion, IList<T1>, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a stopword set from the given stopword list. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static CharArraySet MakeStopSet<T1>(LuceneVersion matchVersion, IList<T1> stopWords, bool ignoreCase)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">Lucene.Net.Util.LuceneVersion</span></td> |
| <td><span class="parametername">matchVersion</span></td> |
| <td><p><span class="xref">Lucene.Net.Util.LuceneVersion</span> to enable correct Unicode 4.0 behavior in the returned set if Version > 3.0 </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IList</span><T1></td> |
| <td><span class="parametername">stopWords</span></td> |
| <td><p>A List of <span class="xref">System.String</span>s or <span class="xref">char[]</span> or any other ToString()-able list representing the stopwords </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">ignoreCase</span></td> |
| <td><p>if true, all words are lower cased first </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><p>A Set (<a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a>) containing the words </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T1</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </div> |
| </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/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Core_StopFilter.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Core.StopFilter%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Core/StopFilter.cs/#L37" class="contribution-link">View Source</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> |