Google Git
Sign in
apache / lucenenet-site / 5ff971ba7cc570e29ca8a7f21ffcd5b2651be54b / . / docs / 4.8.0-beta00010 / api / facet / Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.html
blob: cdea23638b5c6ec6779b8f0e3690a253b70fce15 [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 CachedOrdinalsReader
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CachedOrdinalsReader
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="facet/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.Facet.Taxonomy.CachedOrdinalsReader">
<h1 id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader" class="text-break">Class CachedOrdinalsReader
</h1>
<div class="markdown level0 summary"><p>A per-segment cache of documents&apos; facet ordinals. Every
<a class="xref" href="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.CachedOrds.html">CachedOrdinalsReader.CachedOrds</a> holds the ordinals in a raw <span class="xref">int[]</span>,
and therefore consumes as much RAM as the total
number of ordinals found in the segment, but saves the
CPU cost of decoding ordinals during facet counting.</p>
<p>
<strong>NOTE:</strong> every <a class="xref" href="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.CachedOrds.html">CachedOrdinalsReader.CachedOrds</a> is limited to 2.1B
total ordinals. If that is a limitation for you then
consider limiting the segment size to fewer documents, or
use an alternative cache which pages through the category
ordinals.
</p>
<p>
<strong>NOTE:</strong> when using this cache, it is advised to use
a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Codecs.DocValuesFormat.html">DocValuesFormat</a> that does not cache the data in
memory, at least for the category lists fields, or
otherwise you&apos;ll be doing double-caching.
</p>
<p>
<strong>NOTE:</strong> create one instance of this and re-use it
for all facet implementations (the cache is per-instance,
not static).
</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.Facet.Taxonomy.OrdinalsReader.html">OrdinalsReader</a></div>
<div class="level2"><span class="xref">CachedOrdinalsReader</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">Lucene.Net.Util.IAccountable</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.Facet.Taxonomy.html">Lucene.Net.Facet.Taxonomy</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Facet.dll</h6>
<h5 id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class CachedOrdinalsReader : OrdinalsReader, IAccountable</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader__ctor_Lucene_Net_Facet_Taxonomy_OrdinalsReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.%23ctor(Lucene.Net.Facet.Taxonomy.OrdinalsReader)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/Taxonomy/CachedOrdinalsReader.cs/#L74">View Source</a>
</span>
<a id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader__ctor_" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.#ctor*"></a>
<h4 id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader__ctor_Lucene_Net_Facet_Taxonomy_OrdinalsReader_" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.#ctor(Lucene.Net.Facet.Taxonomy.OrdinalsReader)">CachedOrdinalsReader(OrdinalsReader)</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 CachedOrdinalsReader(OrdinalsReader source)</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.Facet.Taxonomy.OrdinalsReader.html">OrdinalsReader</a></td>
<td><span class="parametername">source</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_IndexFieldName.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.IndexFieldName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/Taxonomy/CachedOrdinalsReader.cs/#L98">View Source</a>
</span>
<a id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_IndexFieldName_" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.IndexFieldName*"></a>
<h4 id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_IndexFieldName" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.IndexFieldName">IndexFieldName</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 string IndexFieldName { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Facet.Taxonomy.OrdinalsReader.html#Lucene_Net_Facet_Taxonomy_OrdinalsReader_IndexFieldName">OrdinalsReader.IndexFieldName</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_GetReader_Lucene_Net_Index_AtomicReaderContext_.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.GetReader(Lucene.Net.Index.AtomicReaderContext)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/Taxonomy/CachedOrdinalsReader.cs/#L100">View Source</a>
</span>
<a id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_GetReader_" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.GetReader*"></a>
<h4 id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_GetReader_Lucene_Net_Index_AtomicReaderContext_" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.GetReader(Lucene.Net.Index.AtomicReaderContext)">GetReader(AtomicReaderContext)</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 OrdinalsReader.OrdinalsSegmentReader GetReader(AtomicReaderContext 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><span class="xref">Lucene.Net.Index.AtomicReaderContext</span></td>
<td><span class="parametername">context</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.Facet.Taxonomy.OrdinalsReader.OrdinalsSegmentReader.html">OrdinalsReader.OrdinalsSegmentReader</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Facet.Taxonomy.OrdinalsReader.html#Lucene_Net_Facet_Taxonomy_OrdinalsReader_GetReader_Lucene_Net_Index_AtomicReaderContext_">OrdinalsReader.GetReader(AtomicReaderContext)</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_RamBytesUsed.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.RamBytesUsed%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/Taxonomy/CachedOrdinalsReader.cs/#L198">View Source</a>
</span>
<a id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_RamBytesUsed_" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.RamBytesUsed*"></a>
<h4 id="Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader_RamBytesUsed" data-uid="Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader.RamBytesUsed">RamBytesUsed()</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 virtual long RamBytesUsed()</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><span class="xref">System.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">Lucene.Net.Util.IAccountable</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_Taxonomy_CachedOrdinalsReader.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.CachedOrdinalsReader%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/Taxonomy/CachedOrdinalsReader.cs/#L62" 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>