blob: 785e7f2a2b8ab42765b0e5a7ea8825e7b245dc20 [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 QueryBuilder
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class QueryBuilder
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="core/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Lucene.Net.Util.QueryBuilder">
<h1 id="Lucene_Net_Util_QueryBuilder" data-uid="Lucene.Net.Util.QueryBuilder" class="text-break">Class QueryBuilder
</h1>
<div class="markdown level0 summary"><p>Creates queries from the <a class="xref" href="Lucene.Net.Util.QueryBuilder.html#Lucene_Net_Util_QueryBuilder_Analyzer">Analyzer</a> chain.
<p>
Example usage:</p>
<pre><code> QueryBuilder builder = new QueryBuilder(analyzer);
Query a = builder.CreateBooleanQuery(&quot;body&quot;, &quot;just a test&quot;);
Query b = builder.CreatePhraseQuery(&quot;body&quot;, &quot;another test&quot;);
Query c = builder.CreateMinShouldMatchQuery(&quot;body&quot;, &quot;another test&quot;, 0.5f);</code></pre>
<p><p>
This can also be used as a subclass for query parsers to make it easier
to interact with the analysis chain. Factory methods such as <a class="xref" href="Lucene.Net.Util.QueryBuilder.html#Lucene_Net_Util_QueryBuilder_NewTermQuery_Lucene_Net_Index_Term_">NewTermQuery(Term)</a>
are provided so that the generated queries can be customized.</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">QueryBuilder</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.Util.html">Lucene.Net.Util</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Util_QueryBuilder_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class QueryBuilder</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder__ctor_Lucene_Net_Analysis_Analyzer_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.%23ctor(Lucene.Net.Analysis.Analyzer)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L60">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder__ctor_" data-uid="Lucene.Net.Util.QueryBuilder.#ctor*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder__ctor_Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.Util.QueryBuilder.#ctor(Lucene.Net.Analysis.Analyzer)">QueryBuilder(Analyzer)</h4>
<div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Util.QueryBuilder.html">QueryBuilder</a> using the given analyzer. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public QueryBuilder(Analyzer analyzer)</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.Analysis.Analyzer.html">Analyzer</a></td>
<td><span class="parametername">analyzer</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_Analyzer.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.Analyzer%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L153">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_Analyzer_" data-uid="Lucene.Net.Util.QueryBuilder.Analyzer*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_Analyzer" data-uid="Lucene.Net.Util.QueryBuilder.Analyzer">Analyzer</h4>
<div class="markdown level1 summary"><p>Gets or Sets the analyzer. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Analyzer Analyzer { get; set; }</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.Analysis.Analyzer.html">Analyzer</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_EnablePositionIncrements.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.EnablePositionIncrements%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L169">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_EnablePositionIncrements_" data-uid="Lucene.Net.Util.QueryBuilder.EnablePositionIncrements*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_EnablePositionIncrements" data-uid="Lucene.Net.Util.QueryBuilder.EnablePositionIncrements">EnablePositionIncrements</h4>
<div class="markdown level1 summary"><p>Gets or Sets whether position increments are enabled.
<p>
When <code>true</code>, result phrase and multi-phrase queries will
be aware of position increments.
Useful when e.g. a StopFilter increases the position increment of
the token that follows an omitted token.
<p>
Default: true.</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 EnablePositionIncrements { get; set; }</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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_CreateBooleanQuery_System_String_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.CreateBooleanQuery(System.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L73">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_CreateBooleanQuery_" data-uid="Lucene.Net.Util.QueryBuilder.CreateBooleanQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_CreateBooleanQuery_System_String_System_String_" data-uid="Lucene.Net.Util.QueryBuilder.CreateBooleanQuery(System.String,System.String)">CreateBooleanQuery(String, String)</h4>
<div class="markdown level1 summary"><p>Creates a boolean query from the query text.
<p>
This is equivalent to <code>CreateBooleanQuery(field, queryText, Occur.SHOULD)</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 Query CreateBooleanQuery(string field, string queryText)</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">field</span></td>
<td><p>Field name. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">queryText</span></td>
<td><p>Text to be passed to the analyzer. </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.Search.Query.html">Query</a></td>
<td><p><a class="xref" href="Lucene.Net.Search.TermQuery.html">TermQuery</a> or <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>, based on the analysis
of <code data-dev-comment-type="paramref" class="paramref">queryText</code>. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_CreateBooleanQuery_System_String_System_String_Lucene_Net_Search_Occur_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.CreateBooleanQuery(System.String%2CSystem.String%2CLucene.Net.Search.Occur)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L86">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_CreateBooleanQuery_" data-uid="Lucene.Net.Util.QueryBuilder.CreateBooleanQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_CreateBooleanQuery_System_String_System_String_Lucene_Net_Search_Occur_" data-uid="Lucene.Net.Util.QueryBuilder.CreateBooleanQuery(System.String,System.String,Lucene.Net.Search.Occur)">CreateBooleanQuery(String, String, Occur)</h4>
<div class="markdown level1 summary"><p>Creates a boolean query from the query text.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Query CreateBooleanQuery(string field, string queryText, Occur operator)</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">field</span></td>
<td><p>Field name </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">queryText</span></td>
<td><p>Text to be passed to the analyzer. </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Search.Occur.html">Occur</a></td>
<td><span class="parametername">operator</span></td>
<td><p>Operator used for clauses between analyzer tokens. </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.Search.Query.html">Query</a></td>
<td><p><a class="xref" href="Lucene.Net.Search.TermQuery.html">TermQuery</a> or <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>, based on the analysis
of <code data-dev-comment-type="paramref" class="paramref">queryText</code>. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_CreateFieldQuery_Lucene_Net_Analysis_Analyzer_Lucene_Net_Search_Occur_System_String_System_String_System_Boolean_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.CreateFieldQuery(Lucene.Net.Analysis.Analyzer%2CLucene.Net.Search.Occur%2CSystem.String%2CSystem.String%2CSystem.Boolean%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L187">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_CreateFieldQuery_" data-uid="Lucene.Net.Util.QueryBuilder.CreateFieldQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_CreateFieldQuery_Lucene_Net_Analysis_Analyzer_Lucene_Net_Search_Occur_System_String_System_String_System_Boolean_System_Int32_" data-uid="Lucene.Net.Util.QueryBuilder.CreateFieldQuery(Lucene.Net.Analysis.Analyzer,Lucene.Net.Search.Occur,System.String,System.String,System.Boolean,System.Int32)">CreateFieldQuery(Analyzer, Occur, String, String, Boolean, Int32)</h4>
<div class="markdown level1 summary"><p>Creates a query from the analysis chain.
<p>
Expert: this is more useful for subclasses such as queryparsers.
If using this class directly, just use <a class="xref" href="Lucene.Net.Util.QueryBuilder.html#Lucene_Net_Util_QueryBuilder_CreateBooleanQuery_System_String_System_String_">CreateBooleanQuery(String, String)</a>
and <a class="xref" href="Lucene.Net.Util.QueryBuilder.html#Lucene_Net_Util_QueryBuilder_CreatePhraseQuery_System_String_System_String_">CreatePhraseQuery(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">protected Query CreateFieldQuery(Analyzer analyzer, Occur operator, string field, string queryText, bool quoted, int phraseSlop)</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.Analysis.Analyzer.html">Analyzer</a></td>
<td><span class="parametername">analyzer</span></td>
<td><p>Analyzer used for this query. </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Search.Occur.html">Occur</a></td>
<td><span class="parametername">operator</span></td>
<td><p>Default boolean operator used for this query. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">field</span></td>
<td><p>Field to create queries against. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">queryText</span></td>
<td><p>Text to be passed to the analysis chain. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">quoted</span></td>
<td><p><code>true</code> if phrases should be generated when terms occur at more than one position. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">phraseSlop</span></td>
<td><p>Slop factor for phrase/multiphrase queries. </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.Search.Query.html">Query</a></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_CreateMinShouldMatchQuery_System_String_System_String_System_Single_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.CreateMinShouldMatchQuery(System.String%2CSystem.String%2CSystem.Single)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L129">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_CreateMinShouldMatchQuery_" data-uid="Lucene.Net.Util.QueryBuilder.CreateMinShouldMatchQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_CreateMinShouldMatchQuery_System_String_System_String_System_Single_" data-uid="Lucene.Net.Util.QueryBuilder.CreateMinShouldMatchQuery(System.String,System.String,System.Single)">CreateMinShouldMatchQuery(String, String, Single)</h4>
<div class="markdown level1 summary"><p>Creates a minimum-should-match query from the query text.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Query CreateMinShouldMatchQuery(string field, string queryText, float fraction)</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">field</span></td>
<td><p>Field name. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">queryText</span></td>
<td><p>Text to be passed to the analyzer. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">fraction</span></td>
<td><p>of query terms <code>[0..1]</code> that should match </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.Search.Query.html">Query</a></td>
<td><p><a class="xref" href="Lucene.Net.Search.TermQuery.html">TermQuery</a> or <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>, based on the analysis
of <code data-dev-comment-type="paramref" class="paramref">queryText</code>. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_CreatePhraseQuery_System_String_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.CreatePhraseQuery(System.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L103">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_CreatePhraseQuery_" data-uid="Lucene.Net.Util.QueryBuilder.CreatePhraseQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_CreatePhraseQuery_System_String_System_String_" data-uid="Lucene.Net.Util.QueryBuilder.CreatePhraseQuery(System.String,System.String)">CreatePhraseQuery(String, String)</h4>
<div class="markdown level1 summary"><p>Creates a phrase query from the query text.
<p>
This is equivalent to <code>CreatePhraseQuery(field, queryText, 0)</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 Query CreatePhraseQuery(string field, string queryText)</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">field</span></td>
<td><p>Field name. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">queryText</span></td>
<td><p>Text to be passed to the analyzer. </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.Search.Query.html">Query</a></td>
<td><p><a class="xref" href="Lucene.Net.Search.TermQuery.html">TermQuery</a>, <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>, <a class="xref" href="Lucene.Net.Search.PhraseQuery.html">PhraseQuery</a>, or
<a class="xref" href="Lucene.Net.Search.MultiPhraseQuery.html">MultiPhraseQuery</a>, based on the analysis of <code data-dev-comment-type="paramref" class="paramref">queryText</code>. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_CreatePhraseQuery_System_String_System_String_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.CreatePhraseQuery(System.String%2CSystem.String%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L116">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_CreatePhraseQuery_" data-uid="Lucene.Net.Util.QueryBuilder.CreatePhraseQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_CreatePhraseQuery_System_String_System_String_System_Int32_" data-uid="Lucene.Net.Util.QueryBuilder.CreatePhraseQuery(System.String,System.String,System.Int32)">CreatePhraseQuery(String, String, Int32)</h4>
<div class="markdown level1 summary"><p>Creates a phrase query from the query text.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Query CreatePhraseQuery(string field, string queryText, int phraseSlop)</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">field</span></td>
<td><p>Field name. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">queryText</span></td>
<td><p>Text to be passed to the analyzer. </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">phraseSlop</span></td>
<td><p>number of other words permitted between words in query phrase </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.Search.Query.html">Query</a></td>
<td><p><a class="xref" href="Lucene.Net.Search.TermQuery.html">TermQuery</a>, <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a>, <a class="xref" href="Lucene.Net.Search.PhraseQuery.html">PhraseQuery</a>, or
<a class="xref" href="Lucene.Net.Search.MultiPhraseQuery.html">MultiPhraseQuery</a>, based on the analysis of <code data-dev-comment-type="paramref" class="paramref">queryText</code>. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_NewBooleanQuery_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.NewBooleanQuery(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L442">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_NewBooleanQuery_" data-uid="Lucene.Net.Util.QueryBuilder.NewBooleanQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_NewBooleanQuery_System_Boolean_" data-uid="Lucene.Net.Util.QueryBuilder.NewBooleanQuery(System.Boolean)">NewBooleanQuery(Boolean)</h4>
<div class="markdown level1 summary"><p>Builds a new <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a> instance.
<p>
This is intended for subclasses that wish to customize the generated queries. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual BooleanQuery NewBooleanQuery(bool disableCoord)</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.Boolean</span></td>
<td><span class="parametername">disableCoord</span></td>
<td><p>Disable coord. </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.Search.BooleanQuery.html">BooleanQuery</a></td>
<td><p>New <a class="xref" href="Lucene.Net.Search.BooleanQuery.html">BooleanQuery</a> instance. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_NewMultiPhraseQuery.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.NewMultiPhraseQuery%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L476">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_NewMultiPhraseQuery_" data-uid="Lucene.Net.Util.QueryBuilder.NewMultiPhraseQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_NewMultiPhraseQuery" data-uid="Lucene.Net.Util.QueryBuilder.NewMultiPhraseQuery">NewMultiPhraseQuery()</h4>
<div class="markdown level1 summary"><p>Builds a new <a class="xref" href="Lucene.Net.Search.MultiPhraseQuery.html">MultiPhraseQuery</a> instance.
<p>
This is intended for subclasses that wish to customize the generated queries. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual MultiPhraseQuery NewMultiPhraseQuery()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Search.MultiPhraseQuery.html">MultiPhraseQuery</a></td>
<td><p>New <a class="xref" href="Lucene.Net.Search.MultiPhraseQuery.html">MultiPhraseQuery</a> instance. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_NewPhraseQuery.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.NewPhraseQuery%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L465">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_NewPhraseQuery_" data-uid="Lucene.Net.Util.QueryBuilder.NewPhraseQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_NewPhraseQuery" data-uid="Lucene.Net.Util.QueryBuilder.NewPhraseQuery">NewPhraseQuery()</h4>
<div class="markdown level1 summary"><p>Builds a new <a class="xref" href="Lucene.Net.Search.PhraseQuery.html">PhraseQuery</a> instance.
<p>
This is intended for subclasses that wish to customize the generated queries. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual PhraseQuery NewPhraseQuery()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Search.PhraseQuery.html">PhraseQuery</a></td>
<td><p>New <a class="xref" href="Lucene.Net.Search.PhraseQuery.html">PhraseQuery</a> instance. </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder_NewTermQuery_Lucene_Net_Index_Term_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.QueryBuilder.NewTermQuery(Lucene.Net.Index.Term)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L454">View Source</a>
</span>
<a id="Lucene_Net_Util_QueryBuilder_NewTermQuery_" data-uid="Lucene.Net.Util.QueryBuilder.NewTermQuery*"></a>
<h4 id="Lucene_Net_Util_QueryBuilder_NewTermQuery_Lucene_Net_Index_Term_" data-uid="Lucene.Net.Util.QueryBuilder.NewTermQuery(Lucene.Net.Index.Term)">NewTermQuery(Term)</h4>
<div class="markdown level1 summary"><p>Builds a new <a class="xref" href="Lucene.Net.Search.TermQuery.html">TermQuery</a> instance.
<p>
This is intended for subclasses that wish to customize the generated queries. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual Query NewTermQuery(Term term)</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.Index.Term.html">Term</a></td>
<td><span class="parametername">term</span></td>
<td><p>Term. </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.Search.Query.html">Query</a></td>
<td><p>New <a class="xref" href="Lucene.Net.Search.TermQuery.html">TermQuery</a> instance. </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_QueryBuilder.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/QueryBuilder.cs/#L53" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 Licensed to the Apache Software Foundation (ASF)
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>