blob: ebf36504f2dba4a85faa17402608dcb8fae032eb [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Lucene41PostingsWriter
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Lucene41PostingsWriter
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.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">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<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.Lucene41.Lucene41PostingsWriter">
<h1 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter" class="text-break">Class Lucene41PostingsWriter
</h1>
<div class="markdown level0 summary"><p>Concrete class that writes docId(maybe frq,pos,offset,payloads) list
with postings format.
<p>
Postings list for each term will be stored separately.
<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.PostingsConsumer.html">PostingsConsumer</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html">PostingsWriterBase</a></div>
<div class="level3"><span class="xref">Lucene41PostingsWriter</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_Dispose">PostingsWriterBase.Dispose()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Codecs.PostingsConsumer.html#Lucene_Net_Codecs_PostingsConsumer_Merge_Lucene_Net_Index_MergeState_Lucene_Net_Index_IndexOptions_Lucene_Net_Index_DocsEnum_Lucene_Net_Util_FixedBitSet_">PostingsConsumer.Merge(MergeState, IndexOptions, DocsEnum, FixedBitSet)</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Codecs.Lucene41.html">Lucene.Net.Codecs.Lucene41</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class Lucene41PostingsWriter : PostingsWriterBase, IDisposable</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter__ctor_Lucene_Net_Index_SegmentWriteState_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.%23ctor(Lucene.Net.Index.SegmentWriteState)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L196">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter__ctor_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.#ctor*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter__ctor_Lucene_Net_Index_SegmentWriteState_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.#ctor(Lucene.Net.Index.SegmentWriteState)">Lucene41PostingsWriter(SegmentWriteState)</h4>
<div class="markdown level1 summary"><p>Creates a postings writer with <pre><code>PackedInts.COMPACT</code></pre> </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Lucene41PostingsWriter(SegmentWriteState state)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Index.SegmentWriteState.html">SegmentWriteState</a></td>
<td><span class="parametername">state</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter__ctor_Lucene_Net_Index_SegmentWriteState_System_Single_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.%23ctor(Lucene.Net.Index.SegmentWriteState%2CSystem.Single)%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L120">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter__ctor_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.#ctor*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter__ctor_Lucene_Net_Index_SegmentWriteState_System_Single_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.#ctor(Lucene.Net.Index.SegmentWriteState,System.Single)">Lucene41PostingsWriter(SegmentWriteState, Single)</h4>
<div class="markdown level1 summary"><p>Creates a postings writer with the specified PackedInts overhead ratio </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Lucene41PostingsWriter(SegmentWriteState state, float acceptableOverheadRatio)</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.Single</span></td>
<td><span class="parametername">acceptableOverheadRatio</span></td>
<td></td>
</tr>
</tbody>
</table>
<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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_AddPosition_System_Int32_Lucene_Net_Util_BytesRef_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.AddPosition(System.Int32%2CLucene.Net.Util.BytesRef%2CSystem.Int32%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L360">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_AddPosition_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.AddPosition*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_AddPosition_System_Int32_Lucene_Net_Util_BytesRef_System_Int32_System_Int32_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.AddPosition(System.Int32,Lucene.Net.Util.BytesRef,System.Int32,System.Int32)">AddPosition(Int32, BytesRef, Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Add a new position &amp; payload </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void AddPosition(int position, BytesRef payload, int startOffset, int endOffset)</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.Int32</span></td>
<td><span class="parametername">position</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">payload</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">startOffset</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">endOffset</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsConsumer.html#Lucene_Net_Codecs_PostingsConsumer_AddPosition_System_Int32_Lucene_Net_Util_BytesRef_System_Int32_System_Int32_">PostingsConsumer.AddPosition(Int32, BytesRef, Int32, Int32)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.Dispose(System.Boolean)%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L667">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_Dispose_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.Dispose*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_Dispose_System_Boolean_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.Dispose(System.Boolean)">Dispose(Boolean)</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">protected override void Dispose(bool disposing)</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.Boolean</span></td>
<td><span class="parametername">disposing</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_Dispose_System_Boolean_">PostingsWriterBase.Dispose(Boolean)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_EncodeTerm_System_Int64___Lucene_Net_Store_DataOutput_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.EncodeTerm(System.Int64%5B%5D%2CLucene.Net.Store.DataOutput%2CLucene.Net.Index.FieldInfo%2CLucene.Net.Codecs.BlockTermState%2CSystem.Boolean)%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L633">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_EncodeTerm_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.EncodeTerm*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_EncodeTerm_System_Int64___Lucene_Net_Store_DataOutput_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_System_Boolean_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.EncodeTerm(System.Int64[],Lucene.Net.Store.DataOutput,Lucene.Net.Index.FieldInfo,Lucene.Net.Codecs.BlockTermState,System.Boolean)">EncodeTerm(Int64[], DataOutput, FieldInfo, BlockTermState, Boolean)</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 void EncodeTerm(long[] longs, DataOutput out, FieldInfo fieldInfo, BlockTermState state, bool absolute)</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.Int64</span>[]</td>
<td><span class="parametername">longs</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Store.DataOutput.html">DataOutput</a></td>
<td><span class="parametername">out</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Index.FieldInfo.html">FieldInfo</a></td>
<td><span class="parametername">fieldInfo</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</a></td>
<td><span class="parametername">state</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">absolute</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_EncodeTerm_System_Int64___Lucene_Net_Store_DataOutput_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_System_Boolean_">PostingsWriterBase.EncodeTerm(Int64[], DataOutput, FieldInfo, BlockTermState, Boolean)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_FinishDoc.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.FinishDoc%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L422">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_FinishDoc_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.FinishDoc*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_FinishDoc" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.FinishDoc">FinishDoc()</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 void FinishDoc()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsConsumer.html#Lucene_Net_Codecs_PostingsConsumer_FinishDoc">PostingsConsumer.FinishDoc()</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_FinishTerm_Lucene_Net_Codecs_BlockTermState_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.FinishTerm(Lucene.Net.Codecs.BlockTermState)%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L449">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_FinishTerm_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.FinishTerm*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_FinishTerm_Lucene_Net_Codecs_BlockTermState_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.FinishTerm(Lucene.Net.Codecs.BlockTermState)">FinishTerm(BlockTermState)</h4>
<div class="markdown level1 summary"><p>Called when we are done adding docs to this term. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void FinishTerm(BlockTermState state)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</a></td>
<td><span class="parametername">state</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_FinishTerm_Lucene_Net_Codecs_BlockTermState_">PostingsWriterBase.FinishTerm(BlockTermState)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_Init_Lucene_Net_Store_IndexOutput_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.Init(Lucene.Net.Store.IndexOutput)%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L248">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_Init_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.Init*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_Init_Lucene_Net_Store_IndexOutput_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.Init(Lucene.Net.Store.IndexOutput)">Init(IndexOutput)</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 void Init(IndexOutput termsOut)</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.IndexOutput.html">IndexOutput</a></td>
<td><span class="parametername">termsOut</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_Init_Lucene_Net_Store_IndexOutput_">PostingsWriterBase.Init(IndexOutput)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_NewTermState.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.NewTermState%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L242">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_NewTermState_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.NewTermState*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_NewTermState" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.NewTermState">NewTermState()</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 BlockTermState NewTermState()</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><a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_NewTermState">PostingsWriterBase.NewTermState()</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_SetField_Lucene_Net_Index_FieldInfo_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.SetField(Lucene.Net.Index.FieldInfo)%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L255">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_SetField_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.SetField*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_SetField_Lucene_Net_Index_FieldInfo_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.SetField(Lucene.Net.Index.FieldInfo)">SetField(FieldInfo)</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 int SetField(FieldInfo fieldInfo)</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.FieldInfo.html">FieldInfo</a></td>
<td><span class="parametername">fieldInfo</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_SetField_Lucene_Net_Index_FieldInfo_">PostingsWriterBase.SetField(FieldInfo)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_StartDoc_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.StartDoc(System.Int32%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L301">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_StartDoc_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.StartDoc*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_StartDoc_System_Int32_System_Int32_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.StartDoc(System.Int32,System.Int32)">StartDoc(Int32, Int32)</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 void StartDoc(int docId, int termDocFreq)</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.Int32</span></td>
<td><span class="parametername">docId</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">termDocFreq</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsConsumer.html#Lucene_Net_Codecs_PostingsConsumer_StartDoc_System_Int32_System_Int32_">PostingsConsumer.StartDoc(Int32, Int32)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_StartTerm.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.StartTerm%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L282">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_StartTerm_" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.StartTerm*"></a>
<h4 id="Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter_StartTerm" data-uid="Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter.StartTerm">StartTerm()</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 void StartTerm()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_StartTerm">PostingsWriterBase.StartTerm()</a></div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
<h3 id="seealso">See Also</h3>
<div class="seealso">
<div><span class="xref">Lucene.Net.Codecs.Lucene41.Lucene41SkipWriter</span></div>
</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Lucene41_Lucene41PostingsWriter.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Lucene41.Lucene41PostingsWriter%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Lucene41/Lucene41PostingsWriter.cs/#L46" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</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>