| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class FacetsConfig |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class FacetsConfig |
| | 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.FacetsConfig"> |
| |
| |
| <h1 id="Lucene_Net_Facet_FacetsConfig" data-uid="Lucene.Net.Facet.FacetsConfig" class="text-break">Class FacetsConfig |
| </h1> |
| <div class="markdown level0 summary"><p>Records per-dimension configuration. By default a |
| dimension is flat, single valued and does |
| not require count for the dimension; use |
| the setters in this class to change these settings for |
| each dim.</p> |
| <p> |
| <strong>NOTE</strong>: this configuration is not saved into the |
| index, but it's vital, and up to the application to |
| ensure, that at search time the provided <a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a> |
| matches what was used during indexing. |
| |
| @lucene.experimental |
| </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">FacetsConfig</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="package.html">Lucene.Net.Facet</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Facet.dll</h6> |
| <h5 id="Lucene_Net_Facet_FacetsConfig_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class FacetsConfig</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_FacetsConfig__ctor.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/FacetsConfig.cs/#L119">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig__ctor_" data-uid="Lucene.Net.Facet.FacetsConfig.#ctor*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig__ctor" data-uid="Lucene.Net.Facet.FacetsConfig.#ctor">FacetsConfig()</h4> |
| <div class="markdown level1 summary"><p>Default constructor.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public FacetsConfig()</code></pre> |
| </div> |
| <h3 id="fields">Fields |
| </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_FacetsConfig_DEFAULT_DIM_CONFIG.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.DEFAULT_DIM_CONFIG%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/FacetsConfig.cs/#L114">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_DEFAULT_DIM_CONFIG" data-uid="Lucene.Net.Facet.FacetsConfig.DEFAULT_DIM_CONFIG">DEFAULT_DIM_CONFIG</h4> |
| <div class="markdown level1 summary"><p>Default per-dimension configuration. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly FacetsConfig.DimConfig DEFAULT_DIM_CONFIG</code></pre> |
| </div> |
| <h5 class="fieldValue">Field 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.Facet.FacetsConfig.DimConfig.html">FacetsConfig.DimConfig</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_FacetsConfig_DEFAULT_INDEX_FIELD_NAME.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.DEFAULT_INDEX_FIELD_NAME%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/FacetsConfig.cs/#L68">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_DEFAULT_INDEX_FIELD_NAME" data-uid="Lucene.Net.Facet.FacetsConfig.DEFAULT_INDEX_FIELD_NAME">DEFAULT_INDEX_FIELD_NAME</h4> |
| <div class="markdown level1 summary"><p>Which Lucene field holds the drill-downs and ords (as |
| doc values). </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const string DEFAULT_INDEX_FIELD_NAME = "$facets"</code></pre> |
| </div> |
| <h5 class="fieldValue">Field 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> |
| <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_FacetsConfig_DefaultDimConfig.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.DefaultDimConfig%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/FacetsConfig.cs/#L132">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_DefaultDimConfig_" data-uid="Lucene.Net.Facet.FacetsConfig.DefaultDimConfig*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_DefaultDimConfig" data-uid="Lucene.Net.Facet.FacetsConfig.DefaultDimConfig">DefaultDimConfig</h4> |
| <div class="markdown level1 summary"><p>Get the default configuration for new dimensions. Useful when |
| the dimension is not known beforehand and may need different |
| global default settings, like <code>multivalue = true</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual FacetsConfig.DimConfig DefaultDimConfig { 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.Facet.FacetsConfig.DimConfig.html">FacetsConfig.DimConfig</a></td> |
| <td><p>The default configuration to be used for dimensions that |
| are not yet set in the <a class="xref" href="Lucene.Net.Facet.FacetsConfig.html">FacetsConfig</a></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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_FacetsConfig_DimConfigs.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.DimConfigs%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/FacetsConfig.cs/#L235">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_DimConfigs_" data-uid="Lucene.Net.Facet.FacetsConfig.DimConfigs*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_DimConfigs" data-uid="Lucene.Net.Facet.FacetsConfig.DimConfigs">DimConfigs</h4> |
| <div class="markdown level1 summary"><p>Returns map of field name to <a class="xref" href="Lucene.Net.Facet.FacetsConfig.DimConfig.html">FacetsConfig.DimConfig</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IDictionary<string, FacetsConfig.DimConfig> DimConfigs { 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.IDictionary</span><<span class="xref">System.String</span>, <a class="xref" href="Lucene.Net.Facet.FacetsConfig.DimConfig.html">FacetsConfig.DimConfig</a>></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_FacetsConfig_Build_Lucene_Net_Documents_Document_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.Build(Lucene.Net.Documents.Document)%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/FacetsConfig.cs/#L256">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_Build_" data-uid="Lucene.Net.Facet.FacetsConfig.Build*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_Build_Lucene_Net_Documents_Document_" data-uid="Lucene.Net.Facet.FacetsConfig.Build(Lucene.Net.Documents.Document)">Build(Document)</h4> |
| <div class="markdown level1 summary"><p>Translates any added <a class="xref" href="Lucene.Net.Facet.FacetField.html">FacetField</a>s into normal fields for indexing; |
| only use this version if you did not add any taxonomy-based fields |
| (<a class="xref" href="Lucene.Net.Facet.FacetField.html">FacetField</a> or <a class="xref" href="Lucene.Net.Facet.Taxonomy.AssociationFacetField.html">AssociationFacetField</a>).</p> |
| <p> |
| <strong>NOTE:</strong> you should add the returned document to <span class="xref">Lucene.Net.Index.IndexWriter</span>, not the |
| input one! |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Document Build(Document doc)</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.Documents.Document</span></td> |
| <td><span class="parametername">doc</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">Lucene.Net.Documents.Document</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_FacetsConfig_Build_Lucene_Net_Facet_Taxonomy_ITaxonomyWriter_Lucene_Net_Documents_Document_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.Build(Lucene.Net.Facet.Taxonomy.ITaxonomyWriter%2CLucene.Net.Documents.Document)%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/FacetsConfig.cs/#L269">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_Build_" data-uid="Lucene.Net.Facet.FacetsConfig.Build*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_Build_Lucene_Net_Facet_Taxonomy_ITaxonomyWriter_Lucene_Net_Documents_Document_" data-uid="Lucene.Net.Facet.FacetsConfig.Build(Lucene.Net.Facet.Taxonomy.ITaxonomyWriter,Lucene.Net.Documents.Document)">Build(ITaxonomyWriter, Document)</h4> |
| <div class="markdown level1 summary"><p>Translates any added <a class="xref" href="Lucene.Net.Facet.FacetField.html">FacetField</a>s into normal fields for indexing.</p> |
| <p> |
| <strong>NOTE:</strong> you should add the returned document to <span class="xref">Lucene.Net.Index.IndexWriter</span>, not the |
| input one! |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Document Build(ITaxonomyWriter taxoWriter, Document doc)</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.ITaxonomyWriter.html">ITaxonomyWriter</a></td> |
| <td><span class="parametername">taxoWriter</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Documents.Document</span></td> |
| <td><span class="parametername">doc</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">Lucene.Net.Documents.Document</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_FacetsConfig_DedupAndEncode_Lucene_Net_Util_Int32sRef_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.DedupAndEncode(Lucene.Net.Util.Int32sRef)%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/FacetsConfig.cs/#L528">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_DedupAndEncode_" data-uid="Lucene.Net.Facet.FacetsConfig.DedupAndEncode*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_DedupAndEncode_Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Facet.FacetsConfig.DedupAndEncode(Lucene.Net.Util.Int32sRef)">DedupAndEncode(Int32sRef)</h4> |
| <div class="markdown level1 summary"><p>Encodes ordinals into a <span class="xref">Lucene.Net.Util.BytesRef</span>; expert: subclass can |
| override this to change encoding. </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 DedupAndEncode(Int32sRef ordinals)</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.Util.Int32sRef</span></td> |
| <td><span class="parametername">ordinals</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">Lucene.Net.Util.BytesRef</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_FacetsConfig_GetDimConfig_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.GetDimConfig(System.String)%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/FacetsConfig.cs/#L137">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_GetDimConfig_" data-uid="Lucene.Net.Facet.FacetsConfig.GetDimConfig*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_GetDimConfig_System_String_" data-uid="Lucene.Net.Facet.FacetsConfig.GetDimConfig(System.String)">GetDimConfig(String)</h4> |
| <div class="markdown level1 summary"><p>Get the current configuration for a dimension.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual FacetsConfig.DimConfig GetDimConfig(string dimName)</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">dimName</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.FacetsConfig.DimConfig.html">FacetsConfig.DimConfig</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_FacetsConfig_PathToString_System_String_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.PathToString(System.String%2CSystem.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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/FacetsConfig.cs/#L616">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_PathToString_" data-uid="Lucene.Net.Facet.FacetsConfig.PathToString*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_PathToString_System_String_System_String___" data-uid="Lucene.Net.Facet.FacetsConfig.PathToString(System.String,System.String[])">PathToString(String, String[])</h4> |
| <div class="markdown level1 summary"><p>Turns a dim + path into an encoded string.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static string PathToString(string dim, string[] path)</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">dim</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">path</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.String</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_FacetsConfig_PathToString_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.PathToString(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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Facet/FacetsConfig.cs/#L627">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_PathToString_" data-uid="Lucene.Net.Facet.FacetsConfig.PathToString*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_PathToString_System_String___" data-uid="Lucene.Net.Facet.FacetsConfig.PathToString(System.String[])">PathToString(String[])</h4> |
| <div class="markdown level1 summary"><p>Turns a dim + path into an encoded string.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static string PathToString(string[] path)</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">path</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.String</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_FacetsConfig_PathToString_System_String___System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.PathToString(System.String%5B%5D%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/FacetsConfig.cs/#L636">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_PathToString_" data-uid="Lucene.Net.Facet.FacetsConfig.PathToString*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_PathToString_System_String___System_Int32_" data-uid="Lucene.Net.Facet.FacetsConfig.PathToString(System.String[],System.Int32)">PathToString(String[], Int32)</h4> |
| <div class="markdown level1 summary"><p>Turns the first <code data-dev-comment-type="paramref" class="paramref">length</code> elements of <code data-dev-comment-type="paramref" class="paramref">path</code> |
| into an encoded string. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static string PathToString(string[] path, int length)</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">path</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">length</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.String</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_FacetsConfig_ProcessSSDVFacetFields_System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetField___Lucene_Net_Documents_Document_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.ProcessSSDVFacetFields(System.Collections.Generic.IDictionary%7BSystem.String%2CSystem.Collections.Generic.IList%7BLucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField%7D%7D%2CLucene.Net.Documents.Document)%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/FacetsConfig.cs/#L460">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_ProcessSSDVFacetFields_" data-uid="Lucene.Net.Facet.FacetsConfig.ProcessSSDVFacetFields*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_ProcessSSDVFacetFields_System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_Lucene_Net_Facet_SortedSet_SortedSetDocValuesFacetField___Lucene_Net_Documents_Document_" data-uid="Lucene.Net.Facet.FacetsConfig.ProcessSSDVFacetFields(System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IList{Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField}},Lucene.Net.Documents.Document)">ProcessSSDVFacetFields(IDictionary<String, IList<SortedSetDocValuesFacetField>>, Document)</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 ProcessSSDVFacetFields(IDictionary<string, IList<SortedSetDocValuesFacetField>> byField, Document doc)</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Facet.SortedSet.SortedSetDocValuesFacetField.html">SortedSetDocValuesFacetField</a>>></td> |
| <td><span class="parametername">byField</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Documents.Document</span></td> |
| <td><span class="parametername">doc</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_FacetsConfig_SetHierarchical_System_String_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.SetHierarchical(System.String%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_beta00010/src/Lucene.Net.Facet/FacetsConfig.cs/#L154">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_SetHierarchical_" data-uid="Lucene.Net.Facet.FacetsConfig.SetHierarchical*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_SetHierarchical_System_String_System_Boolean_" data-uid="Lucene.Net.Facet.FacetsConfig.SetHierarchical(System.String,System.Boolean)">SetHierarchical(String, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Pass <code>true</code> if this dimension is hierarchical |
| (has depth > 1 paths). </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetHierarchical(string dimName, bool v)</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">dimName</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">v</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_FacetsConfig_SetIndexFieldName_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.SetIndexFieldName(System.String%2CSystem.String)%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/FacetsConfig.cs/#L216">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_SetIndexFieldName_" data-uid="Lucene.Net.Facet.FacetsConfig.SetIndexFieldName*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_SetIndexFieldName_System_String_System_String_" data-uid="Lucene.Net.Facet.FacetsConfig.SetIndexFieldName(System.String,System.String)">SetIndexFieldName(String, String)</h4> |
| <div class="markdown level1 summary"><p>Specify which index field name should hold the |
| ordinals for this dimension; this is only used by the |
| taxonomy based facet methods. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetIndexFieldName(string dimName, string indexFieldName)</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">dimName</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">indexFieldName</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_FacetsConfig_SetMultiValued_System_String_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.SetMultiValued(System.String%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_beta00010/src/Lucene.Net.Facet/FacetsConfig.cs/#L174">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_SetMultiValued_" data-uid="Lucene.Net.Facet.FacetsConfig.SetMultiValued*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_SetMultiValued_System_String_System_Boolean_" data-uid="Lucene.Net.Facet.FacetsConfig.SetMultiValued(System.String,System.Boolean)">SetMultiValued(String, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Pass <code>true</code> if this dimension may have more than |
| one value per document. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetMultiValued(string dimName, bool v)</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">dimName</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">v</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_FacetsConfig_SetRequireDimCount_System_String_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.SetRequireDimCount(System.String%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_beta00010/src/Lucene.Net.Facet/FacetsConfig.cs/#L195">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_SetRequireDimCount_" data-uid="Lucene.Net.Facet.FacetsConfig.SetRequireDimCount*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_SetRequireDimCount_System_String_System_Boolean_" data-uid="Lucene.Net.Facet.FacetsConfig.SetRequireDimCount(System.String,System.Boolean)">SetRequireDimCount(String, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Pass <code>true</code> if at search time you require |
| accurate counts of the dimension, i.e. how many |
| hits have this dimension. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void SetRequireDimCount(string dimName, bool v)</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">dimName</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">v</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_FacetsConfig_StringToPath_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig.StringToPath(System.String)%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/FacetsConfig.cs/#L672">View Source</a> |
| </span> |
| <a id="Lucene_Net_Facet_FacetsConfig_StringToPath_" data-uid="Lucene.Net.Facet.FacetsConfig.StringToPath*"></a> |
| <h4 id="Lucene_Net_Facet_FacetsConfig_StringToPath_System_String_" data-uid="Lucene.Net.Facet.FacetsConfig.StringToPath(System.String)">StringToPath(String)</h4> |
| <div class="markdown level1 summary"><p>Turns an encoded string (from a previous call to <a class="xref" href="Lucene.Net.Facet.FacetsConfig.html#Lucene_Net_Facet_FacetsConfig_PathToString_System_String___">PathToString(String[])</a>) |
| back into the original <span class="xref">string[]</span>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static string[] StringToPath(string s)</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">s</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.String</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_FacetsConfig.md&value=---%0Auid%3A%20Lucene.Net.Facet.FacetsConfig%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/FacetsConfig.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> |
