| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class CapitalizationFilter |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class CapitalizationFilter |
| | 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.Miscellaneous.CapitalizationFilter"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter" class="text-break">Class CapitalizationFilter |
| </h1> |
| <div class="markdown level0 summary"><p>A filter to apply normal capitalization rules to Tokens. It will make the first letter |
| capital and the rest lower case. |
| <p> |
| This filter is particularly useful to build nice looking facet parameters. This filter |
| is not appropriate if you intend to use a prefix query.</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"><span class="xref">CapitalizationFilter</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> |
| <span class="xref">Lucene.Net.Analysis.TokenFilter.m_input</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.TokenFilter.End()</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.TokenFilter.Reset()</span> |
| </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.Miscellaneous.html">Lucene.Net.Analysis.Miscellaneous</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class CapitalizationFilter : TokenFilter, 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_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.%23ctor(Lucene.Net.Analysis.TokenStream)%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/Miscellaneous/CapitalizationFilter.cs/#L63">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor(Lucene.Net.Analysis.TokenStream)">CapitalizationFilter(TokenStream)</h4> |
| <div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.html">CapitalizationFilter</a> with the default parameters using the culture from the current thread. |
| <p> |
| Calls <a class="xref" href="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.html#Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Boolean_Lucene_Net_Analysis_Util_CharArraySet_System_Boolean_System_Collections_Generic_ICollection_System_Char____System_Int32_System_Int32_System_Int32_">CapitalizationFilter(TokenStream, Boolean, CharArraySet, Boolean, ICollection<Char[]>, Int32, Int32, Int32)</a> |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public CapitalizationFilter(TokenStream in)</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.Analysis.TokenStream</span></td> |
| <td><span class="parametername">in</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Boolean_Lucene_Net_Analysis_Util_CharArraySet_System_Boolean_System_Collections_Generic_ICollection_System_Char____System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.%23ctor(Lucene.Net.Analysis.TokenStream%2CSystem.Boolean%2CLucene.Net.Analysis.Util.CharArraySet%2CSystem.Boolean%2CSystem.Collections.Generic.ICollection%7BSystem.Char%5B%5D%7D%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32)%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/Miscellaneous/CapitalizationFilter.cs/#L97">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Boolean_Lucene_Net_Analysis_Util_CharArraySet_System_Boolean_System_Collections_Generic_ICollection_System_Char____System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor(Lucene.Net.Analysis.TokenStream,System.Boolean,Lucene.Net.Analysis.Util.CharArraySet,System.Boolean,System.Collections.Generic.ICollection{System.Char[]},System.Int32,System.Int32,System.Int32)">CapitalizationFilter(TokenStream, Boolean, CharArraySet, Boolean, ICollection<Char[]>, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.html">CapitalizationFilter</a> with the specified parameters using the culture from the current thread.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public CapitalizationFilter(TokenStream in, bool onlyFirstWord, CharArraySet keep, bool forceFirstLetter, ICollection<char[]> okPrefix, int minWordLength, int maxWordCount, int maxTokenLength)</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.Analysis.TokenStream</span></td> |
| <td><span class="parametername">in</span></td> |
| <td><p>input tokenstream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">onlyFirstWord</span></td> |
| <td><p>should each word be capitalized or all of the words? </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><span class="parametername">keep</span></td> |
| <td><p>a keep word list. Each word that should be kept separated by whitespace. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">forceFirstLetter</span></td> |
| <td><p>Force the first letter to be capitalized even if it is in the keep list. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ICollection</span><<span class="xref">System.Char</span>[]></td> |
| <td><span class="parametername">okPrefix</span></td> |
| <td><p>do not change word capitalization if a word begins with something in this list. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minWordLength</span></td> |
| <td><p>how long the word needs to be to get capitalization applied. If the |
| minWordLength is 3, "and" > "And" but "or" stays "or". </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxWordCount</span></td> |
| <td><p>if the token contains more then maxWordCount words, the capitalization is |
| assumed to be correct. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxTokenLength</span></td> |
| <td><p>The maximum length for an individual token. Tokens that exceed this length will not have the capitalization operation performed. </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_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Boolean_Lucene_Net_Analysis_Util_CharArraySet_System_Boolean_System_Collections_Generic_ICollection_System_Char____System_Int32_System_Int32_System_Int32_System_Globalization_CultureInfo_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.%23ctor(Lucene.Net.Analysis.TokenStream%2CSystem.Boolean%2CLucene.Net.Analysis.Util.CharArraySet%2CSystem.Boolean%2CSystem.Collections.Generic.ICollection%7BSystem.Char%5B%5D%7D%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32%2CSystem.Globalization.CultureInfo)%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/Miscellaneous/CapitalizationFilter.cs/#L117">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Boolean_Lucene_Net_Analysis_Util_CharArraySet_System_Boolean_System_Collections_Generic_ICollection_System_Char____System_Int32_System_Int32_System_Int32_System_Globalization_CultureInfo_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor(Lucene.Net.Analysis.TokenStream,System.Boolean,Lucene.Net.Analysis.Util.CharArraySet,System.Boolean,System.Collections.Generic.ICollection{System.Char[]},System.Int32,System.Int32,System.Int32,System.Globalization.CultureInfo)">CapitalizationFilter(TokenStream, Boolean, CharArraySet, Boolean, ICollection<Char[]>, Int32, Int32, Int32, CultureInfo)</h4> |
| <div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.html">CapitalizationFilter</a> with the specified parameters and the specified <code data-dev-comment-type="paramref" class="paramref">culture</code>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public CapitalizationFilter(TokenStream in, bool onlyFirstWord, CharArraySet keep, bool forceFirstLetter, ICollection<char[]> okPrefix, int minWordLength, int maxWordCount, int maxTokenLength, CultureInfo culture)</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.Analysis.TokenStream</span></td> |
| <td><span class="parametername">in</span></td> |
| <td><p>input tokenstream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">onlyFirstWord</span></td> |
| <td><p>should each word be capitalized or all of the words? </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Util.CharArraySet.html">CharArraySet</a></td> |
| <td><span class="parametername">keep</span></td> |
| <td><p>a keep word list. Each word that should be kept separated by whitespace. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">forceFirstLetter</span></td> |
| <td><p>Force the first letter to be capitalized even if it is in the keep list. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ICollection</span><<span class="xref">System.Char</span>[]></td> |
| <td><span class="parametername">okPrefix</span></td> |
| <td><p>do not change word capitalization if a word begins with something in this list. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minWordLength</span></td> |
| <td><p>how long the word needs to be to get capitalization applied. If the |
| minWordLength is 3, "and" > "And" but "or" stays "or". </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxWordCount</span></td> |
| <td><p>if the token contains more then maxWordCount words, the capitalization is |
| assumed to be correct. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxTokenLength</span></td> |
| <td><p>The maximum length for an individual token. Tokens that exceed this length will not have the capitalization operation performed. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Globalization.CultureInfo</span></td> |
| <td><span class="parametername">culture</span></td> |
| <td><p>The culture to use for the casing operation. If null, the culture of the current thread will be used. </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_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Globalization_CultureInfo_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.%23ctor(Lucene.Net.Analysis.TokenStream%2CSystem.Globalization.CultureInfo)%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/Miscellaneous/CapitalizationFilter.cs/#L80">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Globalization_CultureInfo_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.#ctor(Lucene.Net.Analysis.TokenStream,System.Globalization.CultureInfo)">CapitalizationFilter(TokenStream, CultureInfo)</h4> |
| <div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.html">CapitalizationFilter</a> with the default parameters and the specified <code data-dev-comment-type="paramref" class="paramref">culture</code>. |
| <p> |
| Calls <a class="xref" href="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.html#Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Boolean_Lucene_Net_Analysis_Util_CharArraySet_System_Boolean_System_Collections_Generic_ICollection_System_Char____System_Int32_System_Int32_System_Int32_">CapitalizationFilter(TokenStream, Boolean, CharArraySet, Boolean, ICollection<Char[]>, Int32, Int32, Int32)</a> |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public CapitalizationFilter(TokenStream in, CultureInfo culture)</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.Analysis.TokenStream</span></td> |
| <td><span class="parametername">in</span></td> |
| <td><p>input tokenstream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Globalization.CultureInfo</span></td> |
| <td><span class="parametername">culture</span></td> |
| <td><p>The culture to use for the casing operation. If null, the culture of the current thread will be used. </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_DEFAULT_MAX_TOKEN_LENGTH.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.DEFAULT_MAX_TOKEN_LENGTH%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/Miscellaneous/CapitalizationFilter.cs/#L36">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_DEFAULT_MAX_TOKEN_LENGTH" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.DEFAULT_MAX_TOKEN_LENGTH">DEFAULT_MAX_TOKEN_LENGTH</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">public static readonly int DEFAULT_MAX_TOKEN_LENGTH</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">System.Int32</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_DEFAULT_MAX_WORD_COUNT.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.DEFAULT_MAX_WORD_COUNT%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/Miscellaneous/CapitalizationFilter.cs/#L35">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_DEFAULT_MAX_WORD_COUNT" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.DEFAULT_MAX_WORD_COUNT">DEFAULT_MAX_WORD_COUNT</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">public static readonly int DEFAULT_MAX_WORD_COUNT</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">System.Int32</span></td> |
| <td></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_IncrementToken.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.IncrementToken%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/Miscellaneous/CapitalizationFilter.cs/#L147">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_IncrementToken_" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.IncrementToken*"></a> |
| <h4 id="Lucene_Net_Analysis_Miscellaneous_CapitalizationFilter_IncrementToken" data-uid="Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter.IncrementToken">IncrementToken()</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">public override bool IncrementToken()</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><span class="xref">Lucene.Net.Analysis.TokenStream.IncrementToken()</span></div> |
| <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_Miscellaneous_CapitalizationFilter.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Miscellaneous.CapitalizationFilter%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/Miscellaneous/CapitalizationFilter.cs/#L33" 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> |
