| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DrillSideways |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DrillSideways |
| | 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="facet/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.Facet.DrillSideways"> |
| |
| |
| <h1 id="Lucene_Net_Facet_DrillSideways" data-uid="Lucene.Net.Facet.DrillSideways" class="text-break">Class DrillSideways |
| </h1> |
| <div class="markdown level0 summary"><p>Computes drill down and sideways counts for the provided |
| <a class="xref" href="Lucene.Net.Facet.DrillDownQuery.html">DrillDownQuery</a>. Drill sideways counts include |
| alternative values/aggregates for the drill-down |
| dimensions so that a dimension does not disappear after |
| the user drills down into it.</p> |
| <p> Use one of the static search |
| methods to do the search, and then get the hits and facet |
| results from the returned <a class="xref" href="Lucene.Net.Facet.DrillSidewaysResult.html">DrillSidewaysResult</a>. |
| |
| </p> |
| <p><strong>NOTE</strong>: this allocates one <a class="xref" href="Lucene.Net.Facet.FacetsCollector.html">FacetsCollector</a> |
| for each drill-down, plus one. If your |
| index has high number of facet labels then this will |
| multiply your memory usage. |
| |
| @lucene.experimental |
| </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">DrillSideways</span></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="package.html">Lucene.Net.Facet</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Facet.dll</h6> |
| <h5 id="Lucene_Net_Facet_DrillSideways_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class DrillSideways</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_Facet_DrillSideways__ctor_Lucene_Net_Search_IndexSearcher_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Facet_SortedSet_SortedSetDocValuesReaderState_.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.%23ctor(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Facet.FacetsConfig%2CLucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState)%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.Facet/DrillSideways.cs/#L83">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways__ctor_" data-uid="Lucene.Net.Facet.DrillSideways.#ctor*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways__ctor_Lucene_Net_Search_IndexSearcher_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Facet_SortedSet_SortedSetDocValuesReaderState_" data-uid="Lucene.Net.Facet.DrillSideways.#ctor(Lucene.Net.Search.IndexSearcher,Lucene.Net.Facet.FacetsConfig,Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState)">DrillSideways(IndexSearcher, FacetsConfig, SortedSetDocValuesReaderState)</h4> |
| <div class="markdown level1 summary"><p>Create a new <a class="xref" href="Lucene.Net.Facet.DrillSideways.html">DrillSideways</a> instance, assuming the categories were |
| indexed with <a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField.html">SortedSetDocValuesFacetField</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DrillSideways(IndexSearcher searcher, FacetsConfig config, SortedSetDocValuesReaderState state)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a></td> |
| <td><span class="parametername">config</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState.html">SortedSetDocValuesReaderState</a></td> |
| <td><span class="parametername">state</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_Facet_DrillSideways__ctor_Lucene_Net_Search_IndexSearcher_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Facet_Taxonomy_TaxonomyReader_.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.%23ctor(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Facet.FacetsConfig%2CLucene.Net.Facet.Taxonomy.TaxonomyReader)%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.Facet/DrillSideways.cs/#L74">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways__ctor_" data-uid="Lucene.Net.Facet.DrillSideways.#ctor*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways__ctor_Lucene_Net_Search_IndexSearcher_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Facet_Taxonomy_TaxonomyReader_" data-uid="Lucene.Net.Facet.DrillSideways.#ctor(Lucene.Net.Search.IndexSearcher,Lucene.Net.Facet.FacetsConfig,Lucene.Net.Facet.Taxonomy.TaxonomyReader)">DrillSideways(IndexSearcher, FacetsConfig, TaxonomyReader)</h4> |
| <div class="markdown level1 summary"><p>Create a new <a class="xref" href="Lucene.Net.Facet.DrillSideways.html">DrillSideways</a> instance.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DrillSideways(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a></td> |
| <td><span class="parametername">config</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.Taxonomy.TaxonomyReader.html">TaxonomyReader</a></td> |
| <td><span class="parametername">taxoReader</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_Facet_DrillSideways__ctor_Lucene_Net_Search_IndexSearcher_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Facet_Taxonomy_TaxonomyReader_Lucene_Net_Facet_SortedSet_SortedSetDocValuesReaderState_.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.%23ctor(Lucene.Net.Search.IndexSearcher%2CLucene.Net.Facet.FacetsConfig%2CLucene.Net.Facet.Taxonomy.TaxonomyReader%2CLucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState)%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.Facet/DrillSideways.cs/#L93">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways__ctor_" data-uid="Lucene.Net.Facet.DrillSideways.#ctor*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways__ctor_Lucene_Net_Search_IndexSearcher_Lucene_Net_Facet_FacetsConfig_Lucene_Net_Facet_Taxonomy_TaxonomyReader_Lucene_Net_Facet_SortedSet_SortedSetDocValuesReaderState_" data-uid="Lucene.Net.Facet.DrillSideways.#ctor(Lucene.Net.Search.IndexSearcher,Lucene.Net.Facet.FacetsConfig,Lucene.Net.Facet.Taxonomy.TaxonomyReader,Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState)">DrillSideways(IndexSearcher, FacetsConfig, TaxonomyReader, SortedSetDocValuesReaderState)</h4> |
| <div class="markdown level1 summary"><p>Create a new <a class="xref" href="Lucene.Net.Facet.DrillSideways.html">DrillSideways</a> instance, where some |
| dimensions were indexed with <a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField.html">SortedSetDocValuesFacetField</a> |
| and others were indexed with <a class="xref" href="Lucene.Net.Facet.FacetField.html">FacetField</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public DrillSideways(IndexSearcher searcher, FacetsConfig config, TaxonomyReader taxoReader, SortedSetDocValuesReaderState state)</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.Search.IndexSearcher</span></td> |
| <td><span class="parametername">searcher</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a></td> |
| <td><span class="parametername">config</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.Taxonomy.TaxonomyReader.html">TaxonomyReader</a></td> |
| <td><span class="parametername">taxoReader</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState.html">SortedSetDocValuesReaderState</a></td> |
| <td><span class="parametername">state</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_DrillSideways_m_config.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.m_config%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.Facet/DrillSideways.cs/#L69">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Facet_DrillSideways_m_config" data-uid="Lucene.Net.Facet.DrillSideways.m_config">m_config</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a> passed to constructor.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected readonly FacetsConfig m_config</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><a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a></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_Facet_DrillSideways_m_searcher.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.m_searcher%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.Facet/DrillSideways.cs/#L53">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Facet_DrillSideways_m_searcher" data-uid="Lucene.Net.Facet.DrillSideways.m_searcher">m_searcher</h4> |
| <div class="markdown level1 summary"><p><span class="xref">Lucene.Net.Search.IndexSearcher</span> passed to constructor.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected readonly IndexSearcher m_searcher</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">Lucene.Net.Search.IndexSearcher</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_Facet_DrillSideways_m_state.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.m_state%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.Facet/DrillSideways.cs/#L64">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Facet_DrillSideways_m_state" data-uid="Lucene.Net.Facet.DrillSideways.m_state">m_state</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState.html">SortedSetDocValuesReaderState</a> passed to |
| constructor; can be <code>null</code>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected readonly SortedSetDocValuesReaderState m_state</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><a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesReaderState.html">SortedSetDocValuesReaderState</a></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_Facet_DrillSideways_m_taxoReader.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.m_taxoReader%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.Facet/DrillSideways.cs/#L58">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Facet_DrillSideways_m_taxoReader" data-uid="Lucene.Net.Facet.DrillSideways.m_taxoReader">m_taxoReader</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Facet.Taxonomy.TaxonomyReader.html">TaxonomyReader</a> passed to constructor.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected readonly TaxonomyReader m_taxoReader</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><a class="xref" href="Lucene.Net.Facet.Taxonomy.TaxonomyReader.html">TaxonomyReader</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_DrillSideways_BuildFacetsResult_Lucene_Net_Facet_FacetsCollector_Lucene_Net_Facet_FacetsCollector___System_String___.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.BuildFacetsResult(Lucene.Net.Facet.FacetsCollector%2CLucene.Net.Facet.FacetsCollector%5B%5D%2CSystem.String%5B%5D)%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.Facet/DrillSideways.cs/#L105">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways_BuildFacetsResult_" data-uid="Lucene.Net.Facet.DrillSideways.BuildFacetsResult*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways_BuildFacetsResult_Lucene_Net_Facet_FacetsCollector_Lucene_Net_Facet_FacetsCollector___System_String___" data-uid="Lucene.Net.Facet.DrillSideways.BuildFacetsResult(Lucene.Net.Facet.FacetsCollector,Lucene.Net.Facet.FacetsCollector[],System.String[])">BuildFacetsResult(FacetsCollector, FacetsCollector[], String[])</h4> |
| <div class="markdown level1 summary"><p>Subclass can override to customize per-dim Facets |
| impl. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual Facets BuildFacetsResult(FacetsCollector drillDowns, FacetsCollector[] drillSideways, string[] drillSidewaysDims)</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.Facet.FacetsCollector.html">FacetsCollector</a></td> |
| <td><span class="parametername">drillDowns</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.FacetsCollector.html">FacetsCollector</a>[]</td> |
| <td><span class="parametername">drillSideways</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">drillSidewaysDims</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><a class="xref" href="Lucene.Net.Facet.Facets.html">Facets</a></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_Facet_DrillSideways_ScoreSubDocsAtOnce.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.ScoreSubDocsAtOnce%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.Facet/DrillSideways.cs/#L264">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways_ScoreSubDocsAtOnce_" data-uid="Lucene.Net.Facet.DrillSideways.ScoreSubDocsAtOnce*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways_ScoreSubDocsAtOnce" data-uid="Lucene.Net.Facet.DrillSideways.ScoreSubDocsAtOnce">ScoreSubDocsAtOnce()</h4> |
| <div class="markdown level1 summary"><p>Override this and return true if your collector |
| (e.g., <span class="xref">Lucene.Net.Join.ToParentBlockJoinCollector</span>) expects all |
| sub-scorers to be positioned on the document being |
| collected. This will cause some performance loss; |
| default is <code>false</code>. Note that if you return true from |
| this method (in a subclass) be sure your collector |
| also returns <code>false</code> from <span class="xref">Lucene.Net.Search.ICollector.AcceptsDocsOutOfOrder</span>: |
| this will trick <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a> into also scoring all subDocs at |
| once. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual bool ScoreSubDocsAtOnce()</code></pre> |
| </div> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_Facet_DrillSideways_Search_Lucene_Net_Facet_DrillDownQuery_Lucene_Net_Search_Filter_Lucene_Net_Search_FieldDoc_System_Int32_Lucene_Net_Search_Sort_System_Boolean_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Facet.DrillDownQuery%2CLucene.Net.Search.Filter%2CLucene.Net.Search.FieldDoc%2CSystem.Int32%2CLucene.Net.Search.Sort%2CSystem.Boolean%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/DrillSideways.cs/#L203">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways_Search_" data-uid="Lucene.Net.Facet.DrillSideways.Search*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways_Search_Lucene_Net_Facet_DrillDownQuery_Lucene_Net_Search_Filter_Lucene_Net_Search_FieldDoc_System_Int32_Lucene_Net_Search_Sort_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Facet.DrillDownQuery,Lucene.Net.Search.Filter,Lucene.Net.Search.FieldDoc,System.Int32,Lucene.Net.Search.Sort,System.Boolean,System.Boolean)">Search(DrillDownQuery, Filter, FieldDoc, Int32, Sort, Boolean, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Search, sorting by <span class="xref">Lucene.Net.Search.Sort</span>, and computing |
| drill down and sideways counts.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual DrillSidewaysResult Search(DrillDownQuery query, Filter filter, FieldDoc after, int topN, Sort sort, bool doDocScores, bool doMaxScore)</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.Facet.DrillDownQuery.html">DrillDownQuery</a></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Filter</span></td> |
| <td><span class="parametername">filter</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.FieldDoc</span></td> |
| <td><span class="parametername">after</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">topN</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Sort</span></td> |
| <td><span class="parametername">sort</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">doDocScores</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">doMaxScore</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><a class="xref" href="Lucene.Net.Facet.DrillSidewaysResult.html">DrillSidewaysResult</a></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_Facet_DrillSideways_Search_Lucene_Net_Facet_DrillDownQuery_Lucene_Net_Search_ICollector_.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Facet.DrillDownQuery%2CLucene.Net.Search.ICollector)%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.Facet/DrillSideways.cs/#L148">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways_Search_" data-uid="Lucene.Net.Facet.DrillSideways.Search*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways_Search_Lucene_Net_Facet_DrillDownQuery_Lucene_Net_Search_ICollector_" data-uid="Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Facet.DrillDownQuery,Lucene.Net.Search.ICollector)">Search(DrillDownQuery, ICollector)</h4> |
| <div class="markdown level1 summary"><p>Search, collecting hits with a <span class="xref">Lucene.Net.Search.ICollector</span>, and |
| computing drill down and sideways counts.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual DrillSidewaysResult Search(DrillDownQuery query, ICollector hitCollector)</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.Facet.DrillDownQuery.html">DrillDownQuery</a></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.ICollector</span></td> |
| <td><span class="parametername">hitCollector</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><a class="xref" href="Lucene.Net.Facet.DrillSidewaysResult.html">DrillSidewaysResult</a></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_Facet_DrillSideways_Search_Lucene_Net_Facet_DrillDownQuery_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Facet.DrillDownQuery%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.Facet/DrillSideways.cs/#L231">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways_Search_" data-uid="Lucene.Net.Facet.DrillSideways.Search*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways_Search_Lucene_Net_Facet_DrillDownQuery_System_Int32_" data-uid="Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Facet.DrillDownQuery,System.Int32)">Search(DrillDownQuery, Int32)</h4> |
| <div class="markdown level1 summary"><p>Search, sorting by score, and computing |
| drill down and sideways counts.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual DrillSidewaysResult Search(DrillDownQuery query, int topN)</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.Facet.DrillDownQuery.html">DrillDownQuery</a></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">topN</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><a class="xref" href="Lucene.Net.Facet.DrillSidewaysResult.html">DrillSidewaysResult</a></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_Facet_DrillSideways_Search_Lucene_Net_Search_ScoreDoc_Lucene_Net_Facet_DrillDownQuery_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Search.ScoreDoc%2CLucene.Net.Facet.DrillDownQuery%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.Facet/DrillSideways.cs/#L240">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_DrillSideways_Search_" data-uid="Lucene.Net.Facet.DrillSideways.Search*"></a> |
| <h4 id="Lucene_Net_Facet_DrillSideways_Search_Lucene_Net_Search_ScoreDoc_Lucene_Net_Facet_DrillDownQuery_System_Int32_" data-uid="Lucene.Net.Facet.DrillSideways.Search(Lucene.Net.Search.ScoreDoc,Lucene.Net.Facet.DrillDownQuery,System.Int32)">Search(ScoreDoc, DrillDownQuery, Int32)</h4> |
| <div class="markdown level1 summary"><p>Search, sorting by score, and computing |
| drill down and sideways counts.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual DrillSidewaysResult Search(ScoreDoc after, DrillDownQuery query, int topN)</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.Search.ScoreDoc</span></td> |
| <td><span class="parametername">after</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Facet.DrillDownQuery.html">DrillDownQuery</a></td> |
| <td><span class="parametername">query</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">topN</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><a class="xref" href="Lucene.Net.Facet.DrillSidewaysResult.html">DrillSidewaysResult</a></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_Facet_DrillSideways.md&value=---%0Auid%3A%20Lucene.Net.Facet.DrillSideways%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.Facet/DrillSideways.cs/#L48" 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> |