| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DocumentValueSourceDictionary |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DocumentValueSourceDictionary |
| | Apache Lucene.NET 4.8.0-beta00011 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.DocumentValueSourceDictionary"> |
| |
| |
| <h1 id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary" class="text-break">Class DocumentValueSourceDictionary |
| </h1> |
| <div class="markdown level0 summary"><p> |
| Dictionary with terms and optionally payload information |
| taken from stored fields in a Lucene index. Similar to |
| <a class="xref" href="Lucene.Net.Search.Suggest.DocumentDictionary.html">DocumentDictionary</a>, except it obtains the weight |
| of the terms in a document based on a <span class="xref">Lucene.Net.Queries.Function.ValueSource</span>. |
| </p> |
| <strong>NOTE:</strong> |
| <ul><li> |
| The term and (optionally) payload fields have to be |
| stored |
| </li><li> |
| if the term or (optionally) payload fields supplied |
| do not have a value for a document, then the document is |
| rejected by the dictionary |
| </li></ul> |
| <p> |
| In practice the <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> will likely be obtained |
| using the lucene expression module. The following example shows |
| how to create a <span class="xref">Lucene.Net.Queries.Function.ValueSource</span> from a simple addition of two |
| fields: |
| <pre><code> Expression expression = JavascriptCompiler.Compile("f1 + f2"); |
| SimpleBindings bindings = new SimpleBindings(); |
| bindings.Add(new SortField("f1", SortField.Type_e.LONG)); |
| bindings.Add(new SortField("f2", SortField.Type_e.LONG)); |
| ValueSource valueSource = expression.GetValueSource(bindings);</code></pre> |
| </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"><a class="xref" href="Lucene.Net.Search.Suggest.DocumentDictionary.html">DocumentDictionary</a></div> |
| <div class="level2"><span class="xref">DocumentValueSourceDictionary</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> |
| <a class="xref" href="Lucene.Net.Search.Suggest.DocumentDictionary.html#Lucene_Net_Search_Suggest_DocumentDictionary_m_reader">DocumentDictionary.m_reader</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.DocumentDictionary.html#Lucene_Net_Search_Suggest_DocumentDictionary_m_payloadField">DocumentDictionary.m_payloadField</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Suggest.DocumentDictionary.html#Lucene_Net_Search_Suggest_DocumentDictionary_m_contextsField">DocumentDictionary.m_contextsField</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Suggest.html">Lucene.Net.Search.Suggest</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6> |
| <h5 id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class DocumentValueSourceDictionary : DocumentDictionary, 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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_Lucene_Net_Index_IndexReader_System_String_Lucene_Net_Queries_Function_ValueSource_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.%23ctor(Lucene.Net.Index.IndexReader%2CSystem.String%2CLucene.Net.Queries.Function.ValueSource)%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_beta00011/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs/#L94">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_Lucene_Net_Index_IndexReader_System_String_Lucene_Net_Queries_Function_ValueSource_" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.#ctor(Lucene.Net.Index.IndexReader,System.String,Lucene.Net.Queries.Function.ValueSource)">DocumentValueSourceDictionary(IndexReader, String, ValueSource)</h4> |
| <div class="markdown level1 summary"><p>Creates a new dictionary with the contents of the fields named <code data-dev-comment-type="paramref" class="paramref">field</code> |
| for the terms and uses the <code data-dev-comment-type="paramref" class="paramref">weightsValueSource</code> supplied to determine the |
| score.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DocumentValueSourceDictionary(IndexReader reader, string field, ValueSource weightsValueSource)</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.Index.IndexReader</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Queries.Function.ValueSource</span></td> |
| <td><span class="parametername">weightsValueSource</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_Lucene_Net_Index_IndexReader_System_String_Lucene_Net_Queries_Function_ValueSource_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.%23ctor(Lucene.Net.Index.IndexReader%2CSystem.String%2CLucene.Net.Queries.Function.ValueSource%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_beta00011/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs/#L83">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_Lucene_Net_Index_IndexReader_System_String_Lucene_Net_Queries_Function_ValueSource_System_String_" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.#ctor(Lucene.Net.Index.IndexReader,System.String,Lucene.Net.Queries.Function.ValueSource,System.String)">DocumentValueSourceDictionary(IndexReader, String, ValueSource, String)</h4> |
| <div class="markdown level1 summary"><p>Creates a new dictionary with the contents of the fields named <code data-dev-comment-type="paramref" class="paramref">field</code> |
| for the terms, <code data-dev-comment-type="paramref" class="paramref">payload</code> for the corresponding payloads |
| and uses the <code data-dev-comment-type="paramref" class="paramref">weightsValueSource</code> supplied to determine the |
| score.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DocumentValueSourceDictionary(IndexReader reader, string field, ValueSource weightsValueSource, string payload)</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.Index.IndexReader</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Queries.Function.ValueSource</span></td> |
| <td><span class="parametername">weightsValueSource</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">payload</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_Lucene_Net_Index_IndexReader_System_String_Lucene_Net_Queries_Function_ValueSource_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.%23ctor(Lucene.Net.Index.IndexReader%2CSystem.String%2CLucene.Net.Queries.Function.ValueSource%2CSystem.String%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_beta00011/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs/#L72">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary__ctor_Lucene_Net_Index_IndexReader_System_String_Lucene_Net_Queries_Function_ValueSource_System_String_System_String_" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.#ctor(Lucene.Net.Index.IndexReader,System.String,Lucene.Net.Queries.Function.ValueSource,System.String,System.String)">DocumentValueSourceDictionary(IndexReader, String, ValueSource, String, String)</h4> |
| <div class="markdown level1 summary"><p>Creates a new dictionary with the contents of the fields named <code data-dev-comment-type="paramref" class="paramref">field</code> |
| for the terms, <code data-dev-comment-type="paramref" class="paramref">payload</code> for the corresponding payloads, <code data-dev-comment-type="paramref" class="paramref">contexts</code> |
| for the associated contexts and uses the <code data-dev-comment-type="paramref" class="paramref">weightsValueSource</code> supplied |
| to determine the score.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DocumentValueSourceDictionary(IndexReader reader, string field, ValueSource weightsValueSource, string payload, string contexts)</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.Index.IndexReader</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">field</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Queries.Function.ValueSource</span></td> |
| <td><span class="parametername">weightsValueSource</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">payload</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">contexts</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_DocumentValueSourceDictionary_GetEntryIterator.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs/#L100">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary_GetEntryIterator_" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.GetEntryIterator*"></a> |
| <h4 id="Lucene_Net_Search_Suggest_DocumentValueSourceDictionary_GetEntryIterator" data-uid="Lucene.Net.Search.Suggest.DocumentValueSourceDictionary.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 override 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Suggest.DocumentDictionary.html#Lucene_Net_Search_Suggest_DocumentDictionary_GetEntryIterator">DocumentDictionary.GetEntryIterator()</a></div> |
| <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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_DocumentValueSourceDictionary.md&value=---%0Auid%3A%20Lucene.Net.Search.Suggest.DocumentValueSourceDictionary%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_beta00011/src/Lucene.Net.Suggest/Suggest/DocumentValueSourceDictionary.cs/#L61" 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> |