| <!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.Search |
| | Apache Lucene.NET 4.8.0 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Namespace Lucene.Net.Search |
| | Apache Lucene.NET 4.8.0 Documentation "> |
| <meta name="generator" content="docfx 2.47.0.0"> |
| |
| <link rel="shortcut icon" href="../../logo/favicon.ico"> |
| <link rel="stylesheet" href="../../styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="../../styles/docfx.css"> |
| <link rel="stylesheet" href="../../styles/main.css"> |
| <meta property="docfx:navrel" content="../../toc.html"> |
| <meta property="docfx:tocrel" content="../toc.html"> |
| |
| <meta property="docfx:rel" content="../../"> |
| |
| </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="../../index.html"> |
| <img id="logo" class="svg" src="../../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" id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></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.Search"> |
| |
| <h1 id="Lucene_Net_Search" data-uid="Lucene.Net.Search" class="text-break">Namespace Lucene.Net.Search |
| </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>Support for testing search components. </p> |
| <p> The primary classes are: * <a class="xref" href="Lucene.Net.Search.QueryUtils.html">QueryUtils</a>: Useful methods for testing Query classes. * <a class="xref" href="Lucene.Net.Search.ShardSearchingTestBase.html">ShardSearchingTestBase</a>: Base class for simulating distributed search. </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.Search.AssertingBulkOutOfOrderScorer.html">AssertingBulkOutOfOrderScorer</a></h4> |
| <section><p>A crazy <a class="xref" href="../Lucene.Net/Lucene.Net.Search.BulkScorer.html">BulkScorer</a> that wraps another <a class="xref" href="../Lucene.Net/Lucene.Net.Search.BulkScorer.html">BulkScorer</a> |
| but shuffles the order of the collected documents.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.AssertingBulkScorer.html">AssertingBulkScorer</a></h4> |
| <section><p>Wraps a <a class="xref" href="../Lucene.Net/Lucene.Net.Search.Scorer.html">Scorer</a> with additional checks. </p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.AssertingCollector.html">AssertingCollector</a></h4> |
| <section><p>Wraps another <a class="xref" href="../Lucene.Net/Lucene.Net.Search.ICollector.html">ICollector</a> and checks that |
| <a class="xref" href="Lucene.Net.Search.AssertingCollector.html#Lucene_Net_Search_AssertingCollector_AcceptsDocsOutOfOrder">AcceptsDocsOutOfOrder</a> is respected.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.AssertingIndexSearcher.html">AssertingIndexSearcher</a></h4> |
| <section><p>Helper class that adds some extra checks to ensure correct |
| usage of <a class="xref" href="../Lucene.Net/Lucene.Net.Search.IndexSearcher.html">IndexSearcher</a> and <a class="xref" href="../Lucene.Net/Lucene.Net.Search.Weight.html">Weight</a>.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.AssertingQuery.html">AssertingQuery</a></h4> |
| <section><p>Assertion-enabled query. </p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.AssertingScorer.html">AssertingScorer</a></h4> |
| <section><p>Wraps a <a class="xref" href="../Lucene.Net/Lucene.Net.Search.Scorer.html">Scorer</a> with additional checks.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.CheckHits.html">CheckHits</a></h4> |
| <section><p>Utility class for asserting expected hits in tests.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.ExplanationAsserter.html">ExplanationAsserter</a></h4> |
| <section><p>Asserts that the score explanation for every document matching a |
| query corresponds with the true score. |
| <p> |
| NOTE: this HitCollector should only be used with the <a class="xref" href="../Lucene.Net/Lucene.Net.Search.Query.html">Query</a> and <a class="xref" href="../Lucene.Net/Lucene.Net.Search.IndexSearcher.html">IndexSearcher</a> |
| specified at when it is constructed.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.ExplanationAssertingSearcher.html">ExplanationAssertingSearcher</a></h4> |
| <section><p>An <a class="xref" href="../Lucene.Net/Lucene.Net.Search.IndexSearcher.html">IndexSearcher</a> that implicitly checks hte explanation of every match |
| whenever it executes a search.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.FCInvisibleMultiReader.html">FCInvisibleMultiReader</a></h4> |
| <section><p>This is a <a class="xref" href="../Lucene.Net/Lucene.Net.Index.MultiReader.html">MultiReader</a> that can be used for randomly wrapping other readers |
| without creating <a class="xref" href="../Lucene.Net/Lucene.Net.Search.FieldCache.html">FieldCache</a> insanity. |
| The trick is to use an opaque/fake cache key.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.QueryUtils.html">QueryUtils</a></h4> |
| <section><p>Utility class for sanity-checking queries.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.RandomSimilarityProvider.html">RandomSimilarityProvider</a></h4> |
| <section><p>Similarity implementation that randomizes Similarity implementations |
| per-field. |
| <p> |
| The choices are 'sticky', so the selected algorithm is always used |
| for the same field.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.SearchEquivalenceTestBase.html">SearchEquivalenceTestBase</a></h4> |
| <section><p>Simple base class for checking search equivalence. |
| Extend it, and write tests that create <a class="xref" href="Lucene.Net.Search.SearchEquivalenceTestBase.html#Lucene_Net_Search_SearchEquivalenceTestBase_RandomTerm">RandomTerm()</a>s |
| (all terms are single characters a-z), and use |
| <a class="xref" href="Lucene.Net.Search.SearchEquivalenceTestBase.html#Lucene_Net_Search_SearchEquivalenceTestBase_AssertSameSet_Lucene_Net_Search_Query_Lucene_Net_Search_Query_">AssertSameSet(Query, Query)</a> and |
| <a class="xref" href="Lucene.Net.Search.SearchEquivalenceTestBase.html#Lucene_Net_Search_SearchEquivalenceTestBase_AssertSubsetOf_Lucene_Net_Search_Query_Lucene_Net_Search_Query_">AssertSubsetOf(Query, Query)</a>.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.SearcherExpiredException.html">SearcherExpiredException</a></h4> |
| <section><p>Thrown when the lease for a searcher has expired.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.SetCollector.html">SetCollector</a></h4> |
| <section><p>Just collects document ids into a set.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.ShardSearchingTestBase.html">ShardSearchingTestBase</a></h4> |
| <section><p>Base test class for simulating distributed search across multiple shards.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.ShardSearchingTestBase.NodeState.html">ShardSearchingTestBase.NodeState</a></h4> |
| <section></section> |
| <h4><a class="xref" href="Lucene.Net.Search.ShardSearchingTestBase.NodeState.ShardIndexSearcher.html">ShardSearchingTestBase.NodeState.ShardIndexSearcher</a></h4> |
| <section><p>Matches docs in the local shard but scores based on |
| aggregated stats ("mock distributed scoring") from all |
| nodes.</p> |
| </section> |
| <h4><a class="xref" href="Lucene.Net.Search.ShardSearchingTestBase.SearcherAndVersion.html">ShardSearchingTestBase.SearcherAndVersion</a></h4> |
| <section><p>An <a class="xref" href="../Lucene.Net/Lucene.Net.Search.IndexSearcher.html">IndexSearcher</a> and associated version (lease)</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-beta00007/src/Lucene.Net.TestFramework/Search/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="../../styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="../../styles/docfx.js"></script> |
| <script type="text/javascript" src="../../styles/main.js"></script> |
| </body> |
| </html> |
