| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class CompressingStoredFieldsFormat |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class CompressingStoredFieldsFormat |
| | 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="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.Compressing.CompressingStoredFieldsFormat"> |
| |
| |
| <h1 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat" class="text-break">Class CompressingStoredFieldsFormat |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Codecs.StoredFieldsFormat.html">StoredFieldsFormat</a> that is very similar to |
| <a class="xref" href="Lucene.Net.Codecs.Lucene40.Lucene40StoredFieldsFormat.html">Lucene40StoredFieldsFormat</a> but compresses documents in chunks in |
| order to improve the compression ratio. |
| <p> |
| For a chunk size of <code>chunkSize</code> bytes, this <a class="xref" href="Lucene.Net.Codecs.StoredFieldsFormat.html">StoredFieldsFormat</a> |
| does not support documents larger than (<code>2<sup>31</sup> - chunkSize</code>) |
| bytes. In case this is a problem, you should use another format, such as |
| <a class="xref" href="Lucene.Net.Codecs.Lucene40.Lucene40StoredFieldsFormat.html">Lucene40StoredFieldsFormat</a>. |
| <p> |
| For optimal performance, you should use a <a class="xref" href="Lucene.Net.Index.MergePolicy.html">MergePolicy</a> that returns |
| segments that have the biggest byte size first. |
| <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.StoredFieldsFormat.html">StoredFieldsFormat</a></div> |
| <div class="level2"><span class="xref">CompressingStoredFieldsFormat</span></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Codecs.Lucene41.Lucene41StoredFieldsFormat.html">Lucene41StoredFieldsFormat</a></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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Codecs.Compressing.html">Lucene.Net.Codecs.Compressing</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class CompressingStoredFieldsFormat : StoredFieldsFormat</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_Compressing_CompressingStoredFieldsFormat__ctor_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.%23ctor(System.String%2CLucene.Net.Codecs.Compressing.CompressionMode%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/Codecs/Compressing/CompressingStoredFieldsFormat.cs/#L54">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat__ctor_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.#ctor*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat__ctor_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.#ctor(System.String,Lucene.Net.Codecs.Compressing.CompressionMode,System.Int32)">CompressingStoredFieldsFormat(String, CompressionMode, Int32)</h4> |
| <div class="markdown level1 summary"><p>Create a new <a class="xref" href="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.html">CompressingStoredFieldsFormat</a> with an empty segment |
| suffix.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public CompressingStoredFieldsFormat(string formatName, CompressionMode compressionMode, int chunkSize)</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">formatName</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Codecs.Compressing.CompressionMode.html">CompressionMode</a></td> |
| <td><span class="parametername">compressionMode</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">chunkSize</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat__ctor_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.html#Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat__ctor_System_String_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32_">CompressingStoredFieldsFormat(String, String, CompressionMode, Int32)</a></div> |
| </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_Compressing_CompressingStoredFieldsFormat__ctor_System_String_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.%23ctor(System.String%2CSystem.String%2CLucene.Net.Codecs.Compressing.CompressionMode%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/Codecs/Compressing/CompressingStoredFieldsFormat.cs/#L92">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat__ctor_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.#ctor*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat__ctor_System_String_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.#ctor(System.String,System.String,Lucene.Net.Codecs.Compressing.CompressionMode,System.Int32)">CompressingStoredFieldsFormat(String, String, CompressionMode, Int32)</h4> |
| <div class="markdown level1 summary"><p>Create a new <a class="xref" href="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.html">CompressingStoredFieldsFormat</a>. |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">formatName</code> is the name of the format. This name will be used |
| in the file formats to perform |
| codec header checks (<a class="xref" href="Lucene.Net.Codecs.CodecUtil.html#Lucene_Net_Codecs_CodecUtil_CheckHeader_Lucene_Net_Store_DataInput_System_String_System_Int32_System_Int32_">CheckHeader(DataInput, String, Int32, Int32)</a>). |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">segmentSuffix</code> is the segment suffix. this suffix is added to |
| the result file name only if it's not the empty string. |
| <p> |
| The <code data-dev-comment-type="paramref" class="paramref">compressionMode</code> parameter allows you to choose between |
| compression algorithms that have various compression and decompression |
| speeds so that you can pick the one that best fits your indexing and |
| searching throughput. You should never instantiate two |
| <a class="xref" href="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.html">CompressingStoredFieldsFormat</a>s that have the same name but |
| different <span class="xref">Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.compressionMode</span>s. |
| <p> |
| <code data-dev-comment-type="paramref" class="paramref">chunkSize</code> is the minimum byte size of a chunk of documents. |
| A value of <code>1</code> can make sense if there is redundancy across |
| fields. In that case, both performance and compression ratio should be |
| better than with <a class="xref" href="Lucene.Net.Codecs.Lucene40.Lucene40StoredFieldsFormat.html">Lucene40StoredFieldsFormat</a> with compressed |
| fields. |
| <p> |
| Higher values of <code data-dev-comment-type="paramref" class="paramref">chunkSize</code> should improve the compression |
| ratio but will require more memory at indexing time and might make document |
| loading a little slower (depending on the size of your OS cache compared |
| to the size of your index).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public CompressingStoredFieldsFormat(string formatName, string segmentSuffix, CompressionMode compressionMode, int chunkSize)</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">formatName</span></td> |
| <td><p>The name of the <a class="xref" href="Lucene.Net.Codecs.StoredFieldsFormat.html">StoredFieldsFormat</a>. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">segmentSuffix</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Codecs.Compressing.CompressionMode.html">CompressionMode</a></td> |
| <td><span class="parametername">compressionMode</span></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Codecs.Compressing.CompressionMode.html">CompressionMode</a> to use. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">chunkSize</span></td> |
| <td><p>The minimum number of bytes of a single chunk of stored documents. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat__ctor_System_String_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Codecs.Compressing.CompressionMode.html">CompressionMode</a></div> |
| </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_Compressing_CompressingStoredFieldsFormat_FieldsReader_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_Lucene_Net_Store_IOContext_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.FieldsReader(Lucene.Net.Store.Directory%2CLucene.Net.Index.SegmentInfo%2CLucene.Net.Index.FieldInfos%2CLucene.Net.Store.IOContext)%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/Compressing/CompressingStoredFieldsFormat.cs/#L104">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat_FieldsReader_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.FieldsReader*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat_FieldsReader_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_Lucene_Net_Store_IOContext_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.FieldsReader(Lucene.Net.Store.Directory,Lucene.Net.Index.SegmentInfo,Lucene.Net.Index.FieldInfos,Lucene.Net.Store.IOContext)">FieldsReader(Directory, SegmentInfo, FieldInfos, IOContext)</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 StoredFieldsReader FieldsReader(Directory directory, SegmentInfo si, FieldInfos fn, IOContext context)</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.Store.Directory.html">Directory</a></td> |
| <td><span class="parametername">directory</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.SegmentInfo.html">SegmentInfo</a></td> |
| <td><span class="parametername">si</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.FieldInfos.html">FieldInfos</a></td> |
| <td><span class="parametername">fn</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Store.IOContext.html">IOContext</a></td> |
| <td><span class="parametername">context</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.Codecs.StoredFieldsReader.html">StoredFieldsReader</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Codecs.StoredFieldsFormat.html#Lucene_Net_Codecs_StoredFieldsFormat_FieldsReader_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_Lucene_Net_Store_IOContext_">StoredFieldsFormat.FieldsReader(Directory, SegmentInfo, FieldInfos, IOContext)</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_Codecs_Compressing_CompressingStoredFieldsFormat_FieldsWriter_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Store_IOContext_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.FieldsWriter(Lucene.Net.Store.Directory%2CLucene.Net.Index.SegmentInfo%2CLucene.Net.Store.IOContext)%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/Compressing/CompressingStoredFieldsFormat.cs/#L109">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat_FieldsWriter_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.FieldsWriter*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat_FieldsWriter_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Store_IOContext_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.FieldsWriter(Lucene.Net.Store.Directory,Lucene.Net.Index.SegmentInfo,Lucene.Net.Store.IOContext)">FieldsWriter(Directory, SegmentInfo, IOContext)</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 StoredFieldsWriter FieldsWriter(Directory directory, SegmentInfo si, IOContext context)</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.Store.Directory.html">Directory</a></td> |
| <td><span class="parametername">directory</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.SegmentInfo.html">SegmentInfo</a></td> |
| <td><span class="parametername">si</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Store.IOContext.html">IOContext</a></td> |
| <td><span class="parametername">context</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.Codecs.StoredFieldsWriter.html">StoredFieldsWriter</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Codecs.StoredFieldsFormat.html#Lucene_Net_Codecs_StoredFieldsFormat_FieldsWriter_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Store_IOContext_">StoredFieldsFormat.FieldsWriter(Directory, SegmentInfo, IOContext)</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_Codecs_Compressing_CompressingStoredFieldsFormat_ToString.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.ToString%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/Compressing/CompressingStoredFieldsFormat.cs/#L114">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat_ToString_" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.ToString*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_CompressingStoredFieldsFormat_ToString" data-uid="Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat.ToString">ToString()</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 string ToString()</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.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.ToString()</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_Compressing_CompressingStoredFieldsFormat.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingStoredFieldsFormat%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/Compressing/CompressingStoredFieldsFormat.cs/#L42" 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> |