blob: 22cb5fc06ee5998d558c388db68060b1695fd58f [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 QueryParserHelper&lt;TQuery&gt;
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class QueryParserHelper&lt;TQuery&gt;
| 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.Flexible.Core.QueryParserHelper`1">
<h1 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1" class="text-break">Class QueryParserHelper&lt;TQuery&gt;
</h1>
<div class="markdown level0 summary"><p>This class is a helper for the query parser framework, it does all the three
query parser phrases at once: text parsing, query processing and query
building.
<p>
It contains methods that allows the user to change the implementation used on
the three phases.
</p></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">QueryParserHelper&lt;TQuery&gt;</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.StandardQueryParser.html">StandardQueryParser</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.html">Lucene.Net.QueryParsers.Flexible.Core</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.QueryParser.dll</h6>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class QueryParserHelper&lt;TQuery&gt;</code></pre>
</div>
<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">TQuery</span></td>
<td></td>
</tr>
</tbody>
</table>
<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_Flexible_Core_QueryParserHelper_1__ctor_Lucene_Net_QueryParsers_Flexible_Core_Config_QueryConfigHandler_Lucene_Net_QueryParsers_Flexible_Core_Parser_ISyntaxParser_Lucene_Net_QueryParsers_Flexible_Core_Processors_IQueryNodeProcessor_Lucene_Net_QueryParsers_Flexible_Core_Builders_IQueryBuilder__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.%23ctor(Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler%2CLucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser%2CLucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor%2CLucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder%7B%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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Core/QueryParserHelper.cs/#L62">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1__ctor_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.#ctor*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1__ctor_Lucene_Net_QueryParsers_Flexible_Core_Config_QueryConfigHandler_Lucene_Net_QueryParsers_Flexible_Core_Parser_ISyntaxParser_Lucene_Net_QueryParsers_Flexible_Core_Processors_IQueryNodeProcessor_Lucene_Net_QueryParsers_Flexible_Core_Builders_IQueryBuilder__0__" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.#ctor(Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler,Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser,Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor,Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder{`0})">QueryParserHelper(QueryConfigHandler, ISyntaxParser, IQueryNodeProcessor, IQueryBuilder&lt;TQuery&gt;)</h4>
<div class="markdown level1 summary"><p>Creates a query parser helper object using the specified configuration,
text parser, processor and builder.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public QueryParserHelper(QueryConfigHandler queryConfigHandler, ISyntaxParser syntaxParser, IQueryNodeProcessor processor, IQueryBuilder&lt;TQuery&gt; builder)</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.QueryConfigHandler.html">QueryConfigHandler</a></td>
<td><span class="parametername">queryConfigHandler</span></td>
<td><p>the query configuration handler that will be initially set to this helper</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser.html">ISyntaxParser</a></td>
<td><span class="parametername">syntaxParser</span></td>
<td><p>the text parser that will be initially set to this helper</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor.html">IQueryNodeProcessor</a></td>
<td><span class="parametername">processor</span></td>
<td><p>the query processor that will be initially set to this helper</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder-1.html">IQueryBuilder</a>&lt;TQuery&gt;</td>
<td><span class="parametername">builder</span></td>
<td><p>the query builder that will be initially set to this helper</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1__ctor_Lucene_Net_QueryParsers_Flexible_Core_Config_QueryConfigHandler_Lucene_Net_QueryParsers_Flexible_Core_Parser_ISyntaxParser_Lucene_Net_QueryParsers_Flexible_Core_Processors_IQueryNodeProcessor_Lucene_Net_QueryParsers_Flexible_Core_Builders_IQueryBuilder__0___seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor.html">IQueryNodeProcessor</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser.html">ISyntaxParser</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder-1.html">IQueryBuilder</a>&lt;TQuery&gt;</div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</a></div>
</div>
<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_Flexible_Core_QueryParserHelper_1_QueryBuilder.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.QueryBuilder%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/Flexible/Core/QueryParserHelper.cs/#L139">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryBuilder_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.QueryBuilder*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryBuilder" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.QueryBuilder">QueryBuilder</h4>
<div class="markdown level1 summary"><p>Returns the query builder used to build a object from the query node tree.
The object produced by this builder is returned by <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_Parse_System_String_System_String_">Parse(String, 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 IQueryBuilder&lt;TQuery&gt; QueryBuilder { 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.QueryParsers.Flexible.Core.Builders.IQueryBuilder-1.html">IQueryBuilder</a>&lt;TQuery&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryBuilder_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryBuilder_Lucene_Net_QueryParsers_Flexible_Core_Builders_IQueryBuilder__0__">SetQueryBuilder(IQueryBuilder&lt;TQuery&gt;)</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder-1.html">IQueryBuilder</a>&lt;TQuery&gt;</div>
</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_Flexible_Core_QueryParserHelper_1_QueryConfigHandler.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.QueryConfigHandler%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/Flexible/Core/QueryParserHelper.cs/#L131">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryConfigHandler_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.QueryConfigHandler*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryConfigHandler" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.QueryConfigHandler">QueryConfigHandler</h4>
<div class="markdown level1 summary"><p>Returns the query configuration handler, which is used during the query
node tree processing. It can be <code>null</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 QueryConfigHandler QueryConfigHandler { 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.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryConfigHandler_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryConfigHandler_Lucene_Net_QueryParsers_Flexible_Core_Config_QueryConfigHandler_">SetQueryConfigHandler(QueryConfigHandler)</a></div>
</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_Flexible_Core_QueryParserHelper_1_QueryNodeProcessor.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.QueryNodeProcessor%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/Flexible/Core/QueryParserHelper.cs/#L82">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryNodeProcessor_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.QueryNodeProcessor*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryNodeProcessor" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.QueryNodeProcessor">QueryNodeProcessor</h4>
<div class="markdown level1 summary"><p>Gets the processor object used to process the query node tree, it
returns <code>null</code> if no processor is used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IQueryNodeProcessor QueryNodeProcessor { 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.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor.html">IQueryNodeProcessor</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryNodeProcessor_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor.html">IQueryNodeProcessor</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryNodeProcessor_Lucene_Net_QueryParsers_Flexible_Core_Processors_IQueryNodeProcessor_">SetQueryNodeProcessor(IQueryNodeProcessor)</a></div>
</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_Flexible_Core_QueryParserHelper_1_SyntaxParser.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.SyntaxParser%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/Flexible/Core/QueryParserHelper.cs/#L148">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SyntaxParser_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SyntaxParser*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SyntaxParser" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SyntaxParser">SyntaxParser</h4>
<div class="markdown level1 summary"><p>Returns the text parser used to build a query node tree from a query
string. The default text parser instance returned by this method is a
<a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser.html">ISyntaxParser</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 ISyntaxParser SyntaxParser { 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.QueryParsers.Flexible.Core.Parser.ISyntaxParser.html">ISyntaxParser</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SyntaxParser_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser.html">ISyntaxParser</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetSyntaxParser_Lucene_Net_QueryParsers_Flexible_Core_Parser_ISyntaxParser_">SetSyntaxParser(ISyntaxParser)</a></div>
</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_Parse_System_String_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.Parse(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/Flexible/Core/QueryParserHelper.cs/#L195">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_Parse_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.Parse*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_Parse_System_String_System_String_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.Parse(System.String,System.String)">Parse(String, String)</h4>
<div class="markdown level1 summary"><p>Parses a query string to an object, usually some query object.
<p>
In this method the three phases are executed:
<p>
<ol><li>
the query string is parsed using the
text parser returned by <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SyntaxParser">SyntaxParser</a>, the result is a query
node tree.
</li><li>
the query node tree is processed by the
processor returned by <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryNodeProcessor">QueryNodeProcessor</a>.
</li><li>
a object is built from the query node
tree using the builder returned by <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryBuilder">QueryBuilder</a>.
</li></ol></p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual TQuery Parse(string query, string defaultField)</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">query</span></td>
<td><p>the query string</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">defaultField</span></td>
<td><p>the default field used by the text parser</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">TQuery</span></td>
<td><p>the object built from the query</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryNodeException.html">QueryNodeException</a></td>
<td><p>if something wrong happens along the three phases</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_Flexible_Core_QueryParserHelper_1_SetQueryBuilder_Lucene_Net_QueryParsers_Flexible_Core_Builders_IQueryBuilder__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.SetQueryBuilder(Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder%7B%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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Core/QueryParserHelper.cs/#L120">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryBuilder_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetQueryBuilder*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryBuilder_Lucene_Net_QueryParsers_Flexible_Core_Builders_IQueryBuilder__0__" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetQueryBuilder(Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder{`0})">SetQueryBuilder(IQueryBuilder&lt;TQuery&gt;)</h4>
<div class="markdown level1 summary"><p>The query builder that will be used to build an object from the query node
tree. It cannot be <code>null</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 void SetQueryBuilder(IQueryBuilder&lt;TQuery&gt; queryBuilder)</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.Builders.IQueryBuilder-1.html">IQueryBuilder</a>&lt;TQuery&gt;</td>
<td><span class="parametername">queryBuilder</span></td>
<td><p>the query builder used to build something from the query node tree</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryBuilder_Lucene_Net_QueryParsers_Flexible_Core_Builders_IQueryBuilder__0___seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryBuilder">QueryBuilder</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder-1.html">IQueryBuilder</a>&lt;TQuery&gt;</div>
</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_Flexible_Core_QueryParserHelper_1_SetQueryConfigHandler_Lucene_Net_QueryParsers_Flexible_Core_Config_QueryConfigHandler_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.SetQueryConfigHandler(Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler)%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/Flexible/Core/QueryParserHelper.cs/#L159">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryConfigHandler_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetQueryConfigHandler*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryConfigHandler_Lucene_Net_QueryParsers_Flexible_Core_Config_QueryConfigHandler_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetQueryConfigHandler(Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler)">SetQueryConfigHandler(QueryConfigHandler)</h4>
<div class="markdown level1 summary"><p>Sets the query configuration handler that will be used during query
processing. It can be <code>null</code>. It&apos;s also set to the processor
returned by <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryNodeProcessor">QueryNodeProcessor</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 void SetQueryConfigHandler(QueryConfigHandler config)</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.QueryConfigHandler.html">QueryConfigHandler</a></td>
<td><span class="parametername">config</span></td>
<td><p>the query configuration handler used during query processing, it
can be <code>null</code></p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryConfigHandler_Lucene_Net_QueryParsers_Flexible_Core_Config_QueryConfigHandler__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryConfigHandler">QueryConfigHandler</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</a></div>
</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_Flexible_Core_QueryParserHelper_1_SetQueryNodeProcessor_Lucene_Net_QueryParsers_Flexible_Core_Processors_IQueryNodeProcessor_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.SetQueryNodeProcessor(Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor)%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/Flexible/Core/QueryParserHelper.cs/#L95">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryNodeProcessor_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetQueryNodeProcessor*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryNodeProcessor_Lucene_Net_QueryParsers_Flexible_Core_Processors_IQueryNodeProcessor_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetQueryNodeProcessor(Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor)">SetQueryNodeProcessor(IQueryNodeProcessor)</h4>
<div class="markdown level1 summary"><p>Sets the processor that will be used to process the query node tree. If
there is any <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</a> returned by
<a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryConfigHandler">QueryConfigHandler</a>, it will be set on the processor. The
argument can be <code>null</code>, which means that no processor will be
used to process the query node tree.</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 SetQueryNodeProcessor(IQueryNodeProcessor processor)</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.Processors.IQueryNodeProcessor.html">IQueryNodeProcessor</a></td>
<td><span class="parametername">processor</span></td>
<td><p>the processor that will be used to process the query node tree,
this argument can be <code>null</code></p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetQueryNodeProcessor_Lucene_Net_QueryParsers_Flexible_Core_Processors_IQueryNodeProcessor__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_QueryNodeProcessor">QueryNodeProcessor</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor.html">IQueryNodeProcessor</a></div>
</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_Flexible_Core_QueryParserHelper_1_SetSyntaxParser_Lucene_Net_QueryParsers_Flexible_Core_Parser_ISyntaxParser_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601.SetSyntaxParser(Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser)%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/Flexible/Core/QueryParserHelper.cs/#L108">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetSyntaxParser_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetSyntaxParser*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetSyntaxParser_Lucene_Net_QueryParsers_Flexible_Core_Parser_ISyntaxParser_" data-uid="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper`1.SetSyntaxParser(Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser)">SetSyntaxParser(ISyntaxParser)</h4>
<div class="markdown level1 summary"><p>Sets the text parser that will be used to parse the query string, it cannot
be <code>null</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 void SetSyntaxParser(ISyntaxParser syntaxParser)</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.Parser.ISyntaxParser.html">ISyntaxParser</a></td>
<td><span class="parametername">syntaxParser</span></td>
<td><p>the text parser that will be used to parse the query string</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SetSyntaxParser_Lucene_Net_QueryParsers_Flexible_Core_Parser_ISyntaxParser__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper-1.html#Lucene_Net_QueryParsers_Flexible_Core_QueryParserHelper_1_SyntaxParser">SyntaxParser</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser.html">ISyntaxParser</a></div>
</div>
<h3 id="seealso">See Also</h3>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Processors.IQueryNodeProcessor.html">IQueryNodeProcessor</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Parser.ISyntaxParser.html">ISyntaxParser</a></div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.IQueryBuilder-1.html">IQueryBuilder</a>&lt;TQuery&gt;</div>
<div><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Config.QueryConfigHandler.html">QueryConfigHandler</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_Flexible_Core_QueryParserHelper_1.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Core.QueryParserHelper%601%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/Flexible/Core/QueryParserHelper.cs/#L40" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 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>