| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class AssociationsFacetsExample |
| | Apache Lucene.NET 4.8.0-beta00008 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class AssociationsFacetsExample |
| | 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.AssociationsFacetsExample"> |
| |
| |
| <h1 id="Lucene_Net_Demo_Facet_AssociationsFacetsExample" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample" class="text-break">Class AssociationsFacetsExample |
| </h1> |
| <div class="markdown level0 summary"><p>Shows example usage of category associations.</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">AssociationsFacetsExample</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_AssociationsFacetsExample_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class AssociationsFacetsExample</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Demo_Facet_AssociationsFacetsExample_examples"><strong>Examples</strong></h5> |
| <pre><code>using Lucene.Net.Analysis.Core; |
| using Lucene.Net.Documents; |
| using Lucene.Net.Facet; |
| using Lucene.Net.Facet.Taxonomy; |
| using Lucene.Net.Facet.Taxonomy.Directory; |
| using Lucene.Net.Index; |
| using Lucene.Net.Search; |
| using Lucene.Net.Store; |
| using Lucene.Net.Util; |
| using System; |
| using System.Collections.Generic; |
| |
| namespace Lucene.Net.Demo.Facet |
| { |
| /// <summary> |
| /// Shows example usage of category associations. |
| /// </summary> |
| public class AssociationsFacetsExample |
| { |
| /// <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 readonly Directory taxoDir = new RAMDirectory(); |
| private readonly FacetsConfig config; |
| |
| /// <summary>Empty constructor</summary> |
| public AssociationsFacetsExample() |
| { |
| config = new FacetsConfig(); |
| config.SetMultiValued("tags", true); |
| config.SetIndexFieldName("tags", "$tags"); |
| config.SetMultiValued("genre", true); |
| config.SetIndexFieldName("genre", "$genre"); |
| } |
| |
| /// <summary>Build the example index.</summary> |
| private void Index() |
| { |
| IndexWriterConfig iwc = new IndexWriterConfig(EXAMPLE_VERSION, |
| new WhitespaceAnalyzer(EXAMPLE_VERSION)); |
| using (IndexWriter indexWriter = new IndexWriter(indexDir, iwc)) |
| |
| // Writes facet ords to a separate directory from the main index |
| using (DirectoryTaxonomyWriter taxoWriter = new DirectoryTaxonomyWriter(taxoDir)) |
| { |
| |
| Document doc = new Document(); |
| // 3 occurrences for tag 'lucene' |
| |
| doc.AddInt32AssociationFacetField(3, "tags", "lucene"); |
| // 87% confidence level of genre 'computing' |
| doc.AddSingleAssociationFacetField(0.87f, "genre", "computing"); |
| indexWriter.AddDocument(config.Build(taxoWriter, doc)); |
| |
| doc = new Document(); |
| // 1 occurrence for tag 'lucene' |
| doc.AddInt32AssociationFacetField(1, "tags", "lucene"); |
| // 2 occurrence for tag 'solr' |
| doc.AddInt32AssociationFacetField(2, "tags", "solr"); |
| // 75% confidence level of genre 'computing' |
| doc.AddSingleAssociationFacetField(0.75f, "genre", "computing"); |
| // 34% confidence level of genre 'software' |
| doc.AddSingleAssociationFacetField(0.34f, "genre", "software"); |
| indexWriter.AddDocument(config.Build(taxoWriter, doc)); |
| |
| } // Disposes indexWriter and taxoWriter |
| } |
| |
| /// <summary>User runs a query and aggregates facets by summing their association values.</summary> |
| private IList<FacetResult> SumAssociations() |
| { |
| using (DirectoryReader indexReader = DirectoryReader.Open(indexDir)) |
| using (TaxonomyReader taxoReader = new DirectoryTaxonomyReader(taxoDir)) |
| { |
| IndexSearcher searcher = new IndexSearcher(indexReader); |
| |
| 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 tags = new TaxonomyFacetSumInt32Associations("$tags", taxoReader, config, fc); |
| Facets genre = new TaxonomyFacetSumSingleAssociations("$genre", taxoReader, config, fc); |
| |
| // Retrieve results |
| IList<FacetResult> results = new List<FacetResult>(); |
| |
| results.Add(tags.GetTopChildren(10, "tags")); |
| results.Add(genre.GetTopChildren(10, "genre")); |
| |
| return results; |
| |
| } // Disposes indexReader and taxoReader |
| } |
| |
| /// <summary>User drills down on 'tags/solr'.</summary> |
| private FacetResult DrillDown() |
| { |
| using (DirectoryReader indexReader = DirectoryReader.Open(indexDir)) |
| using (TaxonomyReader taxoReader = new DirectoryTaxonomyReader(taxoDir)) |
| { |
| IndexSearcher searcher = new IndexSearcher(indexReader); |
| |
| // Passing no baseQuery means we drill down on all |
| // documents ("browse only"): |
| DrillDownQuery q = new DrillDownQuery(config); |
| |
| // Now user drills down on Publish Date/2010: |
| q.Add("tags", "solr"); |
| FacetsCollector fc = new FacetsCollector(); |
| FacetsCollector.Search(searcher, q, 10, fc); |
| |
| // Retrieve results |
| Facets facets = new TaxonomyFacetSumSingleAssociations("$genre", taxoReader, config, fc); |
| FacetResult result = facets.GetTopChildren(10, "genre"); |
| |
| return result; |
| |
| } // Disposes indexReader and taxoReader |
| } |
| |
| /// <summary>Runs summing association example.</summary> |
| public IList<FacetResult> RunSumAssociations() |
| { |
| Index(); |
| return SumAssociations(); |
| } |
| |
| /// <summary>Runs the drill-down example.</summary> |
| public FacetResult RunDrillDown() |
| { |
| Index(); |
| return DrillDown(); |
| } |
| |
| /// <summary>Runs the sum int/float associations examples and prints the results.</summary> |
| public static void Main(string[] args) |
| { |
| Console.WriteLine("Sum associations example:"); |
| Console.WriteLine("-------------------------"); |
| IList<FacetResult> results = new AssociationsFacetsExample().RunSumAssociations(); |
| Console.WriteLine("tags: " + results[0]); |
| Console.WriteLine("genre: " + results[1]); |
| } |
| } |
| } |
| </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_AssociationsFacetsExample__ctor.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.AssociationsFacetsExample.%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/AssociationsFacetsExample.cs/#L56">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_AssociationsFacetsExample__ctor_" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.#ctor*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_AssociationsFacetsExample__ctor" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.#ctor">AssociationsFacetsExample()</h4> |
| <div class="markdown level1 summary"><p>Empty constructor</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public AssociationsFacetsExample()</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_AssociationsFacetsExample_Main_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.AssociationsFacetsExample.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/AssociationsFacetsExample.cs/#L168">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_AssociationsFacetsExample_Main_" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.Main*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_AssociationsFacetsExample_Main_System_String___" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.Main(System.String[])">Main(String[])</h4> |
| <div class="markdown level1 summary"><p>Runs the sum int/float associations 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_AssociationsFacetsExample_RunDrillDown.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.AssociationsFacetsExample.RunDrillDown%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/AssociationsFacetsExample.cs/#L161">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_AssociationsFacetsExample_RunDrillDown_" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.RunDrillDown*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_AssociationsFacetsExample_RunDrillDown" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.RunDrillDown">RunDrillDown()</h4> |
| <div class="markdown level1 summary"><p>Runs the drill-down example.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FacetResult RunDrillDown()</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> |
| <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_AssociationsFacetsExample_RunSumAssociations.md&value=---%0Auid%3A%20Lucene.Net.Demo.Facet.AssociationsFacetsExample.RunSumAssociations%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/AssociationsFacetsExample.cs/#L154">View Source</a> |
| </span> |
| <a id="Lucene_Net_Demo_Facet_AssociationsFacetsExample_RunSumAssociations_" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.RunSumAssociations*"></a> |
| <h4 id="Lucene_Net_Demo_Facet_AssociationsFacetsExample_RunSumAssociations" data-uid="Lucene.Net.Demo.Facet.AssociationsFacetsExample.RunSumAssociations">RunSumAssociations()</h4> |
| <div class="markdown level1 summary"><p>Runs summing association example.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IList<FacetResult> RunSumAssociations()</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.Collections.Generic.IList</span><<a class="xref" href="../Lucene.Net.Facet/Lucene.Net.Facet.FacetResult.html">FacetResult</a>></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/blob/docs/4.8.0-beta00008/websites/apidocs/apiSpec/Lucene_Net_Demo_Facet_AssociationsFacetsExample.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/AssociationsFacetsExample.cs/#L40" 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> |
