| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class FileDictionary |
| | Apache Lucene.NET 4.8.0 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class FileDictionary |
| | Apache Lucene.NET 4.8.0 Documentation "> |
| <meta name="generator" content="docfx 2.47.0.0"> |
| |
| <link rel="shortcut icon" href="../../logo/favicon.ico"> |
| <link rel="stylesheet" href="../../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../../styles/docfx.css"> |
| <link rel="stylesheet" href="../../styles/main.css"> |
| <meta property="docfx:navrel" content="../../toc.html"> |
| <meta property="docfx:tocrel" content="../toc.html"> |
| |
| <meta property="docfx:rel" content="../../"> |
| |
| </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="../../index.html"> |
| <img id="logo" class="svg" src="../../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" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></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.FileDictionary"> |
| |
| |
| <h1 id="Lucene_Net_Search_Suggest_FileDictionary" data-uid="Lucene.Net.Search.Suggest.FileDictionary" class="text-break">Class FileDictionary |
| </h1> |
| <div class="markdown level0 summary"><p>Dictionary represented by a text file.</p> |
| <p>Format allowed: 1 entry per line:</p> |
| <p>An entry can be: </p> |
| <ol><li>suggestion</li><li>suggestion <span class="xref">Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter</span> weight</li><li>suggestion <span class="xref">Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter</span> weight <span class="xref">Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter</span> payload</li></ol> |
| where the default <span class="xref">Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter</span> is <a class="xref" href="Lucene.Net.Search.Suggest.FileDictionary.html#Lucene_Net_Search_Suggest_FileDictionary_DEFAULT_FIELD_DELIMITER">DEFAULT_FIELD_DELIMITER</a> (a tab) |
| <p> |
| <strong>NOTE:</strong> |
| <ol><li>In order to have payload enabled, the first entry has to have a payload</li><li>If the weight for an entry is not specified then a value of 1 is used</li><li>A payload cannot be specified without having the weight specified for an entry</li><li>If the payload for an entry is not specified (assuming payload is enabled) |
| then an empty payload is returned</li><li>An entry cannot have more than two <span class="xref">Lucene.Net.Search.Suggest.FileDictionary.fieldDelimiter</span>s</li></ol> |
| </p> |
| <code>Example:</code><p> |
| word1 word2 TAB 100 TAB payload1<p> |
| word3 TAB 101<p> |
| word4 word3 TAB 102<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">FileDictionary</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Spell.IDictionary.html">IDictionary</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_FileDictionary_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class FileDictionary : IDictionary</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_Stream_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.FileDictionary.%23ctor(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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs/#L75">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_FileDictionary__ctor_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_Stream_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor(System.IO.Stream)">FileDictionary(Stream)</h4> |
| <div class="markdown level1 summary"><p>Creates a dictionary based on an inputstream. |
| Using <a class="xref" href="Lucene.Net.Search.Suggest.FileDictionary.html#Lucene_Net_Search_Suggest_FileDictionary_DEFAULT_FIELD_DELIMITER">DEFAULT_FIELD_DELIMITER</a> as the |
| field seperator in a line. |
| <p> |
| NOTE: content is treated as UTF-8 |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FileDictionary(Stream dictFile)</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">dictFile</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_Stream_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.FileDictionary.%23ctor(System.IO.Stream%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs/#L109">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_FileDictionary__ctor_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_Stream_System_String_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor(System.IO.Stream,System.String)">FileDictionary(Stream, String)</h4> |
| <div class="markdown level1 summary"><p>Creates a dictionary based on an inputstream. |
| Using <code data-dev-comment-type="paramref" class="paramref">fieldDelimiter</code> to seperate out the |
| fields in a line. |
| <p> |
| NOTE: content is treated as UTF-8 |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FileDictionary(Stream dictFile, string fieldDelimiter)</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">dictFile</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldDelimiter</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_TextReader_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.FileDictionary.%23ctor(System.IO.TextReader)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs/#L85">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_FileDictionary__ctor_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_TextReader_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor(System.IO.TextReader)">FileDictionary(TextReader)</h4> |
| <div class="markdown level1 summary"><p>Creates a dictionary based on a reader. |
| Using <a class="xref" href="Lucene.Net.Search.Suggest.FileDictionary.html#Lucene_Net_Search_Suggest_FileDictionary_DEFAULT_FIELD_DELIMITER">DEFAULT_FIELD_DELIMITER</a> as the |
| field seperator in a line.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FileDictionary(TextReader reader)</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.TextReader</span></td> |
| <td><span class="parametername">reader</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_TextReader_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.FileDictionary.%23ctor(System.IO.TextReader%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs/#L95">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_FileDictionary__ctor_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_FileDictionary__ctor_System_IO_TextReader_System_String_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.#ctor(System.IO.TextReader,System.String)">FileDictionary(TextReader, String)</h4> |
| <div class="markdown level1 summary"><p>Creates a dictionary based on a reader. |
| Using <code data-dev-comment-type="paramref" class="paramref">fieldDelimiter</code> to seperate out the |
| fields in a line.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FileDictionary(TextReader reader, string fieldDelimiter)</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.TextReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldDelimiter</span></td> |
| <td></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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_FileDictionary_DEFAULT_FIELD_DELIMITER.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.FileDictionary.DEFAULT_FIELD_DELIMITER%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs/#L61">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Suggest_FileDictionary_DEFAULT_FIELD_DELIMITER" data-uid="Lucene.Net.Search.Suggest.FileDictionary.DEFAULT_FIELD_DELIMITER">DEFAULT_FIELD_DELIMITER</h4> |
| <div class="markdown level1 summary"><p>Tab-delimited fields are most common thus the default, but one can override this via the constructor</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_FIELD_DELIMITER = "\t"</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_FileDictionary_GetEntryIterator.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.FileDictionary.GetEntryIterator%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs/#L115">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_FileDictionary_GetEntryIterator_" data-uid="Lucene.Net.Search.Suggest.FileDictionary.GetEntryIterator*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_FileDictionary_GetEntryIterator" data-uid="Lucene.Net.Search.Suggest.FileDictionary.GetEntryIterator">GetEntryIterator()</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 virtual IInputIterator GetEntryIterator()</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><a class="xref" href="Lucene.Net.Search.Suggest.IInputIterator.html">IInputIterator</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Spell.IDictionary.html">IDictionary</a> |
| </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_FileDictionary.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.FileDictionary%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Suggest/Suggest/FileDictionary.cs/#L55" 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="../../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../../styles/docfx.js"></script> |
| <script type="text/javascript" src="../../styles/main.js"></script> |
| </body> |
| </html> |
