| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SynonymFilter |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SynonymFilter |
| | 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.Synonym.SynonymFilter"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Synonym_SynonymFilter" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter" class="text-break">Class SynonymFilter |
| </h1> |
| <div class="markdown level0 summary"><p>Matches single or multi word synonyms in a token stream. |
| This token stream cannot properly handle position |
| increments != 1, ie, you should place this filter before |
| filtering out stop words.</p> |
| <p>Note that with the current implementation, parsing is |
| greedy, so whenever multiple parses would apply, the rule |
| starting the earliest and parsing the most tokens wins. |
| For example if you have these rules: |
| |
| <pre><code> a -> x |
| a b -> y |
| b c d -> z</code></pre> |
| |
| Then input <code>a b c d e</code> parses to <code>y b c |
| d</code>, ie the 2nd rule "wins" because it started |
| earliest and matched the most input tokens of other rules |
| starting at that point.</p> |
| |
| <p>A future improvement to this filter could allow |
| non-greedy parsing, such that the 3rd rule would win, and |
| also separately allow multiple parses, such that all 3 |
| rules would match, perhaps even on a rule by rule |
| basis.</p> |
| |
| <p><strong>NOTE</strong>: when a match occurs, the output tokens |
| associated with the matching rule are "stacked" on top of |
| the input stream (if the rule had |
| <code>keepOrig=true</code>) and also on top of another |
| matched rule's output tokens. This is not a correct |
| solution, as really the output should be an arbitrary |
| graph/lattice. For example, with the above match, you |
| would expect an exact <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Search.PhraseQuery.html">PhraseQuery</a> <code>"y b |
| c"</code> to match the parsed tokens, but it will fail to |
| do so. This limitation is necessary because Lucene's |
| <span class="xref">Lucene.Net.Analysis.TokenStream</span> (and index) cannot yet represent an arbitrary |
| graph.</p> |
| |
| <p><strong>NOTE</strong>: If multiple incoming tokens arrive on the |
| same position, only the first token at that position is |
| used for parsing. Subsequent tokens simply pass through |
| and are not parsed. A future improvement would be to |
| allow these tokens to also be matched.</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">SynonymFilter</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="https://lucenenet.apache.org/docs/4.8.0-beta00013/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="https://lucenenet.apache.org/docs/4.8.0-beta00013/api/core/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_Equals_System_Object_">AttributeSource.Equals(Object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://lucenenet.apache.org/docs/4.8.0-beta00013/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.Synonym.html">Lucene.Net.Analysis.Synonym</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Synonym_SynonymFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class SynonymFilter : 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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Synonym_SynonymFilter__ctor_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Synonym_SynonymMap_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Synonym.SynonymFilter.%23ctor(Lucene.Net.Analysis.TokenStream%2CLucene.Net.Analysis.Synonym.SynonymMap%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Synonym/SynonymFilter.cs/#L260">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Synonym_SynonymFilter__ctor_" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Synonym_SynonymFilter__ctor_Lucene_Net_Analysis_TokenStream_Lucene_Net_Analysis_Synonym_SynonymMap_System_Boolean_" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter.#ctor(Lucene.Net.Analysis.TokenStream,Lucene.Net.Analysis.Synonym.SynonymMap,System.Boolean)">SynonymFilter(TokenStream, SynonymMap, Boolean)</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 SynonymFilter(TokenStream input, SynonymMap synonyms, 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.Analysis.TokenStream</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p>input tokenstream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Synonym.SynonymMap.html">SynonymMap</a></td> |
| <td><span class="parametername">synonyms</span></td> |
| <td><p>synonym map </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">ignoreCase</span></td> |
| <td><p>case-folds input for matching with <span class="xref">J2N.Character.ToLower(System.Int32,System.Globalization.CultureInfo)</span> |
| in using <span class="xref">System.Globalization.CultureInfo.InvariantCulture</span>. |
| Note, if you set this to <code>true</code>, its your responsibility to lowercase |
| the input entries when you create the <a class="xref" href="Lucene.Net.Analysis.Synonym.SynonymMap.html">SynonymMap</a>.</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_Synonym_SynonymFilter_TYPE_SYNONYM.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Synonym.SynonymFilter.TYPE_SYNONYM%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/Synonym/SynonymFilter.cs/#L99">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Synonym_SynonymFilter_TYPE_SYNONYM" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter.TYPE_SYNONYM">TYPE_SYNONYM</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 const string TYPE_SYNONYM = "SYNONYM"</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.String</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_Synonym_SynonymFilter_IncrementToken.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Synonym.SynonymFilter.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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Synonym/SynonymFilter.cs/#L570">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Synonym_SynonymFilter_IncrementToken_" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter.IncrementToken*"></a> |
| <h4 id="Lucene_Net_Analysis_Synonym_SynonymFilter_IncrementToken" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter.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> |
| <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_Synonym_SynonymFilter_Reset.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Synonym.SynonymFilter.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/Synonym/SynonymFilter.cs/#L693">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Synonym_SynonymFilter_Reset_" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter.Reset*"></a> |
| <h4 id="Lucene_Net_Analysis_Synonym_SynonymFilter_Reset" data-uid="Lucene.Net.Analysis.Synonym.SynonymFilter.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.TokenFilter.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_Synonym_SynonymFilter.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Synonym.SynonymFilter%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/Synonym/SynonymFilter.cs/#L97" 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> |
