| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class ShingleFilter |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class ShingleFilter |
| | 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.Shingle.ShingleFilter"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Shingle_ShingleFilter" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter" class="text-break">Class ShingleFilter |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Analysis.Shingle.ShingleFilter.html">ShingleFilter</a> constructs shingles (token n-grams) from a token stream. |
| In other words, it creates combinations of tokens as a single token. |
| |
| </p> |
| <p>For example, the sentence "please divide this sentence into shingles" |
| might be tokenized into shingles "please divide", "divide this", |
| "this sentence", "sentence into", and "into shingles". |
| |
| </p> |
| <p>This filter handles position increments > 1 by inserting filler tokens |
| (tokens with termtext "_"). It does not handle a position increment of 0. |
| </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">ShingleFilter</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> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Analysis.TokenFilter.html#Lucene_Net_Analysis_TokenFilter_Dispose_System_Boolean_">TokenFilter.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Analysis.TokenStream.Dispose()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeFactory()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeClassesEnumerator()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttributeImplsEnumerator()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.AddAttributeImpl(Lucene.Net.Util.Attribute)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.AddAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.HasAttributes</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.HasAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetAttribute<T>()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ClearAttributes()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CaptureState()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.RestoreState(Lucene.Net.Util.AttributeSource.State)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.GetHashCode()</span> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_Equals_System_Object_">AttributeSource.Equals(Object)</a> |
| </div> |
| <div> |
| <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ReflectAsString_System_Boolean_">AttributeSource.ReflectAsString(Boolean)</a> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ReflectWith(Lucene.Net.Util.IAttributeReflector)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CloneAttributes()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.CopyTo(Lucene.Net.Util.AttributeSource)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Util.AttributeSource.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.Shingle.html">Lucene.Net.Analysis.Shingle</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Shingle_ShingleFilter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class ShingleFilter : 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_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.%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/Shingle/ShingleFilter.cs/#L199">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor(Lucene.Net.Analysis.TokenStream)">ShingleFilter(TokenStream)</h4> |
| <div class="markdown level1 summary"><p>Construct a <a class="xref" href="Lucene.Net.Analysis.Shingle.ShingleFilter.html">ShingleFilter</a> with default shingle size: 2.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ShingleFilter(TokenStream input)</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 stream </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_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.%23ctor(Lucene.Net.Analysis.TokenStream%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/Shingle/ShingleFilter.cs/#L190">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Int32_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor(Lucene.Net.Analysis.TokenStream,System.Int32)">ShingleFilter(TokenStream, Int32)</h4> |
| <div class="markdown level1 summary"><p>Constructs a <a class="xref" href="Lucene.Net.Analysis.Shingle.ShingleFilter.html">ShingleFilter</a> with the specified shingle size from the |
| <span class="xref">Lucene.Net.Analysis.TokenStream</span> <code data-dev-comment-type="paramref" class="paramref">input</code></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ShingleFilter(TokenStream input, int maxShingleSize)</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 stream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxShingleSize</span></td> |
| <td><p>maximum shingle size produced by the filter. </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_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.%23ctor(Lucene.Net.Analysis.TokenStream%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/Shingle/ShingleFilter.cs/#L172">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor(Lucene.Net.Analysis.TokenStream,System.Int32,System.Int32)">ShingleFilter(TokenStream, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Constructs a <a class="xref" href="Lucene.Net.Analysis.Shingle.ShingleFilter.html">ShingleFilter</a> with the specified shingle size from the |
| <span class="xref">Lucene.Net.Analysis.TokenStream</span> <code data-dev-comment-type="paramref" class="paramref">input</code></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ShingleFilter(TokenStream input, int minShingleSize, int maxShingleSize)</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 stream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minShingleSize</span></td> |
| <td><p>minimum shingle size produced by the filter. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxShingleSize</span></td> |
| <td><p>maximum shingle size produced by the filter. </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_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.%23ctor(Lucene.Net.Analysis.TokenStream%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Shingle/ShingleFilter.cs/#L210">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter__ctor_Lucene_Net_Analysis_TokenStream_System_String_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.#ctor(Lucene.Net.Analysis.TokenStream,System.String)">ShingleFilter(TokenStream, String)</h4> |
| <div class="markdown level1 summary"><p>Construct a <a class="xref" href="Lucene.Net.Analysis.Shingle.ShingleFilter.html">ShingleFilter</a> with the specified token type for shingle tokens |
| and the default shingle size: 2</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ShingleFilter(TokenStream input, string tokenType)</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 stream </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">tokenType</span></td> |
| <td><p>token type for shingle tokens </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_Shingle_ShingleFilter_DEFAULT_FILLER_TOKEN.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_FILLER_TOKEN%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/Shingle/ShingleFilter.cs/#L46">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_DEFAULT_FILLER_TOKEN" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_FILLER_TOKEN">DEFAULT_FILLER_TOKEN</h4> |
| <div class="markdown level1 summary"><p>filler token for when positionIncrement is more than 1</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const string DEFAULT_FILLER_TOKEN = "_"</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> |
| <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_Shingle_ShingleFilter_DEFAULT_MAX_SHINGLE_SIZE.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE%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/Shingle/ShingleFilter.cs/#L51">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_DEFAULT_MAX_SHINGLE_SIZE" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_MAX_SHINGLE_SIZE">DEFAULT_MAX_SHINGLE_SIZE</h4> |
| <div class="markdown level1 summary"><p>default maximum shingle size is 2.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const int DEFAULT_MAX_SHINGLE_SIZE = 2</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_Shingle_ShingleFilter_DEFAULT_MIN_SHINGLE_SIZE.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE%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/Shingle/ShingleFilter.cs/#L56">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_DEFAULT_MIN_SHINGLE_SIZE" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_MIN_SHINGLE_SIZE">DEFAULT_MIN_SHINGLE_SIZE</h4> |
| <div class="markdown level1 summary"><p>default minimum shingle size is 2.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const int DEFAULT_MIN_SHINGLE_SIZE = 2</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_Shingle_ShingleFilter_DEFAULT_TOKEN_SEPARATOR.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_TOKEN_SEPARATOR%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/Shingle/ShingleFilter.cs/#L66">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_DEFAULT_TOKEN_SEPARATOR" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_TOKEN_SEPARATOR">DEFAULT_TOKEN_SEPARATOR</h4> |
| <div class="markdown level1 summary"><p>The default string to use when joining adjacent tokens to form a shingle</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const string DEFAULT_TOKEN_SEPARATOR = " "</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> |
| <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_Shingle_ShingleFilter_DEFAULT_TOKEN_TYPE.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_TOKEN_TYPE%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/Shingle/ShingleFilter.cs/#L61">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_DEFAULT_TOKEN_TYPE" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.DEFAULT_TOKEN_TYPE">DEFAULT_TOKEN_TYPE</h4> |
| <div class="markdown level1 summary"><p>default token type attribute value is "shingle" </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const string DEFAULT_TOKEN_TYPE = "shingle"</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Shingle_ShingleFilter_End.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.End%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/Shingle/ShingleFilter.cs/#L495">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_End_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.End*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_End" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.End">End()</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 End()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Analysis.TokenFilter.End()</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Shingle_ShingleFilter_IncrementToken.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.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/Shingle/ShingleFilter.cs/#L320">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_IncrementToken_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.IncrementToken*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_IncrementToken" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Shingle_ShingleFilter_Reset.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Shingle/ShingleFilter.cs/#L559">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_Reset_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.Reset*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_Reset" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.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> |
| <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_Shingle_ShingleFilter_SetFillerToken_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.SetFillerToken(System.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Shingle/ShingleFilter.cs/#L307">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetFillerToken_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetFillerToken*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetFillerToken_System_String_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetFillerToken(System.String)">SetFillerToken(String)</h4> |
| <div class="markdown level1 summary"><p>Sets the string to insert for each position at which there is no token |
| (i.e., when position increment is greater than one).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void SetFillerToken(string fillerToken)</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.String</span></td> |
| <td><span class="parametername">fillerToken</span></td> |
| <td><p>string to insert at each position where there is no token </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_Shingle_ShingleFilter_SetMaxShingleSize_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.SetMaxShingleSize(System.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/Shingle/ShingleFilter.cs/#L259">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetMaxShingleSize_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetMaxShingleSize*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetMaxShingleSize_System_Int32_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetMaxShingleSize(System.Int32)">SetMaxShingleSize(Int32)</h4> |
| <div class="markdown level1 summary"><p>Set the max shingle size (default: 2)</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void SetMaxShingleSize(int maxShingleSize)</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.Int32</span></td> |
| <td><span class="parametername">maxShingleSize</span></td> |
| <td><p>max size of output shingles </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_Shingle_ShingleFilter_SetMinShingleSize_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.SetMinShingleSize(System.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/Shingle/ShingleFilter.cs/#L280">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetMinShingleSize_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetMinShingleSize*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetMinShingleSize_System_Int32_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetMinShingleSize(System.Int32)">SetMinShingleSize(Int32)</h4> |
| <div class="markdown level1 summary"><p>Set the min shingle size (default: 2). |
| </p> |
| <p>This method requires that the passed in minShingleSize is not greater |
| than maxShingleSize, so make sure that maxShingleSize is set before |
| calling this method. |
| </p> |
| <p>The unigram output option is independent of the min shingle size. |
| |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void SetMinShingleSize(int minShingleSize)</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.Int32</span></td> |
| <td><span class="parametername">minShingleSize</span></td> |
| <td><p>min size of output shingles </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_Shingle_ShingleFilter_SetOutputUnigrams_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.SetOutputUnigrams(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Shingle/ShingleFilter.cs/#L232">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetOutputUnigrams_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetOutputUnigrams*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetOutputUnigrams_System_Boolean_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetOutputUnigrams(System.Boolean)">SetOutputUnigrams(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Shall the output stream contain the input tokens (unigrams) as well as |
| shingles? (default: true.)</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void SetOutputUnigrams(bool outputUnigrams)</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">outputUnigrams</span></td> |
| <td><p>Whether or not the output stream shall contain |
| the input tokens (unigrams) </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_Shingle_ShingleFilter_SetOutputUnigramsIfNoShingles_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.SetOutputUnigramsIfNoShingles(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Shingle/ShingleFilter.cs/#L250">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetOutputUnigramsIfNoShingles_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetOutputUnigramsIfNoShingles*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetOutputUnigramsIfNoShingles_System_Boolean_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetOutputUnigramsIfNoShingles(System.Boolean)">SetOutputUnigramsIfNoShingles(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Shall we override the behavior of outputUnigrams==false for those |
| times when no shingles are available (because there are fewer than |
| minShingleSize tokens in the input stream)? (default: false.) |
| </p> |
| <p>Note that if outputUnigrams==true, then unigrams are always output, |
| regardless of whether any shingles are available. |
| |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void SetOutputUnigramsIfNoShingles(bool outputUnigramsIfNoShingles)</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">outputUnigramsIfNoShingles</span></td> |
| <td><p>Whether or not to output a single |
| unigram when no shingles are available. </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_Shingle_ShingleFilter_SetTokenSeparator_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.SetTokenSeparator(System.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Shingle/ShingleFilter.cs/#L297">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetTokenSeparator_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetTokenSeparator*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetTokenSeparator_System_String_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetTokenSeparator(System.String)">SetTokenSeparator(String)</h4> |
| <div class="markdown level1 summary"><p>Sets the string to use when joining adjacent tokens to form a shingle </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void SetTokenSeparator(string tokenSeparator)</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.String</span></td> |
| <td><span class="parametername">tokenSeparator</span></td> |
| <td><p>used to separate input stream tokens in output shingles </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_Shingle_ShingleFilter_SetTokenType_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter.SetTokenType(System.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Analysis.Common/Analysis/Shingle/ShingleFilter.cs/#L221">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetTokenType_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetTokenType*"></a> |
| <h4 id="Lucene_Net_Analysis_Shingle_ShingleFilter_SetTokenType_System_String_" data-uid="Lucene.Net.Analysis.Shingle.ShingleFilter.SetTokenType(System.String)">SetTokenType(String)</h4> |
| <div class="markdown level1 summary"><p>Set the type of the shingle tokens produced by this filter. |
| (default: "shingle")</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void SetTokenType(string tokenType)</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.String</span></td> |
| <td><span class="parametername">tokenType</span></td> |
| <td><p>token tokenType </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Shingle_ShingleFilter.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Shingle.ShingleFilter%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/Shingle/ShingleFilter.cs/#L41" 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> |
