| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SegmentWriteState |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SegmentWriteState |
| | 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.Index.SegmentWriteState"> |
| |
| |
| <h1 id="Lucene_Net_Index_SegmentWriteState" data-uid="Lucene.Net.Index.SegmentWriteState" class="text-break">Class SegmentWriteState |
| </h1> |
| <div class="markdown level0 summary"><p>Holder class for common parameters used during write. |
| <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"><span class="xref">SegmentWriteState</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.Index.html">Lucene.Net.Index</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Index_SegmentWriteState_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class SegmentWriteState</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_Index_SegmentWriteState__ctor_Lucene_Net_Index_SegmentWriteState_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.%23ctor(Lucene.Net.Index.SegmentWriteState%2CSystem.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/Index/SegmentWriteState.cs/#L125">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState__ctor_" data-uid="Lucene.Net.Index.SegmentWriteState.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState__ctor_Lucene_Net_Index_SegmentWriteState_System_String_" data-uid="Lucene.Net.Index.SegmentWriteState.#ctor(Lucene.Net.Index.SegmentWriteState,System.String)">SegmentWriteState(SegmentWriteState, String)</h4> |
| <div class="markdown level1 summary"><p>Create a shallow copy of <a class="xref" href="Lucene.Net.Index.SegmentWriteState.html">SegmentWriteState</a> with a new 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 SegmentWriteState(SegmentWriteState state, string segmentSuffix)</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.Index.SegmentWriteState.html">SegmentWriteState</a></td> |
| <td><span class="parametername">state</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">segmentSuffix</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_Index_SegmentWriteState__ctor_Lucene_Net_Util_InfoStream_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_System_Int32_Lucene_Net_Index_BufferedUpdates_Lucene_Net_Store_IOContext_.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.%23ctor(Lucene.Net.Util.InfoStream%2CLucene.Net.Store.Directory%2CLucene.Net.Index.SegmentInfo%2CLucene.Net.Index.FieldInfos%2CSystem.Int32%2CLucene.Net.Index.BufferedUpdates%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/Index/SegmentWriteState.cs/#L101">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState__ctor_" data-uid="Lucene.Net.Index.SegmentWriteState.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState__ctor_Lucene_Net_Util_InfoStream_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_System_Int32_Lucene_Net_Index_BufferedUpdates_Lucene_Net_Store_IOContext_" data-uid="Lucene.Net.Index.SegmentWriteState.#ctor(Lucene.Net.Util.InfoStream,Lucene.Net.Store.Directory,Lucene.Net.Index.SegmentInfo,Lucene.Net.Index.FieldInfos,System.Int32,Lucene.Net.Index.BufferedUpdates,Lucene.Net.Store.IOContext)">SegmentWriteState(InfoStream, Directory, SegmentInfo, FieldInfos, Int32, BufferedUpdates, IOContext)</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 SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, BufferedUpdates segUpdates, 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.Util.InfoStream.html">InfoStream</a></td> |
| <td><span class="parametername">infoStream</span></td> |
| <td></td> |
| </tr> |
| <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">segmentInfo</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.FieldInfos.html">FieldInfos</a></td> |
| <td><span class="parametername">fieldInfos</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">termIndexInterval</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.BufferedUpdates.html">BufferedUpdates</a></td> |
| <td><span class="parametername">segUpdates</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> |
| <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_Index_SegmentWriteState__ctor_Lucene_Net_Util_InfoStream_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_System_Int32_Lucene_Net_Index_BufferedUpdates_Lucene_Net_Store_IOContext_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.%23ctor(Lucene.Net.Util.InfoStream%2CLucene.Net.Store.Directory%2CLucene.Net.Index.SegmentInfo%2CLucene.Net.Index.FieldInfos%2CSystem.Int32%2CLucene.Net.Index.BufferedUpdates%2CLucene.Net.Store.IOContext%2CSystem.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/Index/SegmentWriteState.cs/#L111">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState__ctor_" data-uid="Lucene.Net.Index.SegmentWriteState.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState__ctor_Lucene_Net_Util_InfoStream_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_System_Int32_Lucene_Net_Index_BufferedUpdates_Lucene_Net_Store_IOContext_System_String_" data-uid="Lucene.Net.Index.SegmentWriteState.#ctor(Lucene.Net.Util.InfoStream,Lucene.Net.Store.Directory,Lucene.Net.Index.SegmentInfo,Lucene.Net.Index.FieldInfos,System.Int32,Lucene.Net.Index.BufferedUpdates,Lucene.Net.Store.IOContext,System.String)">SegmentWriteState(InfoStream, Directory, SegmentInfo, FieldInfos, Int32, BufferedUpdates, IOContext, String)</h4> |
| <div class="markdown level1 summary"><p>Constructor which takes 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 SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, BufferedUpdates segUpdates, IOContext context, string segmentSuffix)</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.Util.InfoStream.html">InfoStream</a></td> |
| <td><span class="parametername">infoStream</span></td> |
| <td></td> |
| </tr> |
| <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">segmentInfo</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.FieldInfos.html">FieldInfos</a></td> |
| <td><span class="parametername">fieldInfos</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">termIndexInterval</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.BufferedUpdates.html">BufferedUpdates</a></td> |
| <td><span class="parametername">segUpdates</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> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">segmentSuffix</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Index_SegmentWriteState__ctor_Lucene_Net_Util_InfoStream_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_System_Int32_Lucene_Net_Index_BufferedUpdates_Lucene_Net_Store_IOContext_System_String__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Index.SegmentWriteState.html#Lucene_Net_Index_SegmentWriteState__ctor_Lucene_Net_Util_InfoStream_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_Lucene_Net_Index_FieldInfos_System_Int32_Lucene_Net_Index_BufferedUpdates_Lucene_Net_Store_IOContext_">SegmentWriteState(InfoStream, Directory, SegmentInfo, FieldInfos, Int32, BufferedUpdates, IOContext)</a></div> |
| </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_SegmentWriteState_Context.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.Context%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/Index/SegmentWriteState.cs/#L97">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_Context_" data-uid="Lucene.Net.Index.SegmentWriteState.Context*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_Context" data-uid="Lucene.Net.Index.SegmentWriteState.Context">Context</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Store.IOContext.html">IOContext</a> for all writes; you should pass this |
| to <a class="xref" href="Lucene.Net.Store.Directory.html#Lucene_Net_Store_Directory_CreateOutput_System_String_Lucene_Net_Store_IOContext_">CreateOutput(String, IOContext)</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IOContext Context { 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.Store.IOContext.html">IOContext</a></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_Index_SegmentWriteState_DelCountOnFlush.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.DelCountOnFlush%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/Index/SegmentWriteState.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_DelCountOnFlush_" data-uid="Lucene.Net.Index.SegmentWriteState.DelCountOnFlush*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_DelCountOnFlush" data-uid="Lucene.Net.Index.SegmentWriteState.DelCountOnFlush">DelCountOnFlush</h4> |
| <div class="markdown level1 summary"><p>Number of deleted documents set while flushing the |
| segment.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int DelCountOnFlush { get; set; }</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.Int32</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_Index_SegmentWriteState_Directory.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.Directory%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/Index/SegmentWriteState.cs/#L42">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_Directory_" data-uid="Lucene.Net.Index.SegmentWriteState.Directory*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_Directory" data-uid="Lucene.Net.Index.SegmentWriteState.Directory">Directory</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Store.Directory.html">Directory</a> where this segment will be written |
| to.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Directory Directory { 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.Store.Directory.html">Directory</a></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_Index_SegmentWriteState_FieldInfos.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.FieldInfos%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/Index/SegmentWriteState.cs/#L52">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_FieldInfos_" data-uid="Lucene.Net.Index.SegmentWriteState.FieldInfos*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_FieldInfos" data-uid="Lucene.Net.Index.SegmentWriteState.FieldInfos">FieldInfos</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Index.FieldInfos.html">FieldInfos</a> describing all fields in this |
| segment.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FieldInfos FieldInfos { 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.Index.FieldInfos.html">FieldInfos</a></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_Index_SegmentWriteState_InfoStream.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.InfoStream%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/Index/SegmentWriteState.cs/#L36">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_InfoStream_" data-uid="Lucene.Net.Index.SegmentWriteState.InfoStream*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_InfoStream" data-uid="Lucene.Net.Index.SegmentWriteState.InfoStream">InfoStream</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Util.InfoStream.html">InfoStream</a> used for debugging messages. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public InfoStream InfoStream { 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.Util.InfoStream.html">InfoStream</a></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_Index_SegmentWriteState_LiveDocs.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.LiveDocs%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/Index/SegmentWriteState.cs/#L72">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_LiveDocs_" data-uid="Lucene.Net.Index.SegmentWriteState.LiveDocs*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_LiveDocs" data-uid="Lucene.Net.Index.SegmentWriteState.LiveDocs">LiveDocs</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Util.IMutableBits.html">IMutableBits</a> recording live documents; this is |
| only set if there is one or more deleted documents.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IMutableBits LiveDocs { get; set; }</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.Util.IMutableBits.html">IMutableBits</a></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_Index_SegmentWriteState_SegmentInfo.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.SegmentInfo%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/Index/SegmentWriteState.cs/#L46">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_SegmentInfo_" data-uid="Lucene.Net.Index.SegmentWriteState.SegmentInfo*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_SegmentInfo" data-uid="Lucene.Net.Index.SegmentWriteState.SegmentInfo">SegmentInfo</h4> |
| <div class="markdown level1 summary"><p><a class="xref" href="Lucene.Net.Index.SegmentInfo.html">SegmentInfo</a> describing this segment. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SegmentInfo SegmentInfo { 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.Index.SegmentInfo.html">SegmentInfo</a></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_Index_SegmentWriteState_SegmentSuffix.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.SegmentSuffix%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/Index/SegmentWriteState.cs/#L82">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_SegmentSuffix_" data-uid="Lucene.Net.Index.SegmentWriteState.SegmentSuffix*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_SegmentSuffix" data-uid="Lucene.Net.Index.SegmentWriteState.SegmentSuffix">SegmentSuffix</h4> |
| <div class="markdown level1 summary"><p>Unique suffix for any postings files written for this |
| segment. <a class="xref" href="Lucene.Net.Codecs.PerField.PerFieldPostingsFormat.html">PerFieldPostingsFormat</a> sets this for |
| each of the postings formats it wraps. If you create |
| a new <a class="xref" href="Lucene.Net.Codecs.PostingsFormat.html">PostingsFormat</a> then any files you |
| write/read must be derived using this suffix (use |
| <a class="xref" href="Lucene.Net.Index.IndexFileNames.html#Lucene_Net_Index_IndexFileNames_SegmentFileName_System_String_System_String_System_String_">SegmentFileName(String, String, String)</a>).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string SegmentSuffix { 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.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_Index_SegmentWriteState_SegUpdates.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.SegUpdates%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/Index/SegmentWriteState.cs/#L66">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_SegUpdates_" data-uid="Lucene.Net.Index.SegmentWriteState.SegUpdates*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_SegUpdates" data-uid="Lucene.Net.Index.SegmentWriteState.SegUpdates">SegUpdates</h4> |
| <div class="markdown level1 summary"><p>Deletes and updates to apply while we are flushing the segment. A <a class="xref" href="Lucene.Net.Index.Term.html">Term</a> is |
| enrolled in here if it was deleted/updated at one point, and it's mapped to |
| the docIDUpto, meaning any docID < docIDUpto containing this term should |
| be deleted/updated.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public BufferedUpdates SegUpdates { 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.Index.BufferedUpdates.html">BufferedUpdates</a></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_Index_SegmentWriteState_TermIndexInterval.md&value=---%0Auid%3A%20Lucene.Net.Index.SegmentWriteState.TermIndexInterval%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/Index/SegmentWriteState.cs/#L91">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_SegmentWriteState_TermIndexInterval_" data-uid="Lucene.Net.Index.SegmentWriteState.TermIndexInterval*"></a> |
| <h4 id="Lucene_Net_Index_SegmentWriteState_TermIndexInterval" data-uid="Lucene.Net.Index.SegmentWriteState.TermIndexInterval">TermIndexInterval</h4> |
| <div class="markdown level1 summary"><p>Expert: The fraction of terms in the "dictionary" which should be stored |
| in RAM. Smaller values use more memory, but make searching slightly |
| faster, while larger values use less memory and make searching slightly |
| slower. Searching is typically not dominated by dictionary lookup, so |
| tweaking this is rarely useful.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int TermIndexInterval { get; set; }</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.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </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_Index_SegmentWriteState.md&value=---%0Auid%3A%20Lucene.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" 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/Index/SegmentWriteState.cs/#L32" 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> |
