| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class MappingCharFilter |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class MappingCharFilter |
| | 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.CharFilters.MappingCharFilter"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_CharFilters_MappingCharFilter" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter" class="text-break">Class MappingCharFilter |
| </h1> |
| <div class="markdown level0 summary"><p>Simplistic <span class="xref">Lucene.Net.Analysis.CharFilter</span> that applies the mappings |
| contained in a <a class="xref" href="Lucene.Net.Analysis.CharFilters.NormalizeCharMap.html">NormalizeCharMap</a> to the character |
| stream, and correcting the resulting changes to the |
| offsets. Matching is greedy (longest pattern matching at |
| a given point wins). Replacement is allowed to be the |
| empty string.</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">System.MarshalByRefObject</span></div> |
| <div class="level2"><span class="xref">System.IO.TextReader</span></div> |
| <div class="level3"><span class="xref">Lucene.Net.Analysis.CharFilter</span></div> |
| <div class="level4"><a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html">BaseCharFilter</a></div> |
| <div class="level5"><span class="xref">MappingCharFilter</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.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_Correct_System_Int32_">BaseCharFilter.Correct(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_LastCumulativeDiff">BaseCharFilter.LastCumulativeDiff</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.CharFilters.BaseCharFilter.html#Lucene_Net_Analysis_CharFilters_BaseCharFilter_AddOffCorrectMap_System_Int32_System_Int32_">BaseCharFilter.AddOffCorrectMap(Int32, Int32)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.CharFilter.m_input</span> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Dispose_System_Boolean_">CharFilter.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_CorrectOffset_System_Int32_">CharFilter.CorrectOffset(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Skip_System_Int32_">CharFilter.Skip(Int32)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.CharFilter.IsReady</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.CharFilter.IsMarkSupported</span> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Mark_System_Int32_">CharFilter.Mark(Int32)</a> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.Null</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.Close()</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.Dispose()</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.Peek()</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.ReadAsync(System.Char[], System.Int32, System.Int32)</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.ReadBlock(System.Char[], System.Int32, System.Int32)</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.ReadBlockAsync(System.Char[], System.Int32, System.Int32)</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.ReadLine()</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.ReadLineAsync()</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.ReadToEnd()</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.ReadToEndAsync()</span> |
| </div> |
| <div> |
| <span class="xref">System.IO.TextReader.Synchronized(System.IO.TextReader)</span> |
| </div> |
| <div> |
| <span class="xref">System.MarshalByRefObject.GetLifetimeService()</span> |
| </div> |
| <div> |
| <span class="xref">System.MarshalByRefObject.InitializeLifetimeService()</span> |
| </div> |
| <div> |
| <span class="xref">System.MarshalByRefObject.MemberwiseClone(System.Boolean)</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.CharFilters.html">Lucene.Net.Analysis.CharFilters</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_CharFilters_MappingCharFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class MappingCharFilter : BaseCharFilter, 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_CharFilters_MappingCharFilter__ctor_Lucene_Net_Analysis_CharFilters_NormalizeCharMap_System_IO_TextReader_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.CharFilters.MappingCharFilter.%23ctor(Lucene.Net.Analysis.CharFilters.NormalizeCharMap%2CSystem.IO.TextReader)%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/CharFilter/MappingCharFilter.cs/#L57">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_CharFilters_MappingCharFilter__ctor_" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_CharFilters_MappingCharFilter__ctor_Lucene_Net_Analysis_CharFilters_NormalizeCharMap_System_IO_TextReader_" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.#ctor(Lucene.Net.Analysis.CharFilters.NormalizeCharMap,System.IO.TextReader)">MappingCharFilter(NormalizeCharMap, TextReader)</h4> |
| <div class="markdown level1 summary"><p>Default constructor that takes a <span class="xref">System.IO.TextReader</span>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public MappingCharFilter(NormalizeCharMap normMap, TextReader 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><a class="xref" href="Lucene.Net.Analysis.CharFilters.NormalizeCharMap.html">NormalizeCharMap</a></td> |
| <td><span class="parametername">normMap</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td><span class="parametername">in</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_CharFilters_MappingCharFilter_Read.md&value=---%0Auid%3A%20Lucene.Net.Analysis.CharFilters.MappingCharFilter.Read%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/CharFilter/MappingCharFilter.cs/#L101">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_CharFilters_MappingCharFilter_Read_" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.Read*"></a> |
| <h4 id="Lucene_Net_Analysis_CharFilters_MappingCharFilter_Read" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.Read">Read()</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 int Read()</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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Analysis.CharFilter.Read()</span></div> |
| <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_CharFilters_MappingCharFilter_Read_System_Char___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.CharFilters.MappingCharFilter.Read(System.Char%5B%5D%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/CharFilter/MappingCharFilter.cs/#L225">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_CharFilters_MappingCharFilter_Read_" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.Read*"></a> |
| <h4 id="Lucene_Net_Analysis_CharFilters_MappingCharFilter_Read_System_Char___System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.Read(System.Char[],System.Int32,System.Int32)">Read(Char[], Int32, Int32)</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 int Read(char[] cbuf, int off, int len)</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.Char</span>[]</td> |
| <td><span class="parametername">cbuf</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">off</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</span></td> |
| <td></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><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Analysis.CharFilter.html#Lucene_Net_Analysis_CharFilter_Read_System_Char___System_Int32_System_Int32_">CharFilter.Read(Char[], Int32, Int32)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_CharFilters_MappingCharFilter_Reset.md&value=---%0Auid%3A%20Lucene.Net.Analysis.CharFilters.MappingCharFilter.Reset%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/CharFilter/MappingCharFilter.cs/#L92">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_CharFilters_MappingCharFilter_Reset_" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.Reset*"></a> |
| <h4 id="Lucene_Net_Analysis_CharFilters_MappingCharFilter_Reset" data-uid="Lucene.Net.Analysis.CharFilters.MappingCharFilter.Reset">Reset()</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 void Reset()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Analysis.CharFilter.Reset()</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_CharFilters_MappingCharFilter.md&value=---%0Auid%3A%20Lucene.Net.Analysis.CharFilters.MappingCharFilter%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/CharFilter/MappingCharFilter.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 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> |
