| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Lucene46FieldInfosFormat |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Lucene46FieldInfosFormat |
| | Apache Lucene.NET 4.8.0-beta00011 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="core/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.Lucene46.Lucene46FieldInfosFormat"> |
| |
| |
| <h1 id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat" data-uid="Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat" class="text-break">Class Lucene46FieldInfosFormat |
| </h1> |
| <div class="markdown level0 summary"><p>Lucene 4.6 Field Infos format. |
| <p> |
| <p>Field names are stored in the field info file, with suffix <code>.fnm</code>.</p> |
| <p>FieldInfos (.fnm) --> Header,FieldsCount, <FieldName,FieldNumber, |
| FieldBits,DocValuesBits,DocValuesGen,Attributes> <sup>FieldsCount</sup>,Footer</p> |
| <p>Data types: |
| <ul><li>Header --> CodecHeader (<a class="xref" href="Lucene.Net.Codecs.CodecUtil.html#Lucene_Net_Codecs_CodecUtil_WriteHeader_Lucene_Net_Store_DataOutput_System_String_System_Int32_">WriteHeader(DataOutput, String, Int32)</a>)</li><li>FieldsCount --> VInt (<a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteVInt32_System_Int32_">WriteVInt32(Int32)</a>)</li><li>FieldName --> String (<a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteString_System_String_">WriteString(String)</a>)</li><li>FieldBits, DocValuesBits --> Byte (<a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteByte_System_Byte_">WriteByte(Byte)</a>)</li><li>FieldNumber --> VInt (<a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteInt32_System_Int32_">WriteInt32(Int32)</a>)</li><li>Attributes --> IDictionary<String,String> (<a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteStringStringMap_System_Collections_Generic_IDictionary_System_String_System_String__">WriteStringStringMap(IDictionary<String, String>)</a>)</li><li>DocValuesGen --> Int64 (<a class="xref" href="Lucene.Net.Store.DataOutput.html#Lucene_Net_Store_DataOutput_WriteInt64_System_Int64_">WriteInt64(Int64)</a>)</li><li>Footer --> CodecFooter (<a class="xref" href="Lucene.Net.Codecs.CodecUtil.html#Lucene_Net_Codecs_CodecUtil_WriteFooter_Lucene_Net_Store_IndexOutput_">WriteFooter(IndexOutput)</a>)</li></ul> |
| </p> |
| Field Descriptions: |
| <ul><li>FieldsCount: the number of fields in this file.</li><li>FieldName: name of the field as a UTF-8 string.</li><li>FieldNumber: the field's number. Note that unlike previous versions of |
| Lucene, the fields are not numbered implicitly by their order in the |
| file, instead explicitly.</li><li>FieldBits: a <span class="xref">System.Byte</span> containing field options. |
| <ul><li>The low-order bit is one for indexed fields, and zero for non-indexed |
| fields.</li><li>The second lowest-order bit is one for fields that have term vectors |
| stored, and zero for fields without term vectors.</li><li>If the third lowest order-bit is set (0x4), offsets are stored into |
| the postings list in addition to positions.</li><li>Fourth bit is unused.</li><li>If the fifth lowest-order bit is set (0x10), norms are omitted for the |
| indexed field.</li><li>If the sixth lowest-order bit is set (0x20), payloads are stored for the |
| indexed field.</li><li>If the seventh lowest-order bit is set (0x40), term frequencies and |
| positions omitted for the indexed field.</li><li>If the eighth lowest-order bit is set (0x80), positions are omitted for the |
| indexed field.</li></ul> |
| </li><li>DocValuesBits: a <span class="xref">System.Byte</span> containing per-document value types. The type |
| recorded as two four-bit integers, with the high-order bits representing |
| <code>norms</code> options, and the low-order bits representing |
| <a class="xref" href="Lucene.Net.Index.DocValues.html">DocValues</a> options. Each four-bit integer can be decoded as such: |
| <ul><li>0: no DocValues for this field.</li><li>1: <a class="xref" href="Lucene.Net.Index.NumericDocValues.html">NumericDocValues</a>. (<a class="xref" href="Lucene.Net.Index.DocValuesType.html#Lucene_Net_Index_DocValuesType_NUMERIC">NUMERIC</a>)</li><li>2: <a class="xref" href="Lucene.Net.Index.BinaryDocValues.html">BinaryDocValues</a>. (<a class="xref" href="Lucene.Net.Index.DocValuesType.html#Lucene_Net_Index_DocValuesType_BINARY">BINARY</a>)</li><li>3: <a class="xref" href="Lucene.Net.Index.SortedDocValues.html">SortedDocValues</a>. (<a class="xref" href="Lucene.Net.Index.DocValuesType.html#Lucene_Net_Index_DocValuesType_SORTED">SORTED</a>)</li></ul> |
| </li><li>DocValuesGen is the generation count of the field's <a class="xref" href="Lucene.Net.Index.DocValues.html">DocValues</a>. If this is -1, |
| there are no <a class="xref" href="Lucene.Net.Index.DocValues.html">DocValues</a> updates to that field. Anything above zero means there |
| are updates stored by <a class="xref" href="Lucene.Net.Codecs.DocValuesFormat.html">DocValuesFormat</a>.</li><li>Attributes: a key-value map of codec-private attributes.</li></ul> |
| <p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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.Codecs.FieldInfosFormat.html">FieldInfosFormat</a></div> |
| <div class="level2"><span class="xref">Lucene46FieldInfosFormat</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Codecs.Lucene46.html">Lucene.Net.Codecs.Lucene46</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class Lucene46FieldInfosFormat : FieldInfosFormat</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat__ctor.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.%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_beta00011/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs/#L90">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat__ctor_" data-uid="Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.#ctor*"></a> |
| <h4 id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat__ctor" data-uid="Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.#ctor">Lucene46FieldInfosFormat()</h4> |
| <div class="markdown level1 summary"><p>Sole constructor. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Lucene46FieldInfosFormat()</code></pre> |
| </div> |
| <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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat_FieldInfosReader.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.FieldInfosReader%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_beta00011/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs/#L94">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat_FieldInfosReader_" data-uid="Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.FieldInfosReader*"></a> |
| <h4 id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat_FieldInfosReader" data-uid="Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.FieldInfosReader">FieldInfosReader</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 FieldInfosReader FieldInfosReader { 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><a class="xref" href="Lucene.Net.Codecs.FieldInfosReader.html">FieldInfosReader</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Codecs.FieldInfosFormat.html#Lucene_Net_Codecs_FieldInfosFormat_FieldInfosReader">FieldInfosFormat.FieldInfosReader</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat_FieldInfosWriter.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.FieldInfosWriter%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_beta00011/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs/#L96">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat_FieldInfosWriter_" data-uid="Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.FieldInfosWriter*"></a> |
| <h4 id="Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat_FieldInfosWriter" data-uid="Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat.FieldInfosWriter">FieldInfosWriter</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 FieldInfosWriter FieldInfosWriter { 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><a class="xref" href="Lucene.Net.Codecs.FieldInfosWriter.html">FieldInfosWriter</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Codecs.FieldInfosFormat.html#Lucene_Net_Codecs_FieldInfosFormat_FieldInfosWriter">FieldInfosFormat.FieldInfosWriter</a></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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene46_Lucene46FieldInfosFormat.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene46.Lucene46FieldInfosFormat%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_beta00011/src/Lucene.Net/Codecs/Lucene46/Lucene46FieldInfosFormat.cs/#L83" 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> |