| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Namespace Lucene.Net.QueryParsers.Flexible.Standard.Builders |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Namespace Lucene.Net.QueryParsers.Flexible.Standard.Builders |
| | 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="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"> |
| <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.Builders"> |
| |
| <h1 id="Lucene_Net_QueryParsers_Flexible_Standard_Builders" data-uid="Lucene.Net.QueryParsers.Flexible.Standard.Builders" class="text-break">Namespace Lucene.Net.QueryParsers.Flexible.Standard.Builders |
| </h1> |
| <div class="markdown level0 summary"><!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <p>Standard Lucene Query Node Builders.</p> |
| <h2 id="standard-lucene-query-node-builders">Standard Lucene Query Node Builders</h2> |
| <p> The package org.apache.lucene.queryparser.flexible.standard.builders contains all the builders needed to build a Lucene Query object from a query node tree. These builders expect the query node tree was already processed by the <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Processors.StandardQueryNodeProcessorPipeline.html">StandardQueryNodeProcessorPipeline</a>. </p> |
| <p> <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.StandardQueryTreeBuilder.html">StandardQueryTreeBuilder</a> is a builder that already contains a defined map that maps each QueryNode object with its respective builder. </p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="markdown level0 remarks"></div> |
| <h3 id="classes">Classes |
| </h3> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.AnyQueryNodeBuilder.html">AnyQueryNodeBuilder</a></h4> |
| <section><p>Builds a <span class="xref">Lucene.Net.Search.BooleanQuery</span> of SHOULD clauses, possibly with |
| some minimum number to match.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.BooleanQueryNodeBuilder.html">BooleanQueryNodeBuilder</a></h4> |
| <section><p>Builds a <span class="xref">Lucene.Net.Search.BooleanQuery</span> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.BooleanQueryNode.html">BooleanQueryNode</a> object. |
| Every children in the <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.BooleanQueryNode.html">BooleanQueryNode</a> object must be already tagged |
| using <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.QueryTreeBuilder.html#Lucene_Net_QueryParsers_Flexible_Core_Builders_QueryTreeBuilder_QUERY_TREE_BUILDER_TAGID">QUERY_TREE_BUILDER_TAGID</a> with a <span class="xref">Lucene.Net.Search.Query</span> |
| object. |
| <p> |
| It takes in consideration if the children is a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.ModifierQueryNode.html">ModifierQueryNode</a> to |
| define the <span class="xref">Lucene.Net.Search.BooleanClause</span>. |
| </p></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.BoostQueryNodeBuilder.html">BoostQueryNodeBuilder</a></h4> |
| <section><p>This builder basically reads the <span class="xref">Lucene.Net.Search.Query</span> object set on the |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.BoostQueryNode.html">BoostQueryNode</a> child using |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.QueryTreeBuilder.html#Lucene_Net_QueryParsers_Flexible_Core_Builders_QueryTreeBuilder_QUERY_TREE_BUILDER_TAGID">QUERY_TREE_BUILDER_TAGID</a> and applies the boost value |
| defined in the <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.BoostQueryNode.html">BoostQueryNode</a>.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.DummyQueryNodeBuilder.html">DummyQueryNodeBuilder</a></h4> |
| <section><p>This builder does nothing. Commonly used for <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.IQueryNode.html">IQueryNode</a> objects that |
| are built by its parent's builder.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.FieldQueryNodeBuilder.html">FieldQueryNodeBuilder</a></h4> |
| <section><p>Builds a <span class="xref">Lucene.Net.Search.TermQuery</span> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.FieldQueryNode.html">FieldQueryNode</a> object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.FuzzyQueryNodeBuilder.html">FuzzyQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.FuzzyQuery.html">FuzzyQuery</a> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.FuzzyQueryNode.html">FuzzyQueryNode</a> object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.GroupQueryNodeBuilder.html">GroupQueryNodeBuilder</a></h4> |
| <section><p>Builds no object, it only returns the <span class="xref">Lucene.Net.Search.Query</span> object set on the |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.GroupQueryNode.html">GroupQueryNode</a> object using a |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.QueryTreeBuilder.html#Lucene_Net_QueryParsers_Flexible_Core_Builders_QueryTreeBuilder_QUERY_TREE_BUILDER_TAGID">QUERY_TREE_BUILDER_TAGID</a> tag.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.MatchAllDocsQueryNodeBuilder.html">MatchAllDocsQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.MatchAllDocsQuery.html">MatchAllDocsQuery</a> object from a |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.MatchAllDocsQueryNode.html">MatchAllDocsQueryNode</a> object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.MatchNoDocsQueryNodeBuilder.html">MatchNoDocsQueryNodeBuilder</a></h4> |
| <section><p>Builds an empty <span class="xref">Lucene.Net.Search.BooleanQuery</span> object from a |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.MatchNoDocsQueryNode.html">MatchNoDocsQueryNode</a> object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.ModifierQueryNodeBuilder.html">ModifierQueryNodeBuilder</a></h4> |
| <section><p>Builds no object, it only returns the <span class="xref">Lucene.Net.Search.Query</span> object set on the |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.ModifierQueryNode.html">ModifierQueryNode</a> object using a |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.QueryTreeBuilder.html#Lucene_Net_QueryParsers_Flexible_Core_Builders_QueryTreeBuilder_QUERY_TREE_BUILDER_TAGID">QUERY_TREE_BUILDER_TAGID</a> tag.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.MultiPhraseQueryNodeBuilder.html">MultiPhraseQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.MultiPhraseQuery.html">MultiPhraseQuery</a> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Nodes.MultiPhraseQueryNode.html">MultiPhraseQueryNode</a> |
| object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.NumericRangeQueryNodeBuilder.html">NumericRangeQueryNodeBuilder</a></h4> |
| <section><p>Builds <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.NumericRangeQuery.html">NumericRangeQuery</a>s out of <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Nodes.NumericRangeQueryNode.html">NumericRangeQueryNode</a>s.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.PhraseQueryNodeBuilder.html">PhraseQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.PhraseQuery.html">PhraseQuery</a> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.TokenizedPhraseQueryNode.html">TokenizedPhraseQueryNode</a> |
| object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.PrefixWildcardQueryNodeBuilder.html">PrefixWildcardQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.PrefixQuery.html">PrefixQuery</a> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Nodes.PrefixWildcardQueryNode.html">PrefixWildcardQueryNode</a> |
| object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.RegexpQueryNodeBuilder.html">RegexpQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.RegexpQuery.html">RegexpQuery</a> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Nodes.RegexpQueryNode.html">RegexpQueryNode</a> object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.SlopQueryNodeBuilder.html">SlopQueryNodeBuilder</a></h4> |
| <section><p>This builder basically reads the <span class="xref">Lucene.Net.Search.Query</span> object set on the |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.SlopQueryNode.html">SlopQueryNode</a> child using |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Builders.QueryTreeBuilder.html#Lucene_Net_QueryParsers_Flexible_Core_Builders_QueryTreeBuilder_QUERY_TREE_BUILDER_TAGID">QUERY_TREE_BUILDER_TAGID</a> and applies the slop value |
| defined in the <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.SlopQueryNode.html">SlopQueryNode</a>.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.StandardBooleanQueryNodeBuilder.html">StandardBooleanQueryNodeBuilder</a></h4> |
| <section><p>This builder does the same as the <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.BooleanQueryNodeBuilder.html">BooleanQueryNodeBuilder</a>, but this |
| considers if the built <span class="xref">Lucene.Net.Search.BooleanQuery</span> should have its coord disabled or |
| not.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.StandardQueryTreeBuilder.html">StandardQueryTreeBuilder</a></h4> |
| <section><p>This query tree builder only defines the necessary map to build a |
| <span class="xref">Lucene.Net.Search.Query</span> tree object. It should be used to generate a <span class="xref">Lucene.Net.Search.Query</span> tree |
| object from a query node tree processed by a |
| <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Processors.StandardQueryNodeProcessorPipeline.html">StandardQueryNodeProcessorPipeline</a>.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.TermRangeQueryNodeBuilder.html">TermRangeQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.TermRangeQuery.html">TermRangeQuery</a> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Nodes.TermRangeQueryNode.html">TermRangeQueryNode</a> |
| object.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.WildcardQueryNodeBuilder.html">WildcardQueryNodeBuilder</a></h4> |
| <section><p>Builds a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.WildcardQuery.html">WildcardQuery</a> object from a <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Nodes.WildcardQueryNode.html">WildcardQueryNode</a> |
| object.</p> |
| </section> |
| <h3 id="interfaces">Interfaces |
| </h3> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Flexible.Standard.Builders.IStandardQueryBuilder.html">IStandardQueryBuilder</a></h4> |
| <section><p>This interface should be implemented by every class that wants to build |
| <span class="xref">Lucene.Net.Search.Query</span> objects from <a class="xref" href="Lucene.Net.QueryParsers.Flexible.Core.Nodes.IQueryNode.html">IQueryNode</a> objects. </p> |
| </section> |
| </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/blob/docs/4.8.0-beta00010/src/Lucene.Net.QueryParser/Flexible/Standard/Builders/package.md/#L2" class="contribution-link">Improve this Doc</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> |
