| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class Extensions |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class Extensions |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.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="queryparser/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"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <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.QueryParsers.Ext.Extensions"> |
| |
| |
| <h1 id="Lucene_Net_QueryParsers_Ext_Extensions" data-uid="Lucene.Net.QueryParsers.Ext.Extensions" class="text-break">Class Extensions |
| </h1> |
| <div class="markdown level0 summary"><p>The <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html">Extensions</a> class represents an extension mapping to associate |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.ParserExtension.html">ParserExtension</a> instances with extension keys. An extension key is a |
| string encoded into a Lucene standard query parser field symbol recognized by |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.ExtendableQueryParser.html">ExtendableQueryParser</a>. The query parser passes each extension field |
| token to <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_SplitExtensionField_System_String_System_String_">SplitExtensionField(String, String)</a> to separate the |
| extension key from the field identifier. |
| <p> |
| In addition to the key to extension mapping this class also defines the field |
| name overloading scheme. <a class="xref" href="Lucene.Net.QueryParsers.Ext.ExtendableQueryParser.html">ExtendableQueryParser</a> uses the given |
| extension to split the actual field name and extension key by calling |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_SplitExtensionField_System_String_System_String_">SplitExtensionField(String, String)</a>. To change the order or the key |
| / field name encoding scheme users can subclass <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html">Extensions</a> to |
| implement their own.</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">Extensions</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.QueryParsers.Ext.html">Lucene.Net.QueryParsers.Ext</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.QueryParser.dll</h6> |
| <h5 id="Lucene_Net_QueryParsers_Ext_Extensions_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class Extensions</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions__ctor.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L56">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions__ctor_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.#ctor*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions__ctor" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.#ctor">Extensions()</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html">Extensions</a> instance with the |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_DEFAULT_EXTENSION_FIELD_DELIMITER">DEFAULT_EXTENSION_FIELD_DELIMITER</a> as a delimiter character.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Extensions()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions__ctor_System_Char_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.%23ctor(System.Char)%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L65">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions__ctor_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.#ctor*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions__ctor_System_Char_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.#ctor(System.Char)">Extensions(Char)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html">Extensions</a> instance</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public Extensions(char extensionFieldDelimiter)</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.Char</span></td> |
| <td><span class="parametername">extensionFieldDelimiter</span></td> |
| <td><p>the extensions field delimiter character</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_DEFAULT_EXTENSION_FIELD_DELIMITER.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.DEFAULT_EXTENSION_FIELD_DELIMITER%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L50">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_DEFAULT_EXTENSION_FIELD_DELIMITER" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.DEFAULT_EXTENSION_FIELD_DELIMITER">DEFAULT_EXTENSION_FIELD_DELIMITER</h4> |
| <div class="markdown level1 summary"><p>The default extension field delimiter character. This constant is set to ':'</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 char DEFAULT_EXTENSION_FIELD_DELIMITER</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.Char</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_ExtensionFieldDelimiter.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.ExtensionFieldDelimiter%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L96">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions_ExtensionFieldDelimiter_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.ExtensionFieldDelimiter*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_ExtensionFieldDelimiter" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.ExtensionFieldDelimiter">ExtensionFieldDelimiter</h4> |
| <div class="markdown level1 summary"><p>Returns the extension field delimiter</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual char ExtensionFieldDelimiter { 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.Char</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_Add_System_String_Lucene_Net_QueryParsers_Ext_ParserExtension_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.Add(System.String%2CLucene.Net.QueryParsers.Ext.ParserExtension)%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L75">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions_Add_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.Add*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_Add_System_String_Lucene_Net_QueryParsers_Ext_ParserExtension_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.Add(System.String,Lucene.Net.QueryParsers.Ext.ParserExtension)">Add(String, ParserExtension)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.QueryParsers.Ext.ParserExtension.html">ParserExtension</a> instance associated with 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 void Add(string key, ParserExtension extension)</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">key</span></td> |
| <td><p>the parser extension key</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.QueryParsers.Ext.ParserExtension.html">ParserExtension</a></td> |
| <td><span class="parametername">extension</span></td> |
| <td><p>the parser extension</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.BuildExtensionField(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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L149">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.BuildExtensionField*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.BuildExtensionField(System.String)">BuildExtensionField(String)</h4> |
| <div class="markdown level1 summary"><p>Builds an extension field string from a given extension key and the default |
| query field. The default field and the key are delimited with the extension |
| field delimiter character. This method makes no assumption about the order |
| of the extension key and the field. By default the extension key is |
| appended to the end of the returned string while the field is added to the |
| beginning. Special Query characters are escaped in the result. |
| <p> |
| Note: <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html">Extensions</a> subclasses must maintain the contract between |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_">BuildExtensionField(String)</a> and |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_System_String_">BuildExtensionField(String, String)</a> where the latter inverts the |
| former. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string BuildExtensionField(string extensionKey)</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">extensionKey</span></td> |
| <td><p>the extension 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.String</span></td> |
| <td><p>escaped extension field identifier</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.BuildExtensionField(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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L172">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.BuildExtensionField*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_System_String_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.BuildExtensionField(System.String,System.String)">BuildExtensionField(String, String)</h4> |
| <div class="markdown level1 summary"><p>Builds an extension field string from a given extension key and the default |
| query field. The default field and the key are delimited with the extension |
| field delimiter character. This method makes no assumption about the order |
| of the extension key and the field. By default the extension key is |
| appended to the end of the returned string while the field is added to the |
| beginning. Special Query characters are escaped in the result. |
| <p> |
| Note: <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html">Extensions</a> subclasses must maintain the contract between |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_">BuildExtensionField(String)</a> and |
| <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_System_String_">BuildExtensionField(String, String)</a> where the latter inverts the |
| former. |
| </p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual string BuildExtensionField(string extensionKey, string field)</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">extensionKey</span></td> |
| <td><p>the extension key</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>the field to apply the extension on.</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.String</span></td> |
| <td><p>escaped extension field identifier</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_System_String__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>See <a class="xref" href="Lucene.Net.QueryParsers.Ext.Extensions.html#Lucene_Net_QueryParsers_Ext_Extensions_BuildExtensionField_System_String_">BuildExtensionField(String)</a> to use the default query field</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_EscapeExtensionField_System_String_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.EscapeExtensionField(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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L128">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions_EscapeExtensionField_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.EscapeExtensionField*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_EscapeExtensionField_System_String_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.EscapeExtensionField(System.String)">EscapeExtensionField(String)</h4> |
| <div class="markdown level1 summary"><p>Escapes an extension field. The default implementation is equivalent to |
| <a class="xref" href="Lucene.Net.QueryParsers.Classic.QueryParserBase.html#Lucene_Net_QueryParsers_Classic_QueryParserBase_Escape_System_String_">Escape(String)</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 string EscapeExtensionField(string extfield)</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">extfield</span></td> |
| <td><p>the extension field identifier</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.String</span></td> |
| <td><p>the extension field identifier with all special chars escaped with |
| a backslash character.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_GetExtension_System_String_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.GetExtension(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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L87">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions_GetExtension_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.GetExtension*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_GetExtension_System_String_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.GetExtension(System.String)">GetExtension(String)</h4> |
| <div class="markdown level1 summary"><p>Returns the <a class="xref" href="Lucene.Net.QueryParsers.Ext.ParserExtension.html">ParserExtension</a> instance for the given key or</p> |
| <pre><code>null</code></pre> if no extension can be found for the key. |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ParserExtension GetExtension(string 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><span class="xref">System.String</span></td> |
| <td><span class="parametername">key</span></td> |
| <td><p>the extension 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><a class="xref" href="Lucene.Net.QueryParsers.Ext.ParserExtension.html">ParserExtension</a></td> |
| <td><p>the <a class="xref" href="Lucene.Net.QueryParsers.Ext.ParserExtension.html">ParserExtension</a> instance for the given key or</p> |
| <pre><code>null</code></pre> if no extension can be found for the key.</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions_SplitExtensionField_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions.SplitExtensionField(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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L111">View Source</a> |
| </span> |
| <a id="Lucene_Net_QueryParsers_Ext_Extensions_SplitExtensionField_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.SplitExtensionField*"></a> |
| <h4 id="Lucene_Net_QueryParsers_Ext_Extensions_SplitExtensionField_System_String_System_String_" data-uid="Lucene.Net.QueryParsers.Ext.Extensions.SplitExtensionField(System.String,System.String)">SplitExtensionField(String, String)</h4> |
| <div class="markdown level1 summary"><p>Splits a extension field and returns the field / extension part as a |
| <span class="xref">Tuple{string,string}</span>. This method tries to split on the first occurrence of the |
| extension field delimiter, if the delimiter is not present in the string |
| the result will contain a <pre><code>null</code></pre> value for the extension key and |
| the given field string as the field value. If the given extension field |
| string contains no field identifier the result pair will carry the given |
| default field as the field 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 Tuple<string, string> SplitExtensionField(string defaultField, string field)</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">defaultField</span></td> |
| <td><p>the default query field</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">field</span></td> |
| <td><p>the extension field string</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.Tuple</span><<span class="xref">System.String</span>, <span class="xref">System.String</span>></td> |
| <td><p>a {<span class="xref">System.Tuple<T1, T2></span> with the field name as the <span class="xref">System.Tuple`2.Item1</span> and the |
| extension key as the <span class="xref">System.Tuple`2.Item2</span></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.QueryParsers.Ext.ExtendableQueryParser.html">ExtendableQueryParser</a></div> |
| <div><a class="xref" href="Lucene.Net.QueryParsers.Ext.ParserExtension.html">ParserExtension</a></div> |
| </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Ext_Extensions.md&value=---%0Auid%3A%20Lucene.Net.QueryParsers.Ext.Extensions%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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Ext/Extensions.cs/#L42" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </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> |
