| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Lookup |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Lookup |
| | 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="suggest/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.Search.Suggest.Lookup"> |
| |
| |
| <h1 id="Lucene_Net_Search_Suggest_Lookup" data-uid="Lucene.Net.Search.Suggest.Lookup" class="text-break">Class Lookup |
| </h1> |
| <div class="markdown level0 summary"><p>Simple Lookup interface for <span class="xref">System.String</span> suggestions.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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">Lookup</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.Suggest.Analyzing.AnalyzingInfixSuggester.html">AnalyzingInfixSuggester</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.Suggest.Analyzing.AnalyzingSuggester.html">AnalyzingSuggester</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.Suggest.Analyzing.FreeTextSuggester.html">FreeTextSuggester</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.Suggest.Fst.FSTCompletionLookup.html">FSTCompletionLookup</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.Suggest.Fst.WFSTCompletionLookup.html">WFSTCompletionLookup</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.Suggest.Jaspell.JaspellLookup.html">JaspellLookup</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.Suggest.Tst.TSTLookup.html">TSTLookup</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <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.Search.Suggest.html">Lucene.Net.Search.Suggest</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6> |
| <h5 id="Lucene_Net_Search_Suggest_Lookup_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class Lookup</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_Search_Suggest_Lookup__ctor.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.%23ctor%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.Suggest/Suggest/Lookup.cs/#L193">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup__ctor_" data-uid="Lucene.Net.Search.Suggest.Lookup.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup__ctor" data-uid="Lucene.Net.Search.Suggest.Lookup.#ctor">Lookup()</h4> |
| <div class="markdown level1 summary"><p>Sole constructor. (For invocation by subclass |
| constructors, typically implicit.)</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Lookup()</code></pre> |
| </div> |
| <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_Search_Suggest_Lookup_CHARSEQUENCE_COMPARER.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.CHARSEQUENCE_COMPARER%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.Suggest/Suggest/Lookup.cs/#L130">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_CHARSEQUENCE_COMPARER" data-uid="Lucene.Net.Search.Suggest.Lookup.CHARSEQUENCE_COMPARER">CHARSEQUENCE_COMPARER</h4> |
| <div class="markdown level1 summary"><p>A simple char-by-char comparer for <span class="xref">System.String</span></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly IComparer<string> CHARSEQUENCE_COMPARER</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.Collections.Generic.IComparer</span><<span class="xref">System.String</span>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Lookup_Count.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.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.Suggest/Suggest/Lookup.cs/#L245">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_Count_" data-uid="Lucene.Net.Search.Suggest.Lookup.Count*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_Count" data-uid="Lucene.Net.Search.Suggest.Lookup.Count">Count</h4> |
| <div class="markdown level1 summary"><p>Get the number of entries the lookup was built with </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract long Count { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><p>total number of suggester entries </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Lookup_Build_Lucene_Net_Search_Spell_IDictionary_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.Build(Lucene.Net.Search.Spell.IDictionary)%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.Suggest/Suggest/Lookup.cs/#L203">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_Build_" data-uid="Lucene.Net.Search.Suggest.Lookup.Build*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_Build_Lucene_Net_Search_Spell_IDictionary_" data-uid="Lucene.Net.Search.Suggest.Lookup.Build(Lucene.Net.Search.Spell.IDictionary)">Build(IDictionary)</h4> |
| <div class="markdown level1 summary"><p>Build lookup from a dictionary. Some implementations may require sorted |
| or unsorted keys from the dictionary's iterator - use |
| <a class="xref" href="Lucene.Net.Search.Suggest.SortedInputIterator.html">SortedInputIterator</a> or |
| <a class="xref" href="Lucene.Net.Search.Suggest.UnsortedInputIterator.html">UnsortedInputIterator</a> in such case.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void Build(IDictionary dict)</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.Search.Spell.IDictionary.html">IDictionary</a></td> |
| <td><span class="parametername">dict</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_Search_Suggest_Lookup_Build_Lucene_Net_Search_Suggest_IInputIterator_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.Build(Lucene.Net.Search.Suggest.IInputIterator)%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.Suggest/Suggest/Lookup.cs/#L251">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_Build_" data-uid="Lucene.Net.Search.Suggest.Lookup.Build*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_Build_Lucene_Net_Search_Suggest_IInputIterator_" data-uid="Lucene.Net.Search.Suggest.Lookup.Build(Lucene.Net.Search.Suggest.IInputIterator)">Build(IInputIterator)</h4> |
| <div class="markdown level1 summary"><p>Builds up a new internal <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html">Lookup</a> representation based on the given <a class="xref" href="Lucene.Net.Search.Suggest.IInputIterator.html">IInputIterator</a>. |
| The implementation might re-sort the data internally.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract void Build(IInputIterator inputIterator)</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.Search.Suggest.IInputIterator.html">IInputIterator</a></td> |
| <td><span class="parametername">inputIterator</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_Search_Suggest_Lookup_DoLookup_System_String_System_Boolean_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.DoLookup(System.String%2CSystem.Boolean%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.Suggest/Suggest/Lookup.cs/#L260">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_DoLookup_" data-uid="Lucene.Net.Search.Suggest.Lookup.DoLookup*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_DoLookup_System_String_System_Boolean_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Lookup.DoLookup(System.String,System.Boolean,System.Int32)">DoLookup(String, Boolean, Int32)</h4> |
| <div class="markdown level1 summary"><p>Look up a key and return possible completion for this key. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IList<Lookup.LookupResult> DoLookup(string key, bool onlyMorePopular, int num)</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">key</span></td> |
| <td><p>lookup key. Depending on the implementation this may be |
| a prefix, misspelling, or even infix. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">onlyMorePopular</span></td> |
| <td><p>return only more popular results </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</span></td> |
| <td><p>maximum number of results to return </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>></td> |
| <td><p>a list of possible completions, with their relative weight (e.g. popularity) </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_Search_Suggest_Lookup_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.DoLookup(System.String%2CSystem.Collections.Generic.IEnumerable%7BLucene.Net.Util.BytesRef%7D%2CSystem.Boolean%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.Suggest/Suggest/Lookup.cs/#L273">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_DoLookup_" data-uid="Lucene.Net.Search.Suggest.Lookup.DoLookup*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_DoLookup_System_String_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__System_Boolean_System_Int32_" data-uid="Lucene.Net.Search.Suggest.Lookup.DoLookup(System.String,System.Collections.Generic.IEnumerable{Lucene.Net.Util.BytesRef},System.Boolean,System.Int32)">DoLookup(String, IEnumerable<BytesRef>, Boolean, Int32)</h4> |
| <div class="markdown level1 summary"><p>Look up a key and return possible completion for this key. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract IList<Lookup.LookupResult> DoLookup(string key, IEnumerable<BytesRef> contexts, bool onlyMorePopular, int num)</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">key</span></td> |
| <td><p>lookup key. Depending on the implementation this may be |
| a prefix, misspelling, or even infix. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">Lucene.Net.Util.BytesRef</span>></td> |
| <td><span class="parametername">contexts</span></td> |
| <td><p>contexts to filter the lookup by, or null if all contexts are allowed; if the suggestion contains any of the contexts, it's a match </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">onlyMorePopular</span></td> |
| <td><p>return only more popular results </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">num</span></td> |
| <td><p>maximum number of results to return </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>></td> |
| <td><p>a list of possible completions, with their relative weight (e.g. popularity) </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_Search_Suggest_Lookup_GetSizeInBytes.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.GetSizeInBytes%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.Suggest/Suggest/Lookup.cs/#L293">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_GetSizeInBytes_" data-uid="Lucene.Net.Search.Suggest.Lookup.GetSizeInBytes*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_GetSizeInBytes" data-uid="Lucene.Net.Search.Suggest.Lookup.GetSizeInBytes">GetSizeInBytes()</h4> |
| <div class="markdown level1 summary"><p>Get the size of the underlying lookup implementation in memory </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract long GetSizeInBytes()</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.Int64</span></td> |
| <td><p>ram size of the lookup implementation in bytes </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_Search_Suggest_Lookup_Load_Lucene_Net_Store_DataInput_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.Load(Lucene.Net.Store.DataInput)%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.Suggest/Suggest/Lookup.cs/#L288">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_Load_" data-uid="Lucene.Net.Search.Suggest.Lookup.Load*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_Load_Lucene_Net_Store_DataInput_" data-uid="Lucene.Net.Search.Suggest.Lookup.Load(Lucene.Net.Store.DataInput)">Load(DataInput)</h4> |
| <div class="markdown level1 summary"><p>Discard current lookup data and load it from a previously saved copy. |
| Optional operation. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract bool Load(DataInput 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.Store.DataInput</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p>the <span class="xref">Lucene.Net.Store.DataInput</span> to load the lookup data. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><p>true if completed successfully, false if unsuccessful or not supported. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>when fatal IO error occurs. </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_Search_Suggest_Lookup_Load_System_IO_Stream_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.Load(System.IO.Stream)%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.Suggest/Suggest/Lookup.cs/#L212">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_Load_" data-uid="Lucene.Net.Search.Suggest.Lookup.Load*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_Load_System_IO_Stream_" data-uid="Lucene.Net.Search.Suggest.Lookup.Load(System.IO.Stream)">Load(Stream)</h4> |
| <div class="markdown level1 summary"><p>Calls <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Load_Lucene_Net_Store_DataInput_">Load(DataInput)</a> after converting |
| <span class="xref">System.IO.Stream</span> to <span class="xref">Lucene.Net.Store.DataInput</span></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool Load(Stream 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">System.IO.Stream</span></td> |
| <td><span class="parametername">input</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.Boolean</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_Search_Suggest_Lookup_Store_Lucene_Net_Store_DataOutput_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.Store(Lucene.Net.Store.DataOutput)%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.Suggest/Suggest/Lookup.cs/#L280">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_Store_" data-uid="Lucene.Net.Search.Suggest.Lookup.Store*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_Store_Lucene_Net_Store_DataOutput_" data-uid="Lucene.Net.Search.Suggest.Lookup.Store(Lucene.Net.Store.DataOutput)">Store(DataOutput)</h4> |
| <div class="markdown level1 summary"><p>Persist the constructed lookup data to a directory. Optional operation. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract bool Store(DataOutput output)</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.Store.DataOutput</span></td> |
| <td><span class="parametername">output</span></td> |
| <td><p><span class="xref">Lucene.Net.Store.DataOutput</span> to write the data to. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><p>true if successful, false if unsuccessful or not supported. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>when fatal IO error occurs. </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_Search_Suggest_Lookup_Store_System_IO_Stream_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.Store(System.IO.Stream)%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.Suggest/Suggest/Lookup.cs/#L229">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_Lookup_Store_" data-uid="Lucene.Net.Search.Suggest.Lookup.Store*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_Lookup_Store_System_IO_Stream_" data-uid="Lucene.Net.Search.Suggest.Lookup.Store(System.IO.Stream)">Store(Stream)</h4> |
| <div class="markdown level1 summary"><p>Calls <a class="xref" href="Lucene.Net.Search.Suggest.Lookup.html#Lucene_Net_Search_Suggest_Lookup_Store_Lucene_Net_Store_DataOutput_">Store(DataOutput)</a> after converting |
| <span class="xref">System.IO.Stream</span> to <span class="xref">Lucene.Net.Store.DataOutput</span></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool Store(Stream output)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.Stream</span></td> |
| <td><span class="parametername">output</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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </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_Search_Suggest_Lookup.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup%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.Suggest/Suggest/Lookup.cs/#L31" 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> |
