| <!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.Xml.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.Xml.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.Xml.Builders"> |
| |
| <h1 id="Lucene_Net_QueryParsers_Xml_Builders" data-uid="Lucene.Net.QueryParsers.Xml.Builders" class="text-break">Namespace Lucene.Net.QueryParsers.Xml.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>XML Parser factories for different Lucene Query/Filters.</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.Xml.Builders.BooleanFilterBuilder.html">BooleanFilterBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Queries.BooleanFilter</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.BooleanQueryBuilder.html">BooleanQueryBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Search.BooleanQuery</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.BoostingQueryBuilder.html">BoostingQueryBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Queries.BoostingQuery</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.BoostingTermBuilder.html">BoostingTermBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Payloads.PayloadTermQuery.html">PayloadTermQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.CachedFilterBuilder.html">CachedFilterBuilder</a></h4> |
| <section><p>Filters are cached in an LRU Cache keyed on the contained query or filter object. Using this will |
| speed up overall performance for repeated uses of the same expensive query/filter. The sorts of |
| queries/filters likely to benefit from caching need not necessarily be complex - e.g. simple |
| TermQuerys with a large DF (document frequency) can be expensive on large indexes. |
| A good example of this might be a term query on a field with only 2 possible values - |
| "true" or "false". In a large index, querying or filtering on this field requires reading |
| millions of document ids from disk which can more usefully be cached as a filter bitset. |
| <p> |
| For Queries/Filters to be cached and reused the object must implement hashcode and |
| equals methods correctly so that duplicate queries/filters can be detected in the cache. |
| <p> |
| The CoreParser.maxNumCachedFilters property can be used to control the size of the LRU |
| Cache established during the construction of CoreParser instances.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.ConstantScoreQueryBuilder.html">ConstantScoreQueryBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.ConstantScoreQuery.html">ConstantScoreQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.DisjunctionMaxQueryBuilder.html">DisjunctionMaxQueryBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.DisjunctionMaxQuery.html">DisjunctionMaxQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.DuplicateFilterBuilder.html">DuplicateFilterBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Sandbox.Queries.DuplicateFilter</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.FilteredQueryBuilder.html">FilteredQueryBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.FilteredQuery.html">FilteredQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.FuzzyLikeThisQueryBuilder.html">FuzzyLikeThisQueryBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Sandbox.Queries.FuzzyLikeThisQuery</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.LikeThisQueryBuilder.html">LikeThisQueryBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Queries.Mlt.MoreLikeThisQuery</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.MatchAllDocsQueryBuilder.html">MatchAllDocsQueryBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.MatchAllDocsQuery.html">MatchAllDocsQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.NumericRangeFilterBuilder.html">NumericRangeFilterBuilder</a></h4> |
| <section><p>Creates a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>. The table below specifies the required |
| attributes and the defaults if optional attributes are omitted. For more |
| detail on what each of the attributes actually do, consult the documentation |
| for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a>: |
| <table><thead><tr><th>Attribute nameValuesRequiredDefault</th><th></th></tr></thead><tbody><tr><td>fieldNameStringYesN/A</td><td></td></tr><tr><td>lowerTermSpecified by <code>type</code>YesN/A</td><td></td></tr><tr><td>upperTermSpecified by <code>type</code>YesN/A</td><td></td></tr><tr><td>typeint, long, float, doubleNoint</td><td></td></tr><tr><td>includeLowertrue, falseNotrue</td><td></td></tr><tr><td>includeUppertrue, falseNotrue</td><td></td></tr><tr><td>precisionStepintNo4</td><td></td></tr></tbody></table> |
| <p> |
| If an error occurs parsing the supplied <code>lowerTerm</code> or |
| <code>upperTerm</code> into the numeric type specified by <code>type</code>, then the |
| error will be silently ignored and the resulting filter will not match any |
| documents.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.NumericRangeQueryBuilder.html">NumericRangeQueryBuilder</a></h4> |
| <section><p>Creates a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.NumericRangeQuery.html">NumericRangeQuery</a>. The table below specifies the required |
| attributes and the defaults if optional attributes are omitted. For more |
| detail on what each of the attributes actually do, consult the documentation |
| for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.NumericRangeQuery.html">NumericRangeQuery</a>: |
| <table><thead><tr><th>Attribute nameValuesRequiredDefault</th><th></th></tr></thead><tbody><tr><td>fieldNameStringYesN/A</td><td></td></tr><tr><td>lowerTermSpecified by <code>type</code>YesN/A</td><td></td></tr><tr><td>upperTermSpecified by <code>type</code>YesN/A</td><td></td></tr><tr><td>typeint, long, float, doubleNoint</td><td></td></tr><tr><td>includeLowertrue, falseNotrue</td><td></td></tr><tr><td>includeUppertrue, falseNotrue</td><td></td></tr><tr><td>precisionStepintNo4</td><td></td></tr></tbody></table> |
| <p> |
| A <a class="xref" href="Lucene.Net.QueryParsers.Xml.ParserException.html">ParserException</a> will be thrown if an error occurs parsing the |
| supplied <code>lowerTerm</code> or <code>upperTerm</code> into the numeric type |
| specified by <code>type</code>.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.RangeFilterBuilder.html">RangeFilterBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.TermRangeFilter.html">TermRangeFilter</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanBuilderBase.html">SpanBuilderBase</a></h4> |
| <section><p>Base class for building <span class="xref">Lucene.Net.Search.Spans.SpanQuery</span>s</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanFirstBuilder.html">SpanFirstBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Spans.SpanFirstQuery.html">SpanFirstQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanNearBuilder.html">SpanNearBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Spans.SpanNearQuery.html">SpanNearQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanNotBuilder.html">SpanNotBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Spans.SpanNotQuery.html">SpanNotQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanOrBuilder.html">SpanOrBuilder</a></h4> |
| <section><p>Builder for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Spans.SpanOrQuery.html">SpanOrQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanOrTermsBuilder.html">SpanOrTermsBuilder</a></h4> |
| <section><p>Builder that analyzes the text into a <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.Spans.SpanOrQuery.html">SpanOrQuery</a></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanQueryBuilderFactory.html">SpanQueryBuilderFactory</a></h4> |
| <section><p>Factory for <a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.ISpanQueryBuilder.html">ISpanQueryBuilder</a>s</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.SpanTermBuilder.html">SpanTermBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Search.Spans.SpanTermQuery</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.TermQueryBuilder.html">TermQueryBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Search.TermQuery</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.TermsFilterBuilder.html">TermsFilterBuilder</a></h4> |
| <section><p>Builder for <span class="xref">Lucene.Net.Queries.TermsFilter</span></p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.TermsQueryBuilder.html">TermsQueryBuilder</a></h4> |
| <section><p>Builds a <span class="xref">Lucene.Net.Search.BooleanQuery</span> from all of the terms found in the XML element using the choice of analyzer</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.UserInputQueryBuilder.html">UserInputQueryBuilder</a></h4> |
| <section><p><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.UserInputQueryBuilder.html">UserInputQueryBuilder</a> uses 1 of 2 strategies for thread-safe parsing: |
| 1) Synchronizing access to "Parse" calls on a previously supplied <a class="xref" href="Lucene.Net.QueryParsers.Classic.QueryParser.html">QueryParser</a> |
| or.. |
| 2) creating a new <a class="xref" href="Lucene.Net.QueryParsers.Classic.QueryParser.html">QueryParser</a> object for each parse request</p> |
| </section> |
| <h3 id="interfaces">Interfaces |
| </h3> |
| <h4><a class="xref" href="Lucene.Net.QueryParsers.Xml.Builders.ISpanQueryBuilder.html">ISpanQueryBuilder</a></h4> |
| <section><p>Interface for retrieving a <span class="xref">Lucene.Net.Search.Spans.SpanQuery</span></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/Xml/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> |
