| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class RangeFacetsExample |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class RangeFacetsExample |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation "> |
| <meta name="generator" content="docfx 2.50.0.0"> |
| |
| <link rel="shortcut icon" href="../../logo/favicon.ico"> |
| <link rel="stylesheet" href="../../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../../styles/docfx.css"> |
| <link rel="stylesheet" href="../../styles/main.css"> |
| <meta property="docfx:navrel" content="../../toc.html"> |
| <meta property="docfx:tocrel" content="../toc.html"> |
| |
| <meta property="docfx:rel" content="../../"> |
| |
| </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="../../index.html"> |
| <img id="logo" class="svg" src="../../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" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></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.Demo.Facet.RangeFacetsExample"> |
| |
| |
| <h1 id="Lucene_Net_Demo_Facet_RangeFacetsExample" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample" class="text-break">Class RangeFacetsExample |
| </h1> |
| <div class="markdown level0 summary"><p>Shows simple usage of dynamic range faceting.</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"><span class="xref">RangeFacetsExample</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <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.Demo.Facet.html">Lucene.Net.Demo.Facet</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Demo.dll</h6> |
| <h5 id="Lucene_Net_Demo_Facet_RangeFacetsExample_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class RangeFacetsExample : IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Demo_Facet_RangeFacetsExample_examples"><strong>Examples</strong></h5> |
| <pre><code>using Lucene.Net.Analysis.Core; |
| using Lucene.Net.Documents; |
| using Lucene.Net.Facet; |
| using Lucene.Net.Facet.Range; |
| using Lucene.Net.Index; |
| using Lucene.Net.Search; |
| using Lucene.Net.Store; |
| using Lucene.Net.Util; |
| using System; |
| |
| namespace Lucene.Net.Demo.Facet |
| { |
| /// <summary> |
| /// Shows simple usage of dynamic range faceting. |
| /// </summary> |
| public class RangeFacetsExample : IDisposable |
| { |
| /// <summary> |
| /// Using a constant for all functionality related to a specific index |
| /// is the best strategy. This allows you to upgrade Lucene.Net first |
| /// and plan the upgrade of the index binary format for a later time. |
| /// Once the index is upgraded, you simply need to update the constant |
| /// version and redeploy your application. |
| /// </summary> |
| private const LuceneVersion EXAMPLE_VERSION = LuceneVersion.LUCENE_48; |
| |
| private readonly Directory indexDir = new RAMDirectory(); |
| private IndexSearcher searcher; |
| private readonly long nowSec = DateTime.Now.Ticks; |
| |
| internal readonly Int64Range PAST_HOUR; |
| internal readonly Int64Range PAST_SIX_HOURS; |
| internal readonly Int64Range PAST_DAY; |
| |
| /// <summary>Constructor</summary> |
| public RangeFacetsExample() |
| { |
| PAST_HOUR = new Int64Range("Past hour", nowSec - 3600, true, nowSec, true); |
| PAST_SIX_HOURS = new Int64Range("Past six hours", nowSec - 6 * 3600, true, nowSec, true); |
| PAST_DAY = new Int64Range("Past day", nowSec - 24 * 3600, true, nowSec, true); |
| } |
| |
| /// <summary>Build the example index.</summary> |
| public void Index() |
| { |
| using (IndexWriter indexWriter = new IndexWriter(indexDir, new IndexWriterConfig(EXAMPLE_VERSION, |
| new WhitespaceAnalyzer(EXAMPLE_VERSION)))) |
| { |
| // Add documents with a fake timestamp, 1000 sec before |
| // "now", 2000 sec before "now", ...: |
| for (int i = 0; i < 100; i++) |
| { |
| Document doc = new Document(); |
| long then = nowSec - i * 1000; |
| // Add as doc values field, so we can compute range facets: |
| doc.Add(new NumericDocValuesField("timestamp", then)); |
| // Add as numeric field so we can drill-down: |
| doc.Add(new Int64Field("timestamp", then, Field.Store.NO)); |
| indexWriter.AddDocument(doc); |
| } |
| |
| // Open near-real-time searcher |
| searcher = new IndexSearcher(DirectoryReader.Open(indexWriter, true)); |
| |
| } // Disposes indexWriter |
| } |
| |
| private FacetsConfig GetConfig() |
| { |
| return new FacetsConfig(); |
| } |
| |
| /// <summary>User runs a query and counts facets.</summary> |
| public FacetResult Search() |
| { |
| // Aggregates the facet counts |
| FacetsCollector fc = new FacetsCollector(); |
| |
| // MatchAllDocsQuery is for "browsing" (counts facets |
| // for all non-deleted docs in the index); normally |
| // you'd use a "normal" query: |
| FacetsCollector.Search(searcher, new MatchAllDocsQuery(), 10, fc); |
| |
| Facets facets = new Int64RangeFacetCounts("timestamp", fc, |
| PAST_HOUR, |
| PAST_SIX_HOURS, |
| PAST_DAY); |
| return facets.GetTopChildren(10, "timestamp"); |
| } |
| |
| /// <summary>User drills down on the specified range.</summary> |
| public TopDocs DrillDown(Int64Range range) |
| { |
| // Passing no baseQuery means we drill down on all |
| // documents ("browse only"): |
| DrillDownQuery q = new DrillDownQuery(GetConfig()); |
| |
| q.Add("timestamp", NumericRangeQuery.NewInt64Range("timestamp", range.Min, range.Max, range.MinInclusive, range.MaxInclusive)); |
| |
| return searcher.Search(q, 10); |
| } |
| |
| public void Dispose() |
| { |
| searcher?.IndexReader?.Dispose(); |
| indexDir?.Dispose(); |
| } |
| |
| /// <summary>Runs the search and drill-down examples and prints the results.</summary> |
| public static void Main(string[] args) |
| { |
| using (RangeFacetsExample example = new RangeFacetsExample()) |
| { |
| example.Index(); |
| |
| Console.WriteLine("Facet counting example:"); |
| Console.WriteLine("-----------------------"); |
| Console.WriteLine(example.Search()); |
| |
| Console.WriteLine("\n"); |
| Console.WriteLine("Facet drill-down example (timestamp/Past six hours):"); |
| Console.WriteLine("---------------------------------------------"); |
| TopDocs hits = example.DrillDown(example.PAST_SIX_HOURS); |
| Console.WriteLine(hits.TotalHits + " TotalHits"); |
| |
| } // Disposes example |
| } |
| } |
| } |
| </code></pre> |
| <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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Demo_Facet_RangeFacetsExample__ctor.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.RangeFacetsExample.%23ctor%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net.Demo/Facet/RangeFacetsExample.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_RangeFacetsExample__ctor_" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.#ctor*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_RangeFacetsExample__ctor" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.#ctor">RangeFacetsExample()</h4> |
| <div class="markdown level1 summary"><p>Constructor</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public RangeFacetsExample()</code></pre> |
| </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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Demo_Facet_RangeFacetsExample_Dispose.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.RangeFacetsExample.Dispose%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net.Demo/Facet/RangeFacetsExample.cs/#L125">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_RangeFacetsExample_Dispose_" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Dispose*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_RangeFacetsExample_Dispose" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Dispose">Dispose()</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 void Dispose()</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Demo_Facet_RangeFacetsExample_DrillDown_Lucene_Net_Facet_Range_Int64Range_.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.RangeFacetsExample.DrillDown(Lucene.Net.Facet.Range.Int64Range)%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net.Demo/Facet/RangeFacetsExample.cs/#L114">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_RangeFacetsExample_DrillDown_" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.DrillDown*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_RangeFacetsExample_DrillDown_Lucene_Net_Facet_Range_Int64Range_" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.DrillDown(Lucene.Net.Facet.Range.Int64Range)">DrillDown(Int64Range)</h4> |
| <div class="markdown level1 summary"><p>User drills down on the specified range.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public TopDocs DrillDown(Int64Range range)</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/Lucene.Net.Facet.Range.Int64Range.html">Int64Range</a></td> |
| <td><span class="parametername">range</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/Lucene.Net.Search.TopDocs.html">TopDocs</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Demo_Facet_RangeFacetsExample_Index.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.RangeFacetsExample.Index%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net.Demo/Facet/RangeFacetsExample.cs/#L66">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_RangeFacetsExample_Index_" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Index*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_RangeFacetsExample_Index" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Index">Index()</h4> |
| <div class="markdown level1 summary"><p>Build the example index.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Index()</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Demo_Facet_RangeFacetsExample_Main_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.RangeFacetsExample.Main(System.String%5B%5D)%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net.Demo/Facet/RangeFacetsExample.cs/#L132">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_RangeFacetsExample_Main_" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Main*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_RangeFacetsExample_Main_System_String___" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Main(System.String[])">Main(String[])</h4> |
| <div class="markdown level1 summary"><p>Runs the search and drill-down examples and prints the results.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void Main(string[] args)</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.String</span>[]</td> |
| <td><span class="parametername">args</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-beta00008/websites/apidocs/apiSpec/new?filename=Lucene_Net_Demo_Facet_RangeFacetsExample_Search.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.RangeFacetsExample.Search%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/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net.Demo/Facet/RangeFacetsExample.cs/#L96">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_RangeFacetsExample_Search_" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Search*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_RangeFacetsExample_Search" data-uid="Lucene.Net.Demo.Facet.RangeFacetsExample.Search">Search()</h4> |
| <div class="markdown level1 summary"><p>User runs a query and counts facets.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FacetResult Search()</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.Facet/Lucene.Net.Facet.FacetResult.html">FacetResult</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/docs/4.8.0-beta00008/websites/apidocs/apiSpec/Lucene_Net_Demo_Facet_RangeFacetsExample.md/#L2" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/Shazwazza/lucenenet/blob/docs-may/src/Lucene.Net.Demo/Facet/RangeFacetsExample.cs/#L38" 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="../../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../../styles/docfx.js"></script> |
| <script type="text/javascript" src="../../styles/main.js"></script> |
| </body> |
| </html> |
