| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class WriteLineDocTask |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class WriteLineDocTask |
| | 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.WriteLineDocTask"> |
| |
| |
| <h1 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask" class="text-break">Class WriteLineDocTask |
| </h1> |
| <div class="markdown level0 summary"><p>A task which writes documents, one line per document. Each line is in the |
| following format: title <TAB> date <TAB> body. The output of this |
| task can be consumed by <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Feeds.LineDocSource.html">LineDocSource</a> and is intended |
| to save the IO overhead of opening a file per document to be indexed.</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">WriteLineDocTask</span></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.WriteEnwikiLineDocTask.html">WriteEnwikiLineDocTask</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_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_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_Setup">PerfTask.Setup()</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_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_WriteLineDocTask_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class WriteLineDocTask : PerfTask, IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><p>The format of the output is set according to the output file extension. |
| Compression is recommended when the output file is expected to be large. |
| See info on file extensions in <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Utils.FileType.html">FileType</a>. |
| <p> |
| Supports the following parameters: |
| <ul><li>line.file.outthe name of the file to write the output to. That parameter is mandatory. <strong>NOTE:</strong> the file is re-created.</li><li>line.fieldswhich fields should be written in each line. (optional, default: <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_DEFAULT_FIELDS">DEFAULT_FIELDS</a>).</li><li>sufficient.fields |
| list of field names, separated by comma, which, |
| if all of them are missing, the document will be skipped. For example, to require |
| that at least one of f1,f2 is not empty, specify: "f1,f2" in this field. To specify |
| that no field is required, i.e. that even empty docs should be emitted, specify <strong>","</strong> |
| (optional, default: <a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_DEFAULT_SUFFICIENT_FIELDS">DEFAULT_SUFFICIENT_FIELDS</a>). |
| </li></ul> |
| <p> |
| <strong>NOTE:</strong> this class is not thread-safe and if used by multiple threads the |
| output is unspecified (as all will write to the same output file in a |
| non-synchronized way).</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_WriteLineDocTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.%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/WriteLineDocTask.cs/#L95">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask__ctor_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.#ctor*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask__ctor_Lucene_Net_Benchmarks_ByTask_PerfRunData_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.#ctor(Lucene.Net.Benchmarks.ByTask.PerfRunData)">WriteLineDocTask(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 WriteLineDocTask(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="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_Benchmarks_ByTask_Tasks_WriteLineDocTask_DEFAULT_FIELDS.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.DEFAULT_FIELDS%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/WriteLineDocTask.cs/#L71">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_DEFAULT_FIELDS" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.DEFAULT_FIELDS">DEFAULT_FIELDS</h4> |
| <div class="markdown level1 summary"><p>Fields to be written by default</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly string[] DEFAULT_FIELDS</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_WriteLineDocTask_DEFAULT_SUFFICIENT_FIELDS.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.DEFAULT_SUFFICIENT_FIELDS%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/WriteLineDocTask.cs/#L80">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_DEFAULT_SUFFICIENT_FIELDS" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.DEFAULT_SUFFICIENT_FIELDS">DEFAULT_SUFFICIENT_FIELDS</h4> |
| <div class="markdown level1 summary"><p>Default fields which at least one of them is required to not skip the doc.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly string DEFAULT_SUFFICIENT_FIELDS</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_WriteLineDocTask_FIELDS_HEADER_INDICATOR.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.FIELDS_HEADER_INDICATOR%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/WriteLineDocTask.cs/#L64">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_FIELDS_HEADER_INDICATOR" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.FIELDS_HEADER_INDICATOR">FIELDS_HEADER_INDICATOR</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 static readonly string FIELDS_HEADER_INDICATOR</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_WriteLineDocTask_m_fname.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.m_fname%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/WriteLineDocTask.cs/#L83">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_m_fname" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.m_fname">m_fname</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 readonly string m_fname</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_WriteLineDocTask_SEP.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SEP%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/WriteLineDocTask.cs/#L66">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_SEP" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SEP">SEP</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 static readonly char SEP</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Char</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_WriteLineDocTask_SupportsParams.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SupportsParams%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/WriteLineDocTask.cs/#L244">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_SupportsParams_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SupportsParams*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_SupportsParams" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SupportsParams">SupportsParams</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 bool SupportsParams { 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Benchmarks.ByTask.Tasks.PerfTask.html#Lucene_Net_Benchmarks_ByTask_Tasks_PerfTask_SupportsParams">PerfTask.SupportsParams</a></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_Dispose_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.Dispose(System.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.Benchmark/ByTask/Tasks/WriteLineDocTask.cs/#L223">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_Dispose_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.Dispose*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_Dispose_System_Boolean_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.Dispose(System.Boolean)">Dispose(Boolean)</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 Dispose(bool disposing)</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.Boolean</span></td> |
| <td><span class="parametername">disposing</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_Dispose_System_Boolean_">PerfTask.Dispose(Boolean)</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_WriteLineDocTask_DoLogic.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.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/WriteLineDocTask.cs/#L174">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_DoLogic_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.DoLogic*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_DoLogic" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.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_WriteLineDocTask_GetLogMessage_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.GetLogMessage(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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/WriteLineDocTask.cs/#L169">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_GetLogMessage_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.GetLogMessage*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_GetLogMessage_System_Int32_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.GetLogMessage(System.Int32)">GetLogMessage(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 override string GetLogMessage(int recsCount)</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">recsCount</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">System.String</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_GetLogMessage_System_Int32_">PerfTask.GetLogMessage(Int32)</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_WriteLineDocTask_LineFileOut_Lucene_Net_Documents_Document_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.LineFileOut(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/WriteLineDocTask.cs/#L218">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_LineFileOut_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.LineFileOut*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_LineFileOut_Lucene_Net_Documents_Document_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.LineFileOut(Lucene.Net.Documents.Document)">LineFileOut(Document)</h4> |
| <div class="markdown level1 summary"><p>Selects output line file by written doc. |
| Default: original output line file.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual TextWriter LineFileOut(Document doc)</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">doc</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">System.IO.TextWriter</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_WriteLineDocTask_SetParams_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SetParams(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Benchmark/ByTask/Tasks/WriteLineDocTask.cs/#L238">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_SetParams_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SetParams*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_SetParams_System_String_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.SetParams(System.String)">SetParams(String)</h4> |
| <div class="markdown level1 summary"><p>Set the params (docSize only)</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override void SetParams(string params)</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.String</span></td> |
| <td><span class="parametername">params</span></td> |
| <td><p>docSize, or 0 for no limit.</p> |
| </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_SetParams_System_String_">PerfTask.SetParams(String)</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_WriteLineDocTask_WriteHeader_System_IO_TextWriter_.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.WriteHeader(System.IO.TextWriter)%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/WriteLineDocTask.cs/#L149">View Source</a> |
| </span> |
| <a id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_WriteHeader_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.WriteHeader*"></a> |
| <h4 id="Lucene_Net_Benchmarks_ByTask_Tasks_WriteLineDocTask_WriteHeader_System_IO_TextWriter_" data-uid="Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask.WriteHeader(System.IO.TextWriter)">WriteHeader(TextWriter)</h4> |
| <div class="markdown level1 summary"><p>Write header to the lines file - indicating how to read the file later.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void WriteHeader(TextWriter out)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.TextWriter</span></td> |
| <td><span class="parametername">out</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_WriteLineDocTask.md&value=---%0Auid%3A%20Lucene.Net.Benchmarks.ByTask.Tasks.WriteLineDocTask%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/WriteLineDocTask.cs/#L62" 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> |