| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SimpleTextDocValuesFormat |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SimpleTextDocValuesFormat |
| | 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="codecs/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.Codecs.SimpleText.SimpleTextDocValuesFormat"> |
| |
| |
| <h1 id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat" data-uid="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat" class="text-break">Class SimpleTextDocValuesFormat |
| </h1> |
| <div class="markdown level0 summary"><p>Plain text doc values format. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p> |
| <p> |
| The .dat file contains the data. |
| For numbers this is a "fixed-width" file, for example a single byte range:</p> |
| <pre><code> field myField |
| type NUMERIC |
| minvalue 0 |
| pattern 000 |
| 005 |
| T |
| 234 |
| T |
| 123 |
| T |
| ...</code></pre> |
| <p>So a document's value (delta encoded from minvalue) can be retrieved by |
| seeking to startOffset + (1+pattern.length()+2)*docid. The extra 1 is the newline. |
| The extra 2 is another newline and 'T' or 'F': true if the value is real, false if missing.</p> |
| <p>for bytes this is also a "fixed-width" file, for example:</p> |
| <pre><code> field myField |
| type BINARY |
| maxlength 6 |
| pattern 0 |
| length 6 |
| foobar[space][space] |
| T |
| length 3 |
| baz[space][space][space][space][space] |
| T |
| ...</code></pre> |
| <p>So a doc's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength+2)*doc |
| the extra 9 is 2 newlines, plus "length " itself. |
| The extra 2 is another newline and 'T' or 'F': true if the value is real, false if missing.</p> |
| <p>For sorted bytes this is a fixed-width file, for example:</p> |
| <pre><code> field myField |
| type SORTED |
| numvalues 10 |
| maxLength 8 |
| pattern 0 |
| ordpattern 00 |
| length 6 |
| foobar[space][space] |
| length 3 |
| baz[space][space][space][space][space] |
| ... |
| 03 |
| 06 |
| 01 |
| 10 |
| ...</code></pre> |
| <p>So the "ord section" begins at startOffset + (9+pattern.length+maxlength)<em>numValues. |
| A document's ord can be retrieved by seeking to "ord section" + (1+ordpattern.length())</em>docid |
| an ord's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength)*ord</p> |
| <p>For sorted set this is a fixed-width file very similar to the SORTED case, for example:</p> |
| <pre><code> field myField |
| type SORTED_SET |
| numvalues 10 |
| maxLength 8 |
| pattern 0 |
| ordpattern XXXXX |
| length 6 |
| foobar[space][space] |
| length 3 |
| baz[space][space][space][space][space] |
| ... |
| 0,3,5 |
| 1,2 |
| |
| 10 |
| ...</code></pre> |
| <p>So the "ord section" begins at startOffset + (9+pattern.length+maxlength)<em>numValues. |
| A document's ord list can be retrieved by seeking to "ord section" + (1+ordpattern.length())</em>docid |
| this is a comma-separated list, and its padded with spaces to be fixed width. so trim() and split() it. |
| and beware the empty string! |
| An ord's value can be retrieved by seeking to startOffset + (9+pattern.length+maxlength)*ord |
| <p> |
| The reader can just scan this file when it opens, skipping over the data blocks |
| and saving the offset/etc for each field. |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><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">Lucene.Net.Codecs.DocValuesFormat</span></div> |
| <div class="level2"><span class="xref">SimpleTextDocValuesFormat</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">Lucene.Net.Codecs.DocValuesFormat.SetDocValuesFormatFactory(Lucene.Net.Codecs.IDocValuesFormatFactory)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Codecs.DocValuesFormat.GetDocValuesFormatFactory()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Codecs.DocValuesFormat.Name</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Codecs.DocValuesFormat.ToString()</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Codecs.DocValuesFormat.ForName(System.String)</span> |
| </div> |
| <div> |
| <span class="xref">Lucene.Net.Codecs.DocValuesFormat.AvailableDocValuesFormats</span> |
| </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.Codecs.SimpleText.html">Lucene.Net.Codecs.SimpleText</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Codecs.dll</h6> |
| <h5 id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[DocValuesFormatName("SimpleText")] |
| public class SimpleTextDocValuesFormat : DocValuesFormat</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_Codecs_SimpleText_SimpleTextDocValuesFormat__ctor.md&value=---%0Auid%3A%20Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.%23ctor%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.Codecs/SimpleText/SimpleTextDocValuesFormat.cs/#L123">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat__ctor_" data-uid="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.#ctor*"></a> |
| <h4 id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat__ctor" data-uid="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.#ctor">SimpleTextDocValuesFormat()</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 SimpleTextDocValuesFormat()</code></pre> |
| </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_Codecs_SimpleText_SimpleTextDocValuesFormat_FieldsConsumer_Lucene_Net_Index_SegmentWriteState_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.FieldsConsumer(Lucene.Net.Index.SegmentWriteState)%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.Codecs/SimpleText/SimpleTextDocValuesFormat.cs/#L128">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat_FieldsConsumer_" data-uid="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.FieldsConsumer*"></a> |
| <h4 id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat_FieldsConsumer_Lucene_Net_Index_SegmentWriteState_" data-uid="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.FieldsConsumer(Lucene.Net.Index.SegmentWriteState)">FieldsConsumer(SegmentWriteState)</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 DocValuesConsumer FieldsConsumer(SegmentWriteState 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.Index.SegmentWriteState</span></td> |
| <td><span class="parametername">state</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.Codecs.DocValuesConsumer</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Codecs.DocValuesFormat.FieldsConsumer(Lucene.Net.Index.SegmentWriteState)</span></div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat_FieldsProducer_Lucene_Net_Index_SegmentReadState_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.FieldsProducer(Lucene.Net.Index.SegmentReadState)%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.Codecs/SimpleText/SimpleTextDocValuesFormat.cs/#L133">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat_FieldsProducer_" data-uid="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.FieldsProducer*"></a> |
| <h4 id="Lucene_Net_Codecs_SimpleText_SimpleTextDocValuesFormat_FieldsProducer_Lucene_Net_Index_SegmentReadState_" data-uid="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.FieldsProducer(Lucene.Net.Index.SegmentReadState)">FieldsProducer(SegmentReadState)</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 DocValuesProducer FieldsProducer(SegmentReadState 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.Index.SegmentReadState</span></td> |
| <td><span class="parametername">state</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.Codecs.DocValuesProducer</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">Lucene.Net.Codecs.DocValuesFormat.FieldsProducer(Lucene.Net.Index.SegmentReadState)</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_Codecs_SimpleText_SimpleTextDocValuesFormat.md&value=---%0Auid%3A%20Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat%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.Codecs/SimpleText/SimpleTextDocValuesFormat.cs/#L120" 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> |
