blob: 1666f29ef62f3d486e2bb1a6ea59605aac840155 [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 CompressingTermVectorsWriter
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CompressingTermVectorsWriter
| 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.Compressing.CompressingTermVectorsWriter">
<h1 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter" class="text-break">Class CompressingTermVectorsWriter
</h1>
<div class="markdown level0 summary"><p><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html">TermVectorsWriter</a> for <a class="xref" href="Lucene.Net.Codecs.Compressing.CompressingTermVectorsFormat.html">CompressingTermVectorsFormat</a>.
<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.TermVectorsWriter.html">TermVectorsWriter</a></div>
<div class="level2"><span class="xref">CompressingTermVectorsWriter</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.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_FinishTerm">TermVectorsWriter.FinishTerm()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_AddAllDocVectors_Lucene_Net_Index_Fields_Lucene_Net_Index_MergeState_">TermVectorsWriter.AddAllDocVectors(Fields, MergeState)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_Dispose">TermVectorsWriter.Dispose()</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.Compressing.html">Lucene.Net.Codecs.Compressing</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class CompressingTermVectorsWriter : TermVectorsWriter, 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_Compressing_CompressingTermVectorsWriter__ctor_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_System_String_Lucene_Net_Store_IOContext_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.%23ctor(Lucene.Net.Store.Directory%2CLucene.Net.Index.SegmentInfo%2CSystem.String%2CLucene.Net.Store.IOContext%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/fix/apidocs-layout/src/Lucene.Net/Codecs/Compressing/CompressingTermVectorsWriter.cs/#L249">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter__ctor_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.#ctor*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter__ctor_Lucene_Net_Store_Directory_Lucene_Net_Index_SegmentInfo_System_String_Lucene_Net_Store_IOContext_System_String_Lucene_Net_Codecs_Compressing_CompressionMode_System_Int32_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.#ctor(Lucene.Net.Store.Directory,Lucene.Net.Index.SegmentInfo,System.String,Lucene.Net.Store.IOContext,System.String,Lucene.Net.Codecs.Compressing.CompressionMode,System.Int32)">CompressingTermVectorsWriter(Directory, SegmentInfo, String, IOContext, String, CompressionMode, Int32)</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 CompressingTermVectorsWriter(Directory directory, SegmentInfo si, string segmentSuffix, IOContext context, 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><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><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.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">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>
<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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Comparer.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Comparer%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/Compressing/CompressingTermVectorsWriter.cs/#L807">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Comparer_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Comparer*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Comparer" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Comparer">Comparer</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 IComparer&lt;BytesRef&gt; Comparer { 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.Collections.Generic.IComparer</span>&lt;<a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_Comparer">TermVectorsWriter.Comparer</a></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Abort.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Abort%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/Compressing/CompressingTermVectorsWriter.cs/#L322">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Abort_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Abort*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Abort" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Abort">Abort()</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 Abort()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_Abort">TermVectorsWriter.Abort()</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_Compressing_CompressingTermVectorsWriter_AddPosition_System_Int32_System_Int32_System_Int32_Lucene_Net_Util_BytesRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.AddPosition(System.Int32%2CSystem.Int32%2CSystem.Int32%2CLucene.Net.Util.BytesRef)%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/Compressing/CompressingTermVectorsWriter.cs/#L378">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_AddPosition_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.AddPosition*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_AddPosition_System_Int32_System_Int32_System_Int32_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.AddPosition(System.Int32,System.Int32,System.Int32,Lucene.Net.Util.BytesRef)">AddPosition(Int32, Int32, Int32, BytesRef)</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 AddPosition(int position, int startOffset, int endOffset, BytesRef payload)</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><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>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">payload</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_AddPosition_System_Int32_System_Int32_System_Int32_Lucene_Net_Util_BytesRef_">TermVectorsWriter.AddPosition(Int32, Int32, Int32, BytesRef)</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_Compressing_CompressingTermVectorsWriter_AddProx_System_Int32_Lucene_Net_Store_DataInput_Lucene_Net_Store_DataInput_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.AddProx(System.Int32%2CLucene.Net.Store.DataInput%2CLucene.Net.Store.DataInput)%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/Compressing/CompressingTermVectorsWriter.cs/#L809">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_AddProx_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.AddProx*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_AddProx_System_Int32_Lucene_Net_Store_DataInput_Lucene_Net_Store_DataInput_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.AddProx(System.Int32,Lucene.Net.Store.DataInput,Lucene.Net.Store.DataInput)">AddProx(Int32, DataInput, DataInput)</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 AddProx(int numProx, DataInput positions, DataInput offsets)</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">numProx</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a></td>
<td><span class="parametername">positions</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a></td>
<td><span class="parametername">offsets</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_AddProx_System_Int32_Lucene_Net_Store_DataInput_Lucene_Net_Store_DataInput_">TermVectorsWriter.AddProx(Int32, DataInput, DataInput)</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_Compressing_CompressingTermVectorsWriter_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.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/Compressing/CompressingTermVectorsWriter.cs/#L305">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Dispose_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Dispose*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Dispose_System_Boolean_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.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.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_Dispose_System_Boolean_">TermVectorsWriter.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_Compressing_CompressingTermVectorsWriter_Finish_Lucene_Net_Index_FieldInfos_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Finish(Lucene.Net.Index.FieldInfos%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/Compressing/CompressingTermVectorsWriter.cs/#L793">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Finish_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Finish*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Finish_Lucene_Net_Index_FieldInfos_System_Int32_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Finish(Lucene.Net.Index.FieldInfos,System.Int32)">Finish(FieldInfos, 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 Finish(FieldInfos fis, int numDocs)</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.FieldInfos.html">FieldInfos</a></td>
<td><span class="parametername">fis</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">numDocs</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_Finish_Lucene_Net_Index_FieldInfos_System_Int32_">TermVectorsWriter.Finish(FieldInfos, 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_Compressing_CompressingTermVectorsWriter_FinishDocument.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.FinishDocument%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/Compressing/CompressingTermVectorsWriter.cs/#L335">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_FinishDocument_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.FinishDocument*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_FinishDocument" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.FinishDocument">FinishDocument()</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 FinishDocument()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_FinishDocument">TermVectorsWriter.FinishDocument()</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_Compressing_CompressingTermVectorsWriter_FinishField.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.FinishField%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/Compressing/CompressingTermVectorsWriter.cs/#L356">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_FinishField_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.FinishField*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_FinishField" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.FinishField">FinishField()</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 FinishField()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_FinishField">TermVectorsWriter.FinishField()</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_Compressing_CompressingTermVectorsWriter_Merge_Lucene_Net_Index_MergeState_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Merge(Lucene.Net.Index.MergeState)%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/Compressing/CompressingTermVectorsWriter.cs/#L883">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Merge_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Merge*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_Merge_Lucene_Net_Index_MergeState_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.Merge(Lucene.Net.Index.MergeState)">Merge(MergeState)</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 Merge(MergeState mergeState)</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.MergeState.html">MergeState</a></td>
<td><span class="parametername">mergeState</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.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_Merge_Lucene_Net_Index_MergeState_">TermVectorsWriter.Merge(MergeState)</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_Compressing_CompressingTermVectorsWriter_StartDocument_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartDocument(System.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/Compressing/CompressingTermVectorsWriter.cs/#L329">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_StartDocument_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartDocument*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_StartDocument_System_Int32_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartDocument(System.Int32)">StartDocument(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 StartDocument(int numVectorFields)</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">numVectorFields</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_StartDocument_System_Int32_">TermVectorsWriter.StartDocument(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_Compressing_CompressingTermVectorsWriter_StartField_Lucene_Net_Index_FieldInfo_System_Int32_System_Boolean_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartField(Lucene.Net.Index.FieldInfo%2CSystem.Int32%2CSystem.Boolean%2CSystem.Boolean%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/Compressing/CompressingTermVectorsWriter.cs/#L349">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_StartField_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartField*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_StartField_Lucene_Net_Index_FieldInfo_System_Int32_System_Boolean_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartField(Lucene.Net.Index.FieldInfo,System.Int32,System.Boolean,System.Boolean,System.Boolean)">StartField(FieldInfo, Int32, Boolean, Boolean, 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 StartField(FieldInfo info, int numTerms, bool positions, bool offsets, bool payloads)</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">info</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">numTerms</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">positions</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">offsets</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">payloads</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_StartField_Lucene_Net_Index_FieldInfo_System_Int32_System_Boolean_System_Boolean_System_Boolean_">TermVectorsWriter.StartField(FieldInfo, Int32, Boolean, Boolean, 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_Compressing_CompressingTermVectorsWriter_StartTerm_Lucene_Net_Util_BytesRef_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartTerm(Lucene.Net.Util.BytesRef%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/Compressing/CompressingTermVectorsWriter.cs/#L362">View Source</a>
</span>
<a id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_StartTerm_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartTerm*"></a>
<h4 id="Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter_StartTerm_Lucene_Net_Util_BytesRef_System_Int32_" data-uid="Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter.StartTerm(Lucene.Net.Util.BytesRef,System.Int32)">StartTerm(BytesRef, 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 StartTerm(BytesRef term, int freq)</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.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">term</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">freq</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Codecs.TermVectorsWriter.html#Lucene_Net_Codecs_TermVectorsWriter_StartTerm_Lucene_Net_Util_BytesRef_System_Int32_">TermVectorsWriter.StartTerm(BytesRef, Int32)</a></div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Compressing_CompressingTermVectorsWriter.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.CompressingTermVectorsWriter%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/Compressing/CompressingTermVectorsWriter.cs/#L57" 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>