Google Git
Sign in
apache / lucenenet-site / 17c7bc1988cb32e7f8409919fc025c5fcaca3695 / . / docs / 4.8.0-beta00013 / api / queryparser / Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.html
blob: 6415dc2417c34180227df94b7338ebc3fb8eb838 [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 QueryParserUtil
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class QueryParserUtil
| 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.Standard.QueryParserUtil">
<h1 id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil" class="text-break">Class QueryParserUtil
</h1>
<div class="markdown level0 summary"><p>This class defines utility methods to (help) parse query strings into
<span class="xref">Lucene.Net.Search.Query</span> objects.</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">QueryParserUtil</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.Flexible.Standard.html">Lucene.Net.QueryParsers.Flexible.Standard</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.QueryParser.dll</h6>
<h5 id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class QueryParserUtil</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Escape_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Escape(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/Flexible/Standard/QueryParserUtil.cs/#L171">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Escape_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Escape*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Escape_System_String_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Escape(System.String)">Escape(String)</h4>
<div class="markdown level1 summary"><p>Returns a string where those characters that TextParser expects to be
escaped are escaped by a preceding <code>&lt;/code&gt;.<p>
</code></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string Escape(string s)</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">s</span></td>
<td></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></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_Standard_QueryParserUtil_Parse_System_String_System_String___Lucene_Net_Search_Occur___Lucene_Net_Analysis_Analyzer_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse(System.String%2CSystem.String%5B%5D%2CLucene.Net.Search.Occur%5B%5D%2CLucene.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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/QueryParserUtil.cs/#L94">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Parse_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Parse_System_String_System_String___Lucene_Net_Search_Occur___Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse(System.String,System.String[],Lucene.Net.Search.Occur[],Lucene.Net.Analysis.Analyzer)">Parse(String, String[], Occur[], Analyzer)</h4>
<div class="markdown level1 summary"><p>Parses a query, searching on the fields specified. Use this if you need to
specify certain fields as required, and others as prohibited.
<p>
Usage:</p>
<pre><code>string[] fields = {&quot;filename&quot;, &quot;contents&quot;, &quot;description&quot;};
Occur[] flags = {Occur.SHOULD,
Occur.MUST,
Occur.MUST_NOT};
MultiFieldQueryParser.Parse(&quot;query&quot;, fields, flags, analyzer);</code></pre>
<p><p>
The code above would construct a query:</p>
<pre><code>(filename:query) +(contents:query) -(description:query)</code></pre>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Query Parse(string query, string[] fields, Occur[] flags, 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><span class="xref">System.String</span></td>
<td><span class="parametername">query</span></td>
<td><p>Query string to parse</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td><span class="parametername">fields</span></td>
<td><p>Fields to search on</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Search.Occur</span>[]</td>
<td><span class="parametername">flags</span></td>
<td><p>Flags describing the fields</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Analysis.Analyzer</span></td>
<td><span class="parametername">analyzer</span></td>
<td><p>Analyzer to use</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">Lucene.Net.Search.Query</span></td>
<td></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><span class="xref">System.ArgumentException</span></td>
<td><p>if the length of the fields array differs from the length of the
flags array</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_Standard_QueryParserUtil_Parse_System_String___System_String___Lucene_Net_Analysis_Analyzer_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse(System.String%5B%5D%2CSystem.String%5B%5D%2CLucene.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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/QueryParserUtil.cs/#L46">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Parse_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Parse_System_String___System_String___Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse(System.String[],System.String[],Lucene.Net.Analysis.Analyzer)">Parse(String[], String[], Analyzer)</h4>
<div class="markdown level1 summary"><p>Parses a query which searches on the fields specified.
<p>
If x fields are specified, this effectively constructs:</p>
<pre><code>(field1:query1) (field2:query2) (field3:query3)...(fieldx:queryx)</code></pre>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Query Parse(string[] queries, string[] fields, 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><span class="xref">System.String</span>[]</td>
<td><span class="parametername">queries</span></td>
<td><p>Queries strings to parse</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td><span class="parametername">fields</span></td>
<td><p>Fields to search on</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Analysis.Analyzer</span></td>
<td><span class="parametername">analyzer</span></td>
<td><p>Analyzer to use</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">Lucene.Net.Search.Query</span></td>
<td></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><span class="xref">System.ArgumentException</span></td>
<td><p>if the length of the queries array differs from the length of the
fields array</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_Standard_QueryParserUtil_Parse_System_String___System_String___Lucene_Net_Search_Occur___Lucene_Net_Analysis_Analyzer_.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse(System.String%5B%5D%2CSystem.String%5B%5D%2CLucene.Net.Search.Occur%5B%5D%2CLucene.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/fix/apidocs-layout/src/Lucene.Net.QueryParser/Flexible/Standard/QueryParserUtil.cs/#L143">View Source</a>
</span>
<a id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Parse_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse*"></a>
<h4 id="Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil_Parse_System_String___System_String___Lucene_Net_Search_Occur___Lucene_Net_Analysis_Analyzer_" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil.Parse(System.String[],System.String[],Lucene.Net.Search.Occur[],Lucene.Net.Analysis.Analyzer)">Parse(String[], String[], Occur[], Analyzer)</h4>
<div class="markdown level1 summary"><p>Parses a query, searching on the fields specified. Use this if you need to
specify certain fields as required, and others as prohibited.
<p>
Usage:</p>
<pre><code>string[] query = {&quot;query1&quot;, &quot;query2&quot;, &quot;query3&quot;};
string[] fields = {&quot;filename&quot;, &quot;contents&quot;, &quot;description&quot;};
Occur[] flags = {Occur.SHOULD,
Occur.MUST,
Occur.MUST_NOT};
MultiFieldQueryParser.Parse(query, fields, flags, analyzer);</code></pre>
<p><p>
The code above would construct a query:</p>
<pre><code>(filename:query1) +(contents:query2) -(description:query3)</code></pre>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Query Parse(string[] queries, string[] fields, Occur[] flags, 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><span class="xref">System.String</span>[]</td>
<td><span class="parametername">queries</span></td>
<td><p>Queries string to parse</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td><span class="parametername">fields</span></td>
<td><p>Fields to search on</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Search.Occur</span>[]</td>
<td><span class="parametername">flags</span></td>
<td><p>Flags describing the fields</p>
</td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Analysis.Analyzer</span></td>
<td><span class="parametername">analyzer</span></td>
<td><p>Analyzer to use</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">Lucene.Net.Search.Query</span></td>
<td></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><span class="xref">System.ArgumentException</span></td>
<td><p>if the length of the queries, fields, and flags array differ</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_QueryParsers_Flexible_Standard_QueryParserUtil.md&amp;value=---%0Auid%3A%20Lucene.Net.QueryParsers.Flexible.Standard.QueryParserUtil%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/Standard/QueryParserUtil.cs/#L29" 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>