| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class MultiTermQuery.TopTermsScoringBooleanQueryRewrite |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class MultiTermQuery.TopTermsScoringBooleanQueryRewrite |
| | Apache Lucene.NET 4.8.0-beta00009 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="core/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.MultiTermQuery.TopTermsScoringBooleanQueryRewrite"> |
| |
| |
| <h1 id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite" class="text-break">Class MultiTermQuery.TopTermsScoringBooleanQueryRewrite |
| </h1> |
| <div class="markdown level0 summary"><p>A rewrite method that first translates each term into |
| <a class="xref" href="Lucene.Net.Search.Occur.html#Lucene_Net_Search_Occur_SHOULD">SHOULD</a> clause in a <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>, and keeps the |
| scores as computed by the query.</p> |
| <p><p> |
| This rewrite method only uses the top scoring terms so it will not overflow |
| the boolean max clause count. It is the default rewrite method for |
| <a class="xref" href="Lucene.Net.Search.FuzzyQuery.html">FuzzyQuery</a>.</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.MultiTermQuery.RewriteMethod.html">MultiTermQuery.RewriteMethod</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.TermCollectingRewrite-1.html">TermCollectingRewrite</a><<a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Search.TopTermsRewrite-1.html">TopTermsRewrite</a><<a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>></div> |
| <div class="level4"><span class="xref">MultiTermQuery.TopTermsScoringBooleanQueryRewrite</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopTermsRewrite-1.html#Lucene_Net_Search_TopTermsRewrite_1_Count">TopTermsRewrite<BooleanQuery>.Count</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopTermsRewrite-1.html#Lucene_Net_Search_TopTermsRewrite_1_Rewrite_Lucene_Net_Index_IndexReader_Lucene_Net_Search_MultiTermQuery_">TopTermsRewrite<BooleanQuery>.Rewrite(IndexReader, MultiTermQuery)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopTermsRewrite-1.html#Lucene_Net_Search_TopTermsRewrite_1_GetHashCode">TopTermsRewrite<BooleanQuery>.GetHashCode()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TopTermsRewrite-1.html#Lucene_Net_Search_TopTermsRewrite_1_Equals_System_Object_">TopTermsRewrite<BooleanQuery>.Equals(Object)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.TermCollectingRewrite-1.html#Lucene_Net_Search_TermCollectingRewrite_1_AddClause__0_Lucene_Net_Index_Term_System_Int32_System_Single_">TermCollectingRewrite<BooleanQuery>.AddClause(BooleanQuery, Term, Int32, Single)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.MultiTermQuery.RewriteMethod.html#Lucene_Net_Search_MultiTermQuery_RewriteMethod_GetTermsEnum_Lucene_Net_Search_MultiTermQuery_Lucene_Net_Index_Terms_Lucene_Net_Util_AttributeSource_">MultiTermQuery.RewriteMethod.GetTermsEnum(MultiTermQuery, Terms, AttributeSource)</a> |
| </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> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.html">Lucene.Net.Search</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class TopTermsScoringBooleanQueryRewrite : TopTermsRewrite<BooleanQuery>, ITopTermsRewrite</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite__ctor_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.%23ctor(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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net/Search/MultiTermQuery.cs/#L160">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite__ctor_" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite__ctor_System_Int32_" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.#ctor(System.Int32)">TopTermsScoringBooleanQueryRewrite(Int32)</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.html">MultiTermQuery.TopTermsScoringBooleanQueryRewrite</a> for |
| at most <code data-dev-comment-type="paramref" class="paramref">size</code> terms. |
| <p> |
| NOTE: if <a class="xref" href="Lucene.Net.Search.BooleanQuery.html#Lucene_Net_Search_BooleanQuery_MaxClauseCount">MaxClauseCount</a> is smaller than |
| <code data-dev-comment-type="paramref" class="paramref">size</code>, then it will be used instead.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public TopTermsScoringBooleanQueryRewrite(int size)</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">size</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_MaxSize.md&value=---%0Auid%3A%20Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.MaxSize%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-poc/src/Lucene.Net/Search/MultiTermQuery.cs/#L165">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_MaxSize_" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.MaxSize*"></a> |
| <h4 id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_MaxSize" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.MaxSize">MaxSize</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">protected override int MaxSize { 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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Search.TopTermsRewrite<Lucene.Net.Search.BooleanQuery>.MaxSize</span></div> |
| <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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_AddClause_Lucene_Net_Search_BooleanQuery_Lucene_Net_Index_Term_System_Int32_System_Single_Lucene_Net_Index_TermContext_.md&value=---%0Auid%3A%20Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.AddClause(Lucene.Net.Search.BooleanQuery%2CLucene.Net.Index.Term%2CSystem.Int32%2CSystem.Single%2CLucene.Net.Index.TermContext)%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-poc/src/Lucene.Net/Search/MultiTermQuery.cs/#L178">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_AddClause_" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.AddClause*"></a> |
| <h4 id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_AddClause_Lucene_Net_Search_BooleanQuery_Lucene_Net_Index_Term_System_Int32_System_Single_Lucene_Net_Index_TermContext_" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.AddClause(Lucene.Net.Search.BooleanQuery,Lucene.Net.Index.Term,System.Int32,System.Single,Lucene.Net.Index.TermContext)">AddClause(BooleanQuery, Term, Int32, Single, TermContext)</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">protected override void AddClause(BooleanQuery topLevel, Term term, int docCount, float boost, TermContext states)</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.BooleanQuery.html">BooleanQuery</a></td> |
| <td><span class="parametername">topLevel</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.Term.html">Term</a></td> |
| <td><span class="parametername">term</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docCount</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">boost</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a></td> |
| <td><span class="parametername">states</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Search.TermCollectingRewrite<Lucene.Net.Search.BooleanQuery>.AddClause(Lucene.Net.Search.BooleanQuery, Lucene.Net.Index.Term, System.Int32, System.Single, Lucene.Net.Index.TermContext)</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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_GetTopLevelQuery.md&value=---%0Auid%3A%20Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.GetTopLevelQuery%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-poc/src/Lucene.Net/Search/MultiTermQuery.cs/#L173">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_GetTopLevelQuery_" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.GetTopLevelQuery*"></a> |
| <h4 id="Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite_GetTopLevelQuery" data-uid="Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite.GetTopLevelQuery">GetTopLevelQuery()</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">protected override BooleanQuery GetTopLevelQuery()</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.BooleanQuery.html">BooleanQuery</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Search.TermCollectingRewrite<Lucene.Net.Search.BooleanQuery>.GetTopLevelQuery()</span></div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.MultiTermQuery.html#Lucene_Net_Search_MultiTermQuery_MultiTermRewriteMethod">MultiTermRewriteMethod</a></div> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_MultiTermQuery_TopTermsScoringBooleanQueryRewrite.md&value=---%0Auid%3A%20Lucene.Net.Search.MultiTermQuery.TopTermsScoringBooleanQueryRewrite%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/docs-poc/src/Lucene.Net/Search/MultiTermQuery.cs/#L151" 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> |