| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class TermContext |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class TermContext |
| | 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.Index.TermContext"> |
| |
| |
| <h1 id="Lucene_Net_Index_TermContext" data-uid="Lucene.Net.Index.TermContext" class="text-break">Class TermContext |
| </h1> |
| <div class="markdown level0 summary"><p>Maintains a <a class="xref" href="Lucene.Net.Index.IndexReader.html">IndexReader</a> <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> view over |
| <a class="xref" href="Lucene.Net.Index.IndexReader.html">IndexReader</a> instances containing a single term. The |
| <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a> doesn't track if the given <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> |
| objects are valid, neither if the <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> instances refer to the |
| same terms in the associated readers. |
| <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">TermContext</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_TermContext_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[Serializable] |
| public sealed class TermContext</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_Index_TermContext__ctor_Lucene_Net_Index_IndexReaderContext_.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.%23ctor(Lucene.Net.Index.IndexReaderContext)%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/Index/TermContext.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext__ctor_" data-uid="Lucene.Net.Index.TermContext.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_TermContext__ctor_Lucene_Net_Index_IndexReaderContext_" data-uid="Lucene.Net.Index.TermContext.#ctor(Lucene.Net.Index.IndexReaderContext)">TermContext(IndexReaderContext)</h4> |
| <div class="markdown level1 summary"><p>Creates an empty <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a> from a <a class="xref" href="Lucene.Net.Index.IndexReaderContext.html">IndexReaderContext</a></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public TermContext(IndexReaderContext 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.Index.IndexReaderContext.html">IndexReaderContext</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_TermContext__ctor_Lucene_Net_Index_IndexReaderContext_Lucene_Net_Index_TermState_System_Int32_System_Int32_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.%23ctor(Lucene.Net.Index.IndexReaderContext%2CLucene.Net.Index.TermState%2CSystem.Int32%2CSystem.Int32%2CSystem.Int64)%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/Index/TermContext.cs/#L79">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext__ctor_" data-uid="Lucene.Net.Index.TermContext.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_TermContext__ctor_Lucene_Net_Index_IndexReaderContext_Lucene_Net_Index_TermState_System_Int32_System_Int32_System_Int64_" data-uid="Lucene.Net.Index.TermContext.#ctor(Lucene.Net.Index.IndexReaderContext,Lucene.Net.Index.TermState,System.Int32,System.Int32,System.Int64)">TermContext(IndexReaderContext, TermState, Int32, Int32, Int64)</h4> |
| <div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a> with an initial <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a>, |
| <a class="xref" href="Lucene.Net.Index.IndexReader.html">IndexReader</a> pair.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public TermContext(IndexReaderContext context, TermState state, int ord, int docFreq, long totalTermFreq)</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.IndexReaderContext.html">IndexReaderContext</a></td> |
| <td><span class="parametername">context</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a></td> |
| <td><span class="parametername">state</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">ord</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docFreq</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">totalTermFreq</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_Index_TermContext_DocFreq.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.DocFreq%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/Index/TermContext.cs/#L182">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext_DocFreq_" data-uid="Lucene.Net.Index.TermContext.DocFreq*"></a> |
| <h4 id="Lucene_Net_Index_TermContext_DocFreq" data-uid="Lucene.Net.Index.TermContext.DocFreq">DocFreq</h4> |
| <div class="markdown level1 summary"><p>expert: only available for queries that want to lie about docfreq |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int DocFreq { 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.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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_TermContext_TopReaderContext.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.TopReaderContext%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/Index/TermContext.cs/#L47">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext_TopReaderContext_" data-uid="Lucene.Net.Index.TermContext.TopReaderContext*"></a> |
| <h4 id="Lucene_Net_Index_TermContext_TopReaderContext" data-uid="Lucene.Net.Index.TermContext.TopReaderContext">TopReaderContext</h4> |
| <div class="markdown level1 summary"><p>Holds the <a class="xref" href="Lucene.Net.Index.IndexReaderContext.html">IndexReaderContext</a> of the top-level |
| <a class="xref" href="Lucene.Net.Index.IndexReader.html">IndexReader</a>, used internally only for |
| asserting. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IndexReaderContext TopReaderContext { 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.IndexReaderContext.html">IndexReaderContext</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_TermContext_TotalTermFreq.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.TotalTermFreq%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/Index/TermContext.cs/#L175">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext_TotalTermFreq_" data-uid="Lucene.Net.Index.TermContext.TotalTermFreq*"></a> |
| <h4 id="Lucene_Net_Index_TermContext_TotalTermFreq" data-uid="Lucene.Net.Index.TermContext.TotalTermFreq">TotalTermFreq</h4> |
| <div class="markdown level1 summary"><p>Returns the accumulated term frequency of all <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> |
| instances passed to <a class="xref" href="Lucene.Net.Index.TermContext.html#Lucene_Net_Index_TermContext_Register_Lucene_Net_Index_TermState_System_Int32_System_Int32_System_Int64_">Register(TermState, Int32, Int32, Int64)</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public long TotalTermFreq { 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.Int64</span></td> |
| <td><p>the accumulated term frequency of all <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> |
| instances passed to <a class="xref" href="Lucene.Net.Index.TermContext.html#Lucene_Net_Index_TermContext_Register_Lucene_Net_Index_TermState_System_Int32_System_Int32_System_Int64_">Register(TermState, Int32, Int32, Int64)</a>. </p> |
| </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_Index_TermContext_Build_Lucene_Net_Index_IndexReaderContext_Lucene_Net_Index_Term_.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.Build(Lucene.Net.Index.IndexReaderContext%2CLucene.Net.Index.Term)%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/Index/TermContext.cs/#L93">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext_Build_" data-uid="Lucene.Net.Index.TermContext.Build*"></a> |
| <h4 id="Lucene_Net_Index_TermContext_Build_Lucene_Net_Index_IndexReaderContext_Lucene_Net_Index_Term_" data-uid="Lucene.Net.Index.TermContext.Build(Lucene.Net.Index.IndexReaderContext,Lucene.Net.Index.Term)">Build(IndexReaderContext, Term)</h4> |
| <div class="markdown level1 summary"><p>Creates a <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a> from a top-level <a class="xref" href="Lucene.Net.Index.IndexReaderContext.html">IndexReaderContext</a> and the |
| given <a class="xref" href="Lucene.Net.Index.Term.html">Term</a>. this method will lookup the given term in all context's leaf readers |
| and register each of the readers containing the term in the returned <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a> |
| using the leaf reader's ordinal. |
| <p> |
| Note: the given context must be a top-level context.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TermContext Build(IndexReaderContext context, Term term)</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.IndexReaderContext.html">IndexReaderContext</a></td> |
| <td><span class="parametername">context</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.Term.html">Term</a></td> |
| <td><span class="parametername">term</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_TermContext_Clear.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.Clear%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/Index/TermContext.cs/#L126">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext_Clear_" data-uid="Lucene.Net.Index.TermContext.Clear*"></a> |
| <h4 id="Lucene_Net_Index_TermContext_Clear" data-uid="Lucene.Net.Index.TermContext.Clear">Clear()</h4> |
| <div class="markdown level1 summary"><p>Clears the <a class="xref" href="Lucene.Net.Index.TermContext.html">TermContext</a> internal state and removes all |
| registered <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a>s</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Clear()</code></pre> |
| </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_Index_TermContext_Get_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.Get(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/Index/TermContext.cs/#L164">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext_Get_" data-uid="Lucene.Net.Index.TermContext.Get*"></a> |
| <h4 id="Lucene_Net_Index_TermContext_Get_System_Int32_" data-uid="Lucene.Net.Index.TermContext.Get(System.Int32)">Get(Int32)</h4> |
| <div class="markdown level1 summary"><p>Returns the <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> for an leaf ordinal or <code>null</code> if no |
| <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> for the ordinal was registered.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public TermState Get(int ord)</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">ord</span></td> |
| <td><p>The readers leaf ordinal to get the <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> for. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> for the given readers ord or <code>null</code> if no |
| <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> for the reader was registered </p> |
| </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_Index_TermContext_Register_Lucene_Net_Index_TermState_System_Int32_System_Int32_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext.Register(Lucene.Net.Index.TermState%2CSystem.Int32%2CSystem.Int32%2CSystem.Int64)%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/Index/TermContext.cs/#L136">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_TermContext_Register_" data-uid="Lucene.Net.Index.TermContext.Register*"></a> |
| <h4 id="Lucene_Net_Index_TermContext_Register_Lucene_Net_Index_TermState_System_Int32_System_Int32_System_Int64_" data-uid="Lucene.Net.Index.TermContext.Register(Lucene.Net.Index.TermState,System.Int32,System.Int32,System.Int64)">Register(TermState, Int32, Int32, Int64)</h4> |
| <div class="markdown level1 summary"><p>Registers and associates a <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> with an leaf ordinal. The leaf ordinal |
| should be derived from a <a class="xref" href="Lucene.Net.Index.IndexReaderContext.html">IndexReaderContext</a>'s leaf ord.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Register(TermState state, int ord, int docFreq, long totalTermFreq)</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.TermState.html">TermState</a></td> |
| <td><span class="parametername">state</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">ord</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docFreq</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">totalTermFreq</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_TermContext.md&value=---%0Auid%3A%20Lucene.Net.Index.TermContext%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/Index/TermContext.cs/#L36" 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> |
