| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class ReadTask |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class ReadTask |
| | 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="benchmark/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.Benchmarks.ByTask.Tasks.ReadTask"> |
| |
| |
| <h1 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask" class="text-break">Class ReadTask |
| </h1> |
| <div class="markdown level0 summary"><p>Read index (abstract) task. |
| Sub classes implement <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithSearch">WithSearch</a>, <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithWarm">WithWarm</a>, <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithTraverse">WithTraverse</a> and <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithRetrieve">WithRetrieve</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.Benchmarks.ByTask.Tasks.PerfTask.html">PerfTask</a></div> |
| <div class="level2"><span class="xref">ReadTask</span></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTask.html">SearchTask</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchTravTask.html">SearchTravTask</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.SearchWithSortTask.html">SearchWithSortTask</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.WarmTask.html">WarmTask</a></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_logStep">PerfTask.m_logStep</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_m_params">PerfTask.m_params</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_NEW_LINE">PerfTask.NEW_LINE</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetRunInBackground_System_Int32_">PerfTask.SetRunInBackground(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunInBackground">PerfTask.RunInBackground</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_BackgroundDeltaPriority">PerfTask.BackgroundDeltaPriority</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Stop">PerfTask.Stop</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_StopNow">PerfTask.StopNow()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Clone">PerfTask.Clone()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose">PerfTask.Dispose()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Dispose_System_Boolean_">PerfTask.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunAndMaybeStats_System_Boolean_">PerfTask.RunAndMaybeStats(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetName">PerfTask.GetName()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetName_System_String_">PerfTask.SetName(String)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_RunData">PerfTask.RunData</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Depth">PerfTask.Depth</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ToString">PerfTask.ToString()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_GetLogMessage_System_Int32_">PerfTask.GetLogMessage(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNeverLogAtStart">PerfTask.ShouldNeverLogAtStart</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_ShouldNotRecordStats">PerfTask.ShouldNotRecordStats</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_TearDown">PerfTask.TearDown()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SupportsParams">PerfTask.SupportsParams</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SetParams_System_String_">PerfTask.SetParams(String)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Params">PerfTask.Params</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DisableCounting">PerfTask.DisableCounting</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_AlgLineNum">PerfTask.AlgLineNum</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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.html">Lucene.Net.Benchmarks.ByTask.Tasks</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Benchmark.dll</h6> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class ReadTask : PerfTask, IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>Note: All ReadTasks reuse the reader if it is already open. |
| Otherwise a reader is opened at start and closed at the end. |
| <p> |
| The <code>search.num.hits</code> config parameter sets |
| the top number of hits to collect during searching. If |
| <code>print.hits.field</code> is set, then each hit is |
| printed along with the value of that field. |
| <p> |
| Other side effects: none.</p> |
| </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_Benchmarks_ByTask_Tasks_ReadTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.%23ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L51">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask__ctor_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.#ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)">ReadTask(PerfRunData)</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 ReadTask(PerfRunData runData)</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.Benchmarks.ByTask.PerfRunData.html">PerfRunData</a></td> |
| <td><span class="parametername">runData</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_NumHits.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.NumHits%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L278">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_NumHits_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.NumHits*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_NumHits" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.NumHits">NumHits</h4> |
| <div class="markdown level1 summary"><p>Specify the number of hits to retrieve. Tasks should override this if they want to restrict the number |
| of hits that are collected during searching. Must be greater than 0. |
| <p> |
| Returns 10 by default, or <code>search.num.hits</code> config if set.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int NumHits { 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> |
| <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_Benchmarks_ByTask_Tasks_ReadTask_NumToHighlight.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.NumToHighlight%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L288">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_NumToHighlight_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.NumToHighlight*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_NumToHighlight" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.NumToHighlight">NumToHighlight</h4> |
| <div class="markdown level1 summary"><p>The number of documents to highlight. 0 means no docs will be highlighted.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int NumToHighlight { 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> |
| <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_Benchmarks_ByTask_Tasks_ReadTask_Sort.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.Sort%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L301">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_Sort_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.Sort*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_Sort" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.Sort">Sort</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 Sort Sort { 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">Lucene.Net.Search.Sort</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_Benchmarks_ByTask_Tasks_ReadTask_TraversalSize.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.TraversalSize%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L261">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_TraversalSize_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.TraversalSize*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_TraversalSize" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.TraversalSize">TraversalSize</h4> |
| <div class="markdown level1 summary"><p>Specify the number of hits to traverse. Tasks should override this if they want to restrict the number |
| of hits that are traversed when <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithTraverse">WithTraverse</a> is <code>true</code>. Must be greater than 0. |
| <p> |
| Read task calculates the traversal as: <code>Math.Min(hits.Length, TraversalSize)</code></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int TraversalSize { 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 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_TraversalSize_remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Unless overridden, the return value is <span class="xref">System.Int32.MaxValue</span>.</p> |
| </div> |
| <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_Benchmarks_ByTask_Tasks_ReadTask_WithCollector.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithCollector%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L227">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithCollector_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithCollector*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithCollector" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithCollector">WithCollector</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 bool WithCollector { 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.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_Benchmarks_ByTask_Tasks_ReadTask_WithMaxScore.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithMaxScore%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L250">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithMaxScore_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithMaxScore*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithMaxScore" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithMaxScore">WithMaxScore</h4> |
| <div class="markdown level1 summary"><p>Whether maxScores should be computed (only useful with |
| field sort)</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool WithMaxScore { 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.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_Benchmarks_ByTask_Tasks_ReadTask_WithRetrieve.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithRetrieve%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L283">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithRetrieve_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithRetrieve*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithRetrieve" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithRetrieve">WithRetrieve</h4> |
| <div class="markdown level1 summary"><p>Return <code>true</code> if, with search & results traversing, docs should be retrieved.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract bool WithRetrieve { 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.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_Benchmarks_ByTask_Tasks_ReadTask_WithScore.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithScore%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L244">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithScore_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithScore*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithScore" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithScore">WithScore</h4> |
| <div class="markdown level1 summary"><p>Whether scores should be computed (only useful with |
| field sort)</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool WithScore { 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.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_Benchmarks_ByTask_Tasks_ReadTask_WithSearch.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithSearch%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L225">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithSearch_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithSearch*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithSearch" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithSearch">WithSearch</h4> |
| <div class="markdown level1 summary"><p>Return <code>true</code> if search should be performed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract bool WithSearch { 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.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_Benchmarks_ByTask_Tasks_ReadTask_WithTraverse.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithTraverse%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L238">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithTraverse_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithTraverse*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithTraverse" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithTraverse">WithTraverse</h4> |
| <div class="markdown level1 summary"><p>Return <code>true</code> if, with search, results should be traversed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract bool WithTraverse { 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.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_Benchmarks_ByTask_Tasks_ReadTask_WithWarm.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithWarm%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L233">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithWarm_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithWarm*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_WithWarm" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.WithWarm">WithWarm</h4> |
| <div class="markdown level1 summary"><p>Return <code>true</code> if warming should be performed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract bool WithWarm { 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.Boolean</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_CreateCollector.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.CreateCollector%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L206">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_CreateCollector_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.CreateCollector*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_CreateCollector" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.CreateCollector">CreateCollector()</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 virtual ICollector CreateCollector()</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">Lucene.Net.Search.ICollector</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_Benchmarks_ByTask_Tasks_ReadTask_DoLogic.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.DoLogic%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L64">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_DoLogic_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.DoLogic*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_DoLogic" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.DoLogic">DoLogic()</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 int DoLogic()</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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_DoLogic">PerfTask.DoLogic()</a></div> |
| <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_Benchmarks_ByTask_Tasks_ReadTask_GetBenchmarkHighlighter_Lucene_Net_Search_Query_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetBenchmarkHighlighter(Lucene.Net.Search.Query)%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L296">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetBenchmarkHighlighter_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetBenchmarkHighlighter*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetBenchmarkHighlighter_Lucene_Net_Search_Query_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetBenchmarkHighlighter(Lucene.Net.Search.Query)">GetBenchmarkHighlighter(Query)</h4> |
| <div class="markdown level1 summary"><p>Return an appropriate highlighter to be used with |
| highlighting tasks.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual BenchmarkHighlighter GetBenchmarkHighlighter(Query q)</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.Query</span></td> |
| <td><span class="parametername">q</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.Benchmarks.ByTask.Tasks.BenchmarkHighlighter.html">BenchmarkHighlighter</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_Benchmarks_ByTask_Tasks_ReadTask_GetFieldsToHighlight_Lucene_Net_Documents_Document_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetFieldsToHighlight(Lucene.Net.Documents.Document)%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L308">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetFieldsToHighlight_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetFieldsToHighlight*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetFieldsToHighlight_Lucene_Net_Documents_Document_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetFieldsToHighlight(Lucene.Net.Documents.Document)">GetFieldsToHighlight(Document)</h4> |
| <div class="markdown level1 summary"><p>Define the fields to highlight. Base implementation returns all fields.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual ICollection<string> GetFieldsToHighlight(Document document)</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.Documents.Document</span></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>The <span class="xref">Lucene.Net.Documents.Document</span>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.ICollection</span><<span class="xref">System.String</span>></td> |
| <td><p>An <span class="xref">ICollection{string}</span> of <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html">Field</a> names.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetQueryMaker.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetQueryMaker%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L220">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetQueryMaker_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetQueryMaker*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_GetQueryMaker" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.GetQueryMaker">GetQueryMaker()</h4> |
| <div class="markdown level1 summary"><p>Return query maker used for this task.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract IQueryMaker GetQueryMaker()</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.Benchmarks.ByTask.Feeds.IQueryMaker.html">IQueryMaker</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_Benchmarks_ByTask_Tasks_ReadTask_RetrieveDoc_Lucene_Net_Index_IndexReader_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.RetrieveDoc(Lucene.Net.Index.IndexReader%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L212">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_RetrieveDoc_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.RetrieveDoc*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_RetrieveDoc_Lucene_Net_Index_IndexReader_System_Int32_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.RetrieveDoc(Lucene.Net.Index.IndexReader,System.Int32)">RetrieveDoc(IndexReader, Int32)</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 virtual Document RetrieveDoc(IndexReader ir, int id)</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">ir</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">id</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">Lucene.Net.Documents.Document</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_Benchmarks_ByTask_Tasks_ReadTask_Setup.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.Setup%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L266">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_Setup_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.Setup*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask_Setup" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask.Setup">Setup()</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 void Setup()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_Setup">PerfTask.Setup()</a></div> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_ReadTask.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.ReadTask%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.Benchmark/ByTask/Tasks/ReadTask.cs/#L47" 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> |
