| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class FilteredTermsEnum |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class FilteredTermsEnum |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Index.FilteredTermsEnum"> |
| |
| |
| <h1 id="Lucene_Net_Index_FilteredTermsEnum" data-uid="Lucene.Net.Index.FilteredTermsEnum" class="text-break">Class FilteredTermsEnum |
| </h1> |
| <div class="markdown level0 summary"><p>Abstract class for enumerating a subset of all terms. |
| <p> |
| Term enumerations are always ordered by |
| <a class="xref" href="Lucene.Net.Index.FilteredTermsEnum.html#Lucene_Net_Index_FilteredTermsEnum_Comparer">Comparer</a>. Each term in the enumeration is |
| greater than all that precede it. |
| <p><code>Please note:</code> Consumers of this enumeration cannot |
| call <code>Seek()</code>, it is forward only; it throws |
| <span class="xref">System.NotSupportedException</span> when a seeking method |
| is called.</p> |
| </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.Index.TermsEnum.html">TermsEnum</a></div> |
| <div class="level2"><span class="xref">FilteredTermsEnum</span></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Index.SingleTermsEnum.html">SingleTermsEnum</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Search.PrefixTermsEnum.html">PrefixTermsEnum</a></div> |
| <div class="level3"><a class="xref" href="Lucene.Net.Search.TermRangeTermsEnum.html">TermRangeTermsEnum</a></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Util.IBytesRefIterator.html">IBytesRefIterator</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Docs_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_">TermsEnum.Docs(IBits, DocsEnum)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_DocsAndPositions_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_">TermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_EMPTY">TermsEnum.EMPTY</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.Index.html">Lucene.Net.Index</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Index_FilteredTermsEnum_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class FilteredTermsEnum : TermsEnum, IBytesRefIterator</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum__ctor_Lucene_Net_Index_TermsEnum_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.%23ctor(Lucene.Net.Index.TermsEnum)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L88">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum__ctor_" data-uid="Lucene.Net.Index.FilteredTermsEnum.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum__ctor_Lucene_Net_Index_TermsEnum_" data-uid="Lucene.Net.Index.FilteredTermsEnum.#ctor(Lucene.Net.Index.TermsEnum)">FilteredTermsEnum(TermsEnum)</h4> |
| <div class="markdown level1 summary"><p>Creates a filtered <a class="xref" href="Lucene.Net.Index.TermsEnum.html">TermsEnum</a> on a terms enum. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FilteredTermsEnum(TermsEnum tenum)</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.TermsEnum.html">TermsEnum</a></td> |
| <td><span class="parametername">tenum</span></td> |
| <td><p>the terms enumeration to filter. </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum__ctor_Lucene_Net_Index_TermsEnum_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.%23ctor(Lucene.Net.Index.TermsEnum%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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L97">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum__ctor_" data-uid="Lucene.Net.Index.FilteredTermsEnum.#ctor*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum__ctor_Lucene_Net_Index_TermsEnum_System_Boolean_" data-uid="Lucene.Net.Index.FilteredTermsEnum.#ctor(Lucene.Net.Index.TermsEnum,System.Boolean)">FilteredTermsEnum(TermsEnum, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Creates a filtered <a class="xref" href="Lucene.Net.Index.TermsEnum.html">TermsEnum</a> on a terms enum. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FilteredTermsEnum(TermsEnum tenum, bool startWithSeek)</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.TermsEnum.html">TermsEnum</a></td> |
| <td><span class="parametername">tenum</span></td> |
| <td><p>the terms enumeration to filter. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">startWithSeek</span></td> |
| <td><p>start with seek </p> |
| </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_Attributes.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.Attributes%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L146">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_Attributes_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Attributes*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_Attributes" data-uid="Lucene.Net.Index.FilteredTermsEnum.Attributes">Attributes</h4> |
| <div class="markdown level1 summary"><p>Returns the related attributes, the returned <a class="xref" href="Lucene.Net.Util.AttributeSource.html">AttributeSource</a> |
| is shared with the delegate <a class="xref" href="Lucene.Net.Index.TermsEnum.html">TermsEnum</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override AttributeSource Attributes { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.AttributeSource.html">AttributeSource</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Attributes">TermsEnum.Attributes</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_Comparer.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L150">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_Comparer_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Comparer*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_Comparer" data-uid="Lucene.Net.Index.FilteredTermsEnum.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<BytesRef> 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><<a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Comparer">TermsEnum.Comparer</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_DocFreq.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L152">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_DocFreq_" data-uid="Lucene.Net.Index.FilteredTermsEnum.DocFreq*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_DocFreq" data-uid="Lucene.Net.Index.FilteredTermsEnum.DocFreq">DocFreq</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 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> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_DocFreq">TermsEnum.DocFreq</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_Ord.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.Ord%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L183">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_Ord_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Ord*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_Ord" data-uid="Lucene.Net.Index.FilteredTermsEnum.Ord">Ord</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 long Ord { 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></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Ord">TermsEnum.Ord</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_Term.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L148">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_Term_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Term*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_Term" data-uid="Lucene.Net.Index.FilteredTermsEnum.Term">Term</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 BytesRef Term { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Term">TermsEnum.Term</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_TotalTermFreq.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L154">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_TotalTermFreq_" data-uid="Lucene.Net.Index.FilteredTermsEnum.TotalTermFreq*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_TotalTermFreq" data-uid="Lucene.Net.Index.FilteredTermsEnum.TotalTermFreq">TotalTermFreq</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 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></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_TotalTermFreq">TermsEnum.TotalTermFreq</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_Accept_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.Accept(Lucene.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L83">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_Accept_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Accept*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_Accept_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Accept(Lucene.Net.Util.BytesRef)">Accept(BytesRef)</h4> |
| <div class="markdown level1 summary"><p>Return if term is accepted, not accepted or the iteration should ended |
| (and possibly seek).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected abstract FilteredTermsEnum.AcceptStatus Accept(BytesRef 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.Util.BytesRef.html">BytesRef</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.FilteredTermsEnum.AcceptStatus.html">FilteredTermsEnum.AcceptStatus</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_Docs_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_Lucene_Net_Index_DocsFlags_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.Docs(Lucene.Net.Util.IBits%2CLucene.Net.Index.DocsEnum%2CLucene.Net.Index.DocsFlags)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L185">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_Docs_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Docs*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_Docs_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_Lucene_Net_Index_DocsFlags_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Docs(Lucene.Net.Util.IBits,Lucene.Net.Index.DocsEnum,Lucene.Net.Index.DocsFlags)">Docs(IBits, DocsEnum, DocsFlags)</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 DocsEnum Docs(IBits bits, DocsEnum reuse, DocsFlags flags)</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.IBits.html">IBits</a></td> |
| <td><span class="parametername">bits</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.DocsEnum.html">DocsEnum</a></td> |
| <td><span class="parametername">reuse</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.DocsFlags.html">DocsFlags</a></td> |
| <td><span class="parametername">flags</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.DocsEnum.html">DocsEnum</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Docs_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_Lucene_Net_Index_DocsFlags_">TermsEnum.Docs(IBits, DocsEnum, DocsFlags)</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_DocsAndPositions_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_Lucene_Net_Index_DocsAndPositionsFlags_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.DocsAndPositions(Lucene.Net.Util.IBits%2CLucene.Net.Index.DocsAndPositionsEnum%2CLucene.Net.Index.DocsAndPositionsFlags)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L190">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_DocsAndPositions_" data-uid="Lucene.Net.Index.FilteredTermsEnum.DocsAndPositions*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_DocsAndPositions_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_Lucene_Net_Index_DocsAndPositionsFlags_" data-uid="Lucene.Net.Index.FilteredTermsEnum.DocsAndPositions(Lucene.Net.Util.IBits,Lucene.Net.Index.DocsAndPositionsEnum,Lucene.Net.Index.DocsAndPositionsFlags)">DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)</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 DocsAndPositionsEnum DocsAndPositions(IBits bits, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)</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.IBits.html">IBits</a></td> |
| <td><span class="parametername">bits</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.DocsAndPositionsEnum.html">DocsAndPositionsEnum</a></td> |
| <td><span class="parametername">reuse</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Index.DocsAndPositionsFlags.html">DocsAndPositionsFlags</a></td> |
| <td><span class="parametername">flags</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.DocsAndPositionsEnum.html">DocsAndPositionsEnum</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_DocsAndPositions_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_Lucene_Net_Index_DocsAndPositionsFlags_">TermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_GetTermState.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.GetTermState%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L207">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_GetTermState_" data-uid="Lucene.Net.Index.FilteredTermsEnum.GetTermState*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_GetTermState" data-uid="Lucene.Net.Index.FilteredTermsEnum.GetTermState">GetTermState()</h4> |
| <div class="markdown level1 summary"><p>Returns the filtered enums term state</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override TermState GetTermState()</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.Index.TermState.html">TermState</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_GetTermState">TermsEnum.GetTermState()</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_Next.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.Next%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L213">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_Next_" data-uid="Lucene.Net.Index.FilteredTermsEnum.Next*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_Next" data-uid="Lucene.Net.Index.FilteredTermsEnum.Next">Next()</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 BytesRef Next()</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.Util.BytesRef.html">BytesRef</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Next">TermsEnum.Next()</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_NextSeekTerm_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.NextSeekTerm(Lucene.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L135">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_NextSeekTerm_" data-uid="Lucene.Net.Index.FilteredTermsEnum.NextSeekTerm*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_NextSeekTerm_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Index.FilteredTermsEnum.NextSeekTerm(Lucene.Net.Util.BytesRef)">NextSeekTerm(BytesRef)</h4> |
| <div class="markdown level1 summary"><p>On the first call to <a class="xref" href="Lucene.Net.Index.FilteredTermsEnum.html#Lucene_Net_Index_FilteredTermsEnum_Next">Next()</a> or if <a class="xref" href="Lucene.Net.Index.FilteredTermsEnum.html#Lucene_Net_Index_FilteredTermsEnum_Accept_Lucene_Net_Util_BytesRef_">Accept(BytesRef)</a> returns |
| <a class="xref" href="Lucene.Net.Index.FilteredTermsEnum.AcceptStatus.html#Lucene_Net_Index_FilteredTermsEnum_AcceptStatus_YES_AND_SEEK">YES_AND_SEEK</a> or <a class="xref" href="Lucene.Net.Index.FilteredTermsEnum.AcceptStatus.html#Lucene_Net_Index_FilteredTermsEnum_AcceptStatus_NO_AND_SEEK">NO_AND_SEEK</a>, |
| this method will be called to eventually seek the underlying <a class="xref" href="Lucene.Net.Index.TermsEnum.html">TermsEnum</a> |
| to a new position. |
| On the first call, <code data-dev-comment-type="paramref" class="paramref">currentTerm</code> will be <code>null</code>, later |
| calls will provide the term the underlying enum is positioned at. |
| This method returns per default only one time the initial seek term |
| and then <code>null</code>, so no repositioning is ever done. |
| <p> |
| Override this method, if you want a more sophisticated <a class="xref" href="Lucene.Net.Index.TermsEnum.html">TermsEnum</a>, |
| that repositions the iterator during enumeration. |
| If this method always returns <code>null</code> the enum is empty. |
| <p><code>Please note:</code> this method should always provide a greater term |
| than the last enumerated term, else the behavior of this enum |
| violates the contract for <a class="xref" href="Lucene.Net.Index.TermsEnum.html">TermsEnum</a>s.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual BytesRef NextSeekTerm(BytesRef currentTerm)</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">currentTerm</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.Util.BytesRef.html">BytesRef</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_SeekCeil_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.SeekCeil(Lucene.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L169">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_SeekCeil_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekCeil*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_SeekCeil_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekCeil(Lucene.Net.Util.BytesRef)">SeekCeil(BytesRef)</h4> |
| <div class="markdown level1 summary"><p>this enum does not support seeking! </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override TermsEnum.SeekStatus SeekCeil(BytesRef 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.Util.BytesRef.html">BytesRef</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.TermsEnum.SeekStatus.html">TermsEnum.SeekStatus</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_SeekCeil_Lucene_Net_Util_BytesRef_">TermsEnum.SeekCeil(BytesRef)</a></div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>In general, subclasses do not |
| support seeking. </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_SeekExact_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.SeekExact(Lucene.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L160">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_SeekExact_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekExact*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_SeekExact_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekExact(Lucene.Net.Util.BytesRef)">SeekExact(BytesRef)</h4> |
| <div class="markdown level1 summary"><p>this enum does not support seeking! </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override bool SeekExact(BytesRef 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.Util.BytesRef.html">BytesRef</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><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_SeekExact_Lucene_Net_Util_BytesRef_">TermsEnum.SeekExact(BytesRef)</a></div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>In general, subclasses do not |
| support seeking. </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_SeekExact_Lucene_Net_Util_BytesRef_Lucene_Net_Index_TermState_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.SeekExact(Lucene.Net.Util.BytesRef%2CLucene.Net.Index.TermState)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L199">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_SeekExact_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekExact*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_SeekExact_Lucene_Net_Util_BytesRef_Lucene_Net_Index_TermState_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekExact(Lucene.Net.Util.BytesRef,Lucene.Net.Index.TermState)">SeekExact(BytesRef, TermState)</h4> |
| <div class="markdown level1 summary"><p>this enum does not support seeking! </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 SeekExact(BytesRef term, TermState 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.Util.BytesRef.html">BytesRef</a></td> |
| <td><span class="parametername">term</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> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_SeekExact_Lucene_Net_Util_BytesRef_Lucene_Net_Index_TermState_">TermsEnum.SeekExact(BytesRef, TermState)</a></div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>In general, subclasses do not |
| support seeking. </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_SeekExact_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.SeekExact(System.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L178">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_SeekExact_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekExact*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_SeekExact_System_Int64_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SeekExact(System.Int64)">SeekExact(Int64)</h4> |
| <div class="markdown level1 summary"><p>this enum does not support seeking! </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 SeekExact(long 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.Int64</span></td> |
| <td><span class="parametername">ord</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_SeekExact_System_Int64_">TermsEnum.SeekExact(Int64)</a></div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.NotSupportedException</span></td> |
| <td><p>In general, subclasses do not |
| support seeking. </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum_SetInitialSeekTerm_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum.SetInitialSeekTerm(Lucene.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/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L113">View Source</a> |
| </span> |
| <a id="Lucene_Net_Index_FilteredTermsEnum_SetInitialSeekTerm_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SetInitialSeekTerm*"></a> |
| <h4 id="Lucene_Net_Index_FilteredTermsEnum_SetInitialSeekTerm_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Index.FilteredTermsEnum.SetInitialSeekTerm(Lucene.Net.Util.BytesRef)">SetInitialSeekTerm(BytesRef)</h4> |
| <div class="markdown level1 summary"><p>Use this method to set the initial <a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a> |
| to seek before iterating. This is a convenience method for |
| subclasses that do not override <a class="xref" href="Lucene.Net.Index.FilteredTermsEnum.html#Lucene_Net_Index_FilteredTermsEnum_NextSeekTerm_Lucene_Net_Util_BytesRef_">NextSeekTerm(BytesRef)</a>. |
| If the initial seek term is <code>null</code> (default), |
| the enum is empty. |
| <p>You can only use this method, if you keep the default |
| implementation of <a class="xref" href="Lucene.Net.Index.FilteredTermsEnum.html#Lucene_Net_Index_FilteredTermsEnum_NextSeekTerm_Lucene_Net_Util_BytesRef_">NextSeekTerm(BytesRef)</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected void SetInitialSeekTerm(BytesRef 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.Util.BytesRef.html">BytesRef</a></td> |
| <td><span class="parametername">term</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Util.IBytesRefIterator.html">IBytesRefIterator</a> |
| </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Index_FilteredTermsEnum.md&value=---%0Auid%3A%20Lucene.Net.Index.FilteredTermsEnum%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00011/src/Lucene.Net/Index/FilteredTermsEnum.cs/#L39" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
