blob: 736cbab4af09f4d43cf6383478ebb5adf750ad20 [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>Class StopwordAnalyzerBase
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class StopwordAnalyzerBase
| 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.Util.StopwordAnalyzerBase">
<h1 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase" class="text-break">Class StopwordAnalyzerBase
</h1>
<div class="markdown level0 summary"><p>Base class for <span class="xref">Lucene.Net.Analysis.Analyzer</span>s that need to make use of stopword sets. </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.Analysis.Analyzer</span></div>
<div class="level2"><span class="xref">StopwordAnalyzerBase</span></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Ar.ArabicAnalyzer.html">ArabicAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Bg.BulgarianAnalyzer.html">BulgarianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Br.BrazilianAnalyzer.html">BrazilianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Ca.CatalanAnalyzer.html">CatalanAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Cjk.CJKAnalyzer.html">CJKAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Ckb.SoraniAnalyzer.html">SoraniAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Core.StopAnalyzer.html">StopAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Cz.CzechAnalyzer.html">CzechAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Da.DanishAnalyzer.html">DanishAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.De.GermanAnalyzer.html">GermanAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.El.GreekAnalyzer.html">GreekAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.En.EnglishAnalyzer.html">EnglishAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Es.SpanishAnalyzer.html">SpanishAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Eu.BasqueAnalyzer.html">BasqueAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Fa.PersianAnalyzer.html">PersianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Fi.FinnishAnalyzer.html">FinnishAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Fr.FrenchAnalyzer.html">FrenchAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Ga.IrishAnalyzer.html">IrishAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Gl.GalicianAnalyzer.html">GalicianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Hi.HindiAnalyzer.html">HindiAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Hu.HungarianAnalyzer.html">HungarianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Hy.ArmenianAnalyzer.html">ArmenianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Id.IndonesianAnalyzer.html">IndonesianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.It.ItalianAnalyzer.html">ItalianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Lv.LatvianAnalyzer.html">LatvianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.No.NorwegianAnalyzer.html">NorwegianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Pt.PortugueseAnalyzer.html">PortugueseAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Ro.RomanianAnalyzer.html">RomanianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Ru.RussianAnalyzer.html">RussianAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Standard.ClassicAnalyzer.html">ClassicAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Standard.StandardAnalyzer.html">StandardAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Standard.UAX29URLEmailAnalyzer.html">UAX29URLEmailAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Sv.SwedishAnalyzer.html">SwedishAnalyzer</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Analysis.Tr.TurkishAnalyzer.html">TurkishAnalyzer</a></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="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_NewAnonymous_System_Func_System_String_System_IO_TextReader_Lucene_Net_Analysis_TokenStreamComponents__">Analyzer.NewAnonymous(Func&lt;String, TextReader, TokenStreamComponents&gt;)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_NewAnonymous_System_Func_System_String_System_IO_TextReader_Lucene_Net_Analysis_TokenStreamComponents__Lucene_Net_Analysis_ReuseStrategy_">Analyzer.NewAnonymous(Func&lt;String, TextReader, TokenStreamComponents&gt;, ReuseStrategy)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_NewAnonymous_System_Func_System_String_System_IO_TextReader_Lucene_Net_Analysis_TokenStreamComponents__System_Func_System_String_System_IO_TextReader_System_IO_TextReader__">Analyzer.NewAnonymous(Func&lt;String, TextReader, TokenStreamComponents&gt;, Func&lt;String, TextReader, TextReader&gt;)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_NewAnonymous_System_Func_System_String_System_IO_TextReader_Lucene_Net_Analysis_TokenStreamComponents__System_Func_System_String_System_IO_TextReader_System_IO_TextReader__Lucene_Net_Analysis_ReuseStrategy_">Analyzer.NewAnonymous(Func&lt;String, TextReader, TokenStreamComponents&gt;, Func&lt;String, TextReader, TextReader&gt;, ReuseStrategy)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_CreateComponents_System_String_System_IO_TextReader_">Analyzer.CreateComponents(String, TextReader)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_GetTokenStream_System_String_System_IO_TextReader_">Analyzer.GetTokenStream(String, TextReader)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_GetTokenStream_System_String_System_String_">Analyzer.GetTokenStream(String, String)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_InitReader_System_String_System_IO_TextReader_">Analyzer.InitReader(String, TextReader)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_GetPositionIncrementGap_System_String_">Analyzer.GetPositionIncrementGap(String)</a>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_GetOffsetGap_System_String_">Analyzer.GetOffsetGap(String)</a>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.Analyzer.Strategy</span>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.Analyzer.Dispose()</span>
</div>
<div>
<a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.Analyzer.html#Lucene_Net_Analysis_Analyzer_Dispose_System_Boolean_">Analyzer.Dispose(Boolean)</a>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.Analyzer.GLOBAL_REUSE_STRATEGY</span>
</div>
<div>
<span class="xref">Lucene.Net.Analysis.Analyzer.PER_FIELD_REUSE_STRATEGY</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</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>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Util.html">Lucene.Net.Analysis.Util</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6>
<h5 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class StopwordAnalyzerBase : Analyzer, 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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase__ctor_Lucene_Net_Util_LuceneVersion_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.%23ctor(Lucene.Net.Util.LuceneVersion)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L66">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase__ctor_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase__ctor_Lucene_Net_Util_LuceneVersion_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.#ctor(Lucene.Net.Util.LuceneVersion)">StopwordAnalyzerBase(LuceneVersion)</h4>
<div class="markdown level1 summary"><p>Creates a new <span class="xref">Lucene.Net.Analysis.Analyzer</span> with an empty stopword set</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected StopwordAnalyzerBase(LuceneVersion version)</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">version</span></td>
<td><p>the Lucene version for cross version compatibility </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_Util_CharArraySet_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.%23ctor(Lucene.Net.Util.LuceneVersion%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L54">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase__ctor_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Analysis_Util_CharArraySet_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Analysis.Util.CharArraySet)">StopwordAnalyzerBase(LuceneVersion, CharArraySet)</h4>
<div class="markdown level1 summary"><p>Creates a new instance initialized with the given stopword set</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected StopwordAnalyzerBase(LuceneVersion version, 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">version</span></td>
<td><p>the Lucene version for cross version compatibility </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>the analyzer&apos;s stopword set </p>
</td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase_m_matchVersion.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.m_matchVersion%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L37">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_m_matchVersion" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.m_matchVersion">m_matchVersion</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected readonly LuceneVersion m_matchVersion</code></pre>
</div>
<h5 class="fieldValue">Field Value</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">Lucene.Net.Util.LuceneVersion</span></td>
<td></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase_m_stopwords.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.m_stopwords%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L35">View Source</a>
</span>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_m_stopwords" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.m_stopwords">m_stopwords</h4>
<div class="markdown level1 summary"><p>An immutable stopword set</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected readonly CharArraySet m_stopwords</code></pre>
</div>
<h5 class="fieldValue">Field Value</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>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase_StopwordSet.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.StopwordSet%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L45">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_StopwordSet_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.StopwordSet*"></a>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_StopwordSet" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.StopwordSet">StopwordSet</h4>
<div class="markdown level1 summary"><p>Returns the analyzer&apos;s stopword set or an empty set if the analyzer has no
stopwords</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual CharArraySet StopwordSet { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>the analyzer&apos;s stopword set or an empty set if the analyzer has no
stopwords </p>
</td>
</tr>
</tbody>
</table>
<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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_System_Boolean_System_Type_System_String_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet(System.Boolean%2CSystem.Type%2CSystem.String%2CSystem.String)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L88">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet*"></a>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_System_Boolean_System_Type_System_String_System_String_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet(System.Boolean,System.Type,System.String,System.String)">LoadStopwordSet(Boolean, Type, String, String)</h4>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> from an embedded resource associated with a class. (See
<span class="xref">System.Reflection.Assembly.GetManifestResourceStream(System.String)</span>).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected static CharArraySet LoadStopwordSet(bool ignoreCase, Type aClass, string resource, string comment)</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">System.Boolean</span></td>
<td><span class="parametername">ignoreCase</span></td>
<td><p><code>true</code> if the set should ignore the case of the
stopwords, otherwise <code>false</code> </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Type</span></td>
<td><span class="parametername">aClass</span></td>
<td><p>a class that is associated with the given stopwordResource </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">resource</span></td>
<td><p>name of the resource file associated with the given class </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">comment</span></td>
<td><p>comment string to ignore in the stopword file </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 <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> containing the distinct stopwords from the given
file </p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if loading the stopwords throws an <span class="xref">System.IO.IOException</span> </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_System_IO_FileInfo_Lucene_Net_Util_LuceneVersion_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet(System.IO.FileInfo%2CLucene.Net.Util.LuceneVersion)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L118">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet*"></a>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_System_IO_FileInfo_Lucene_Net_Util_LuceneVersion_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet(System.IO.FileInfo,Lucene.Net.Util.LuceneVersion)">LoadStopwordSet(FileInfo, LuceneVersion)</h4>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> from a file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected static CharArraySet LoadStopwordSet(FileInfo stopwords, LuceneVersion matchVersion)</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">System.IO.FileInfo</span></td>
<td><span class="parametername">stopwords</span></td>
<td><p>the stopwords file to load</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.LuceneVersion</span></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>the Lucene version for cross version compatibility </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 <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> containing the distinct stopwords from the given
file </p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if loading the stopwords throws an <span class="xref">System.IO.IOException</span> </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_System_IO_TextReader_Lucene_Net_Util_LuceneVersion_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet(System.IO.TextReader%2CLucene.Net.Util.LuceneVersion)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L144">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet*"></a>
<h4 id="Lucene_Net_Analysis_Util_StopwordAnalyzerBase_LoadStopwordSet_System_IO_TextReader_Lucene_Net_Util_LuceneVersion_" data-uid="Lucene.Net.Analysis.Util.StopwordAnalyzerBase.LoadStopwordSet(System.IO.TextReader,Lucene.Net.Util.LuceneVersion)">LoadStopwordSet(TextReader, LuceneVersion)</h4>
<div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> from a file.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected static CharArraySet LoadStopwordSet(TextReader stopwords, LuceneVersion matchVersion)</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">System.IO.TextReader</span></td>
<td><span class="parametername">stopwords</span></td>
<td><p>the stopwords reader to load</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.LuceneVersion</span></td>
<td><span class="parametername">matchVersion</span></td>
<td><p>the Lucene version for cross version compatibility </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 <a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a> containing the distinct stopwords from the given
reader </p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if loading the stopwords throws an <span class="xref">System.IO.IOException</span> </p>
</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Util_StopwordAnalyzerBase.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Util.StopwordAnalyzerBase%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Util/StopwordAnalyzerBase.cs/#L30" 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 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>