blob: 17a1f2dd07eb0762ef3e44a6546b1be140e5c3cf [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class FacetField
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class FacetField
| 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.FacetField">
<h1 id="Lucene_Net_Facet_FacetField" data-uid="Lucene.Net.Facet.FacetField" class="text-break">Class FacetField
</h1>
<div class="markdown level0 summary"><p>Add an instance of this to your <span class="xref">Lucene.Net.Documents.Document</span> for every facet label.</p>
<p>
<strong>NOTE:</strong> you must call <a class="xref" href="Lucene.Net.Facet.FacetsConfig.html#Lucene_Net_Facet_FacetsConfig_Build_Lucene_Net_Documents_Document_">Build(Document)</a> before
you add the document to <span class="xref">Lucene.Net.Index.IndexWriter</span>.
</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">Lucene.Net.Documents.Field</span></div>
<div class="level2"><span class="xref">FacetField</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">Lucene.Net.Index.IIndexableField</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">Lucene.Net.Documents.Field.m_type</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.m_name</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.FieldsData</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.m_tokenStream</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.m_boost</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetStringValue()</span>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_GetStringValue_System_IFormatProvider_">Field.GetStringValue(IFormatProvider)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_GetStringValue_System_String_">Field.GetStringValue(String)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_GetStringValue_System_String_System_IFormatProvider_">Field.GetStringValue(String, IFormatProvider)</a>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetReaderValue()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetTokenStreamValue()</span>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetStringValue_System_String_">Field.SetStringValue(String)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetReaderValue_System_IO_TextReader_">Field.SetReaderValue(TextReader)</a>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.SetBytesValue(Lucene.Net.Util.BytesRef)</span>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetBytesValue_System_Byte___">Field.SetBytesValue(Byte[])</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetByteValue_System_Byte_">Field.SetByteValue(Byte)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetInt16Value_System_Int16_">Field.SetInt16Value(Int16)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetInt32Value_System_Int32_">Field.SetInt32Value(Int32)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetInt64Value_System_Int64_">Field.SetInt64Value(Int64)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetSingleValue_System_Single_">Field.SetSingleValue(Single)</a>
</div>
<div>
<a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Documents.Field.html#Lucene_Net_Documents_Field_SetDoubleValue_System_Double_">Field.SetDoubleValue(Double)</a>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.SetTokenStream(Lucene.Net.Analysis.TokenStream)</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.Name</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.Boost</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetNumericValue()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.NumericType</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetByteValue()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetInt16Value()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetInt32Value()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetInt64Value()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetSingleValue()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetDoubleValue()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetBinaryValue()</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.FieldType</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.IndexableFieldType</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.GetTokenStream(Lucene.Net.Analysis.Analyzer)</span>
</div>
<div>
<span class="xref">Lucene.Net.Documents.Field.TranslateFieldType(Lucene.Net.Documents.Field.Store, Lucene.Net.Documents.Field.Index, Lucene.Net.Documents.Field.TermVector)</span>
</div>
<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>
<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_FacetField_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class FacetField : Field, IIndexableField</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_FacetField__ctor_System_String_System_String___.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.FacetField.%23ctor(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/FacetField.cs/#L65">View Source</a>
</span>
<a id="Lucene_Net_Facet_FacetField__ctor_" data-uid="Lucene.Net.Facet.FacetField.#ctor*"></a>
<h4 id="Lucene_Net_Facet_FacetField__ctor_System_String_System_String___" data-uid="Lucene.Net.Facet.FacetField.#ctor(System.String,System.String[])">FacetField(String, String[])</h4>
<div class="markdown level1 summary"><p>Creates the this from <code data-dev-comment-type="paramref" class="paramref">dim</code> and
<code data-dev-comment-type="paramref" class="paramref">path</code>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public FacetField(string dim, params 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>
<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_FacetField_Dim.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.FacetField.Dim%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/FacetField.cs/#L52">View Source</a>
</span>
<a id="Lucene_Net_Facet_FacetField_Dim_" data-uid="Lucene.Net.Facet.FacetField.Dim*"></a>
<h4 id="Lucene_Net_Facet_FacetField_Dim" data-uid="Lucene.Net.Facet.FacetField.Dim">Dim</h4>
<div class="markdown level1 summary"><p>Dimension for this field.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Dim { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<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_FacetField_Path.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.FacetField.Path%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/FacetField.cs/#L57">View Source</a>
</span>
<a id="Lucene_Net_Facet_FacetField_Path_" data-uid="Lucene.Net.Facet.FacetField.Path*"></a>
<h4 id="Lucene_Net_Facet_FacetField_Path" data-uid="Lucene.Net.Facet.FacetField.Path">Path</h4>
<div class="markdown level1 summary"><p>Path for this field.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string[] Path { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td></td>
</tr>
</tbody>
</table>
<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_FacetField_ToString.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.FacetField.ToString%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/FacetField.cs/#L81">View Source</a>
</span>
<a id="Lucene_Net_Facet_FacetField_ToString_" data-uid="Lucene.Net.Facet.FacetField.ToString*"></a>
<h4 id="Lucene_Net_Facet_FacetField_ToString" data-uid="Lucene.Net.Facet.FacetField.ToString">ToString()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</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.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Documents.Field.ToString()</span></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_FacetField_VerifyLabel_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.FacetField.VerifyLabel(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/FacetField.cs/#L91">View Source</a>
</span>
<a id="Lucene_Net_Facet_FacetField_VerifyLabel_" data-uid="Lucene.Net.Facet.FacetField.VerifyLabel*"></a>
<h4 id="Lucene_Net_Facet_FacetField_VerifyLabel_System_String_" data-uid="Lucene.Net.Facet.FacetField.VerifyLabel(System.String)">VerifyLabel(String)</h4>
<div class="markdown level1 summary"><p>Verifies the label is not null or empty string.</p>
<div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div><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 VerifyLabel(string label)</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">label</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">Lucene.Net.Index.IIndexableField</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Facet_FacetField.md&amp;value=---%0Auid%3A%20Lucene.Net.Facet.FacetField%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/FacetField.cs/#L36" 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>