| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Namespace Lucene.Net.Codecs.SimpleText |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Namespace Lucene.Net.Codecs.SimpleText |
| | 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"> |
| |
| <h1 id="Lucene_Net_Codecs_SimpleText" data-uid="Lucene.Net.Codecs.SimpleText" class="text-break">Namespace Lucene.Net.Codecs.SimpleText |
| </h1> |
| <div class="markdown level0 summary"><!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <p>Simpletext Codec: writes human readable postings.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="markdown level0 remarks"></div> |
| <h3 id="classes">Classes |
| </h3> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextCodec.html">SimpleTextCodec</a></h4> |
| <section><p>Plain text index format. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesFormat.html">SimpleTextDocValuesFormat</a></h4> |
| <section><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> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesReader.html">SimpleTextDocValuesReader</a></h4> |
| <section></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextDocValuesWriter.html">SimpleTextDocValuesWriter</a></h4> |
| <section></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextFieldInfosFormat.html">SimpleTextFieldInfosFormat</a></h4> |
| <section><p>Plain text field infos format. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextFieldInfosReader.html">SimpleTextFieldInfosReader</a></h4> |
| <section><p>Reads plain text field infos files. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextFieldInfosWriter.html">SimpleTextFieldInfosWriter</a></h4> |
| <section><p>Writes plain text field infos files. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextLiveDocsFormat.html">SimpleTextLiveDocsFormat</a></h4> |
| <section><p>Reads/writes plain text live docs. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextNormsFormat.html">SimpleTextNormsFormat</a></h4> |
| <section><p>Plain-text norms format. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextNormsFormat.SimpleTextNormsConsumer.html">SimpleTextNormsFormat.SimpleTextNormsConsumer</a></h4> |
| <section><p>Writes plain-text norms. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextNormsFormat.SimpleTextNormsProducer.html">SimpleTextNormsFormat.SimpleTextNormsProducer</a></h4> |
| <section><p>Reads plain-text norms. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextPostingsFormat.html">SimpleTextPostingsFormat</a></h4> |
| <section><p>For debugging, curiosity, transparency only!! Do not |
| use this codec in production.</p> |
| <p><p>This codec stores all postings data in a single |
| human-readable text file (_N.pst). You can view this in |
| any text editor, and even edit it to alter your index. |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextSegmentInfoFormat.html">SimpleTextSegmentInfoFormat</a></h4> |
| <section><p>Plain text segments file format. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextSegmentInfoReader.html">SimpleTextSegmentInfoReader</a></h4> |
| <section><p>Reads plaintext segments files. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextSegmentInfoWriter.html">SimpleTextSegmentInfoWriter</a></h4> |
| <section><p>Writes plain text segments files. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextStoredFieldsFormat.html">SimpleTextStoredFieldsFormat</a></h4> |
| <section><p>Plain text stored fields format. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextStoredFieldsReader.html">SimpleTextStoredFieldsReader</a></h4> |
| <section><p>Reads plain text stored fields. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextStoredFieldsWriter.html">SimpleTextStoredFieldsWriter</a></h4> |
| <section><p>Writes plain-text stored fields. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextTermVectorsFormat.html">SimpleTextTermVectorsFormat</a></h4> |
| <section><p>Plain text term vectors format. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextTermVectorsReader.html">SimpleTextTermVectorsReader</a></h4> |
| <section><p>Reads plain-text term vectors. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| <h4><a class="xref" href="Lucene.Net.Codecs.SimpleText.SimpleTextTermVectorsWriter.html">SimpleTextTermVectorsWriter</a></h4> |
| <section><p>Writes plain-text term vectors. |
| <p> |
| <strong><font color="red">FOR RECREATIONAL USE ONLY</font></strong> |
| </p></p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></section> |
| </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/blob/docs/4.8.0-beta00010/src/Lucene.Net.Codecs/SimpleText/package.md/#L2" class="contribution-link">Improve this Doc</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> |
