| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface ITaxonomyWriterCache |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface ITaxonomyWriterCache |
| | 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.WriterCache.ITaxonomyWriterCache"> |
| |
| |
| <h1 id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache" class="text-break">Interface ITaxonomyWriterCache |
| </h1> |
| <div class="markdown level0 summary"><p><a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html">ITaxonomyWriterCache</a> is a relatively simple interface for a cache of |
| category->ordinal mappings, used in ITaxonomyWriter implementations (such as |
| <a class="xref" href="Lucene.Net.Facet.Taxonomy.Directory.DirectoryTaxonomyWriter.html">DirectoryTaxonomyWriter</a>). |
| <p> |
| It basically has <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html#Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Put_Lucene_Net_Facet_Taxonomy_FacetLabel_System_Int32_">Put(FacetLabel, Int32)</a> methods for adding a mapping, and <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html#Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Get_Lucene_Net_Facet_Taxonomy_FacetLabel_">Get(FacetLabel)</a> for looking a |
| mapping up the cache. The cache does <strong>not</strong> guarantee to hold everything |
| that has been put into it, and might in fact selectively delete some of the |
| mappings (e.g., the ones least recently used). This means that if <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html#Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Get_Lucene_Net_Facet_Taxonomy_FacetLabel_">Get(FacetLabel)</a> |
| returns a negative response, it does not necessarily mean that the category |
| doesn't exist - just that it is not in the cache. The caller can only infer |
| that the category doesn't exist if it knows the cache to be complete (because |
| all the categories were loaded into the cache, and since then no <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html#Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Put_Lucene_Net_Facet_Taxonomy_FacetLabel_System_Int32_">Put(FacetLabel, Int32)</a> |
| returned true). |
| </p> |
| <p> |
| However, if it does so, it should clear out large parts of the cache at once, |
| because the user will typically need to work hard to recover from every cache |
| cleanup (see <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html#Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Put_Lucene_Net_Facet_Taxonomy_FacetLabel_System_Int32_">Put(FacetLabel, Int32)</a>'s return value). |
| </p> |
| <p> |
| <strong>NOTE:</strong> the cache may be accessed concurrently by multiple threads, |
| therefore cache implementations should take this into consideration.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div><p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.IDisposable.Dispose()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.html">Lucene.Net.Facet.Taxonomy.WriterCache</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Facet.dll</h6> |
| <h5 id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface ITaxonomyWriterCache : IDisposable</code></pre> |
| </div> |
| <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_WriterCache_ITaxonomyWriterCache_IsFull.md&value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.IsFull%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/WriterCache/TaxonomyWriterCache.cs/#L92">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_IsFull_" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.IsFull*"></a> |
| <h4 id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_IsFull" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.IsFull">IsFull</h4> |
| <div class="markdown level1 summary"><p>Returns true if the cache is full, such that the next <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html#Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Put_Lucene_Net_Facet_Taxonomy_FacetLabel_System_Int32_">Put(FacetLabel, Int32)</a> will |
| evict entries from it, false otherwise.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">bool IsFull { 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.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Clear.md&value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/Taxonomy/WriterCache/TaxonomyWriterCache.cs/#L98">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Clear_" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Clear*"></a> |
| <h4 id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Clear" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Clear">Clear()</h4> |
| <div class="markdown level1 summary"><p>Clears the content of the cache. Unlike <span class="xref">System.IDisposable.Dispose()</span>, the caller can |
| assume that the cache is still operable after this method returns.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Get_Lucene_Net_Facet_Taxonomy_FacetLabel_.md&value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Get(Lucene.Net.Facet.Taxonomy.FacetLabel)%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/WriterCache/TaxonomyWriterCache.cs/#L63">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Get_" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Get*"></a> |
| <h4 id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Get_Lucene_Net_Facet_Taxonomy_FacetLabel_" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Get(Lucene.Net.Facet.Taxonomy.FacetLabel)">Get(FacetLabel)</h4> |
| <div class="markdown level1 summary"><p>Lookup a category in the cache, returning its ordinal, or a negative |
| number if the category is not in the cache. |
| <p> |
| It is up to the caller to remember what a negative response means: |
| If the caller knows the cache is <em>complete</em> (it was initially |
| fed with all the categories, and since then <a class="xref" href="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.html#Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Put_Lucene_Net_Facet_Taxonomy_FacetLabel_System_Int32_">Put(FacetLabel, Int32)</a> never returned true) |
| it means the category does not exist. Otherwise, the category might |
| still exist, but just be missing from the cache. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">int Get(FacetLabel categoryPath)</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.FacetLabel.html">FacetLabel</a></td> |
| <td><span class="parametername">categoryPath</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_WriterCache_ITaxonomyWriterCache_Put_Lucene_Net_Facet_Taxonomy_FacetLabel_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Put(Lucene.Net.Facet.Taxonomy.FacetLabel%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/Taxonomy/WriterCache/TaxonomyWriterCache.cs/#L86">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Put_" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Put*"></a> |
| <h4 id="Lucene_Net_Facet_Taxonomy_WriterCache_ITaxonomyWriterCache_Put_Lucene_Net_Facet_Taxonomy_FacetLabel_System_Int32_" data-uid="Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache.Put(Lucene.Net.Facet.Taxonomy.FacetLabel,System.Int32)">Put(FacetLabel, Int32)</h4> |
| <div class="markdown level1 summary"><p>Add a category to the cache, with the given ordinal as the value. |
| <p> |
| If the implementation keeps only a partial cache (e.g., an LRU cache) |
| and finds that its cache is full, it should clear up part of the cache |
| and return <code>true</code>. Otherwise, it should return |
| <code>false</code>. |
| </p> |
| <p> |
| The reason why the caller needs to know if part of the cache was |
| cleared is that in that case it will have to commit its on-disk index |
| (so that all the latest category additions can be searched on disk, if |
| we can't rely on the cache to contain them). |
| </p> |
| <p> |
| Ordinals should be non-negative. Currently there is no defined way to |
| specify that a cache should remember a category does NOT exist. |
| It doesn't really matter, because normally the next thing we do after |
| finding that a category does not exist is to add it. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">bool Put(FacetLabel categoryPath, int ordinal)</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.FacetLabel.html">FacetLabel</a></td> |
| <td><span class="parametername">categoryPath</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">ordinal</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> |
| </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_WriterCache_ITaxonomyWriterCache.md&value=---%0Auid%3A%20Lucene.Net.Facet.Taxonomy.WriterCache.ITaxonomyWriterCache%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/WriterCache/TaxonomyWriterCache.cs/#L50" 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> |
