| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class AbstractQueryConfig |
| | Apache Lucene.NET 4.8.0 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class AbstractQueryConfig |
| | Apache Lucene.NET 4.8.0 Documentation "> |
| <meta name="generator" content="docfx 2.47.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.QueryParsers.Flexible.Core.Config.AbstractQueryConfig"> |
| |
| |
| <h1 id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig" class="text-break">Class AbstractQueryConfig |
| </h1> |
| <div class="markdown level0 summary"><p>This class is the base of <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</a> and <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.FieldConfig.html">FieldConfig</a>. |
| It has operations to set, unset and get configuration values. |
| <p> |
| Each configuration is is a key->value pair. The key should be an unique |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey-1.html">ConfigurationKey<T></a> instance and it also holds the value's type. |
| </p> |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey-1.html">ConfigurationKey<T></a></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">AbstractQueryConfig</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.FieldConfig.html">FieldConfig</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</a></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.QueryParsers.Flexible.Core.Config.html">Lucene.Net.QueryParsers.Flexible.Core.Config</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.QueryParser.dll</h6> |
| <h5 id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class AbstractQueryConfig</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Get__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0__.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Get%60%601(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey%7B%60%600%7D)%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-update-jan2020/src/Lucene.Net.QueryParser/Flexible/Core/Config/AbstractQueryConfig.cs/#L47">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Get_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Get*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Get__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0__" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Get``1(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey{``0})">Get<T>(ConfigurationKey<T>)</h4> |
| <div class="markdown level1 summary"><p>Returns the value held by the given key.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual T Get<T>(ConfigurationKey<T> key)</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.QueryParsers.Flexible.Core.Config.ConfigurationKey-1.html">ConfigurationKey</a><T></td> |
| <td><span class="parametername">key</span></td> |
| <td><p>the key, cannot be <code>null</code></p> |
| </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">T</span></td> |
| <td><p>the value held by the given key</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td><p>the value's type</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Has__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0__.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Has%60%601(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey%7B%60%600%7D)%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-update-jan2020/src/Lucene.Net.QueryParser/Flexible/Core/Config/AbstractQueryConfig.cs/#L64">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Has_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Has*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Has__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0__" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Has``1(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey{``0})">Has<T>(ConfigurationKey<T>)</h4> |
| <div class="markdown level1 summary"><p>Returns <code>true</code> if there is a value set with the given key, otherwise <code>false</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool Has<T>(ConfigurationKey<T> key)</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.QueryParsers.Flexible.Core.Config.ConfigurationKey-1.html">ConfigurationKey</a><T></td> |
| <td><span class="parametername">key</span></td> |
| <td><p>the key, cannot be <code>null</code></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><p><code>true</code> if there is a value set with the given key, otherwise <code>false</code></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td><p>the value's type</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Set__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0____0_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Set%60%601(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey%7B%60%600%7D%2C%60%600)%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-update-jan2020/src/Lucene.Net.QueryParser/Flexible/Core/Config/AbstractQueryConfig.cs/#L80">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Set_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Set*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Set__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0____0_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Set``1(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey{``0},``0)">Set<T>(ConfigurationKey<T>, T)</h4> |
| <div class="markdown level1 summary"><p>Sets a key and its value.</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 Set<T>(ConfigurationKey<T> key, T value)</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.QueryParsers.Flexible.Core.Config.ConfigurationKey-1.html">ConfigurationKey</a><T></td> |
| <td><span class="parametername">key</span></td> |
| <td><p>the key, cannot be <code>null</code></p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">T</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>value to set</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td><p>the value's type</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Unset__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0__.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Unset%60%601(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey%7B%60%600%7D)%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-update-jan2020/src/Lucene.Net.QueryParser/Flexible/Core/Config/AbstractQueryConfig.cs/#L103">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Unset_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Unset*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig_Unset__1_Lucene_Net_QueryParsers_Flexible_Core_Config_ConfigurationKey___0__" data-uid="Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig.Unset``1(Lucene.Net.QueryParsers.Flexible.Core.Config.ConfigurationKey{``0})">Unset<T>(ConfigurationKey<T>)</h4> |
| <div class="markdown level1 summary"><p>Unsets the given key and its value.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool Unset<T>(ConfigurationKey<T> key)</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.QueryParsers.Flexible.Core.Config.ConfigurationKey-1.html">ConfigurationKey</a><T></td> |
| <td><span class="parametername">key</span></td> |
| <td><p>the key</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><p><code>true</code> if the key and value was set and removed, otherwise <code>false</code></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td><p>the value's type</p> |
| </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Core_Config_AbstractQueryConfig.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.Config.AbstractQueryConfig%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.QueryParser/Flexible/Core/Config/AbstractQueryConfig.cs/#L32" 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> |