| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class JoinUtil |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class JoinUtil |
| | Apache Lucene.NET 4.8.0-beta00011 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="join/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.Join.JoinUtil"> |
| |
| |
| <h1 id="Lucene_Net_Join_JoinUtil" data-uid="Lucene.Net.Join.JoinUtil" class="text-break">Class JoinUtil |
| </h1> |
| <div class="markdown level0 summary"><p>Utility for query time joining using <span class="xref">Lucene.Net.Join.TermsQuery</span> and <span class="xref">Lucene.Net.Join.TermsCollector</span>.</p> |
| <div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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">JoinUtil</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.Join.html">Lucene.Net.Join</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Join.dll</h6> |
| <h5 id="Lucene_Net_Join_JoinUtil_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class JoinUtil</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Join_JoinUtil_CreateJoinQuery_System_String_System_Boolean_System_String_Lucene_Net_Search_Query_Lucene_Net_Search_IndexSearcher_Lucene_Net_Join_ScoreMode_.md&value=---%0Auid%3A%20Lucene.Net.Join.JoinUtil.CreateJoinQuery(System.String%2CSystem.Boolean%2CSystem.String%2CLucene.Net.Search.Query%2CLucene.Net.Search.IndexSearcher%2CLucene.Net.Join.ScoreMode)%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_beta00011/src/Lucene.Net.Join/JoinUtil.cs/#L61">View Source</a> |
| </span> |
| <a id="Lucene_Net_Join_JoinUtil_CreateJoinQuery_" data-uid="Lucene.Net.Join.JoinUtil.CreateJoinQuery*"></a> |
| <h4 id="Lucene_Net_Join_JoinUtil_CreateJoinQuery_System_String_System_Boolean_System_String_Lucene_Net_Search_Query_Lucene_Net_Search_IndexSearcher_Lucene_Net_Join_ScoreMode_" data-uid="Lucene.Net.Join.JoinUtil.CreateJoinQuery(System.String,System.Boolean,System.String,Lucene.Net.Search.Query,Lucene.Net.Search.IndexSearcher,Lucene.Net.Join.ScoreMode)">CreateJoinQuery(String, Boolean, String, Query, IndexSearcher, ScoreMode)</h4> |
| <div class="markdown level1 summary"><p>Method for query time joining. |
| <p> |
| Execute the returned query with a <span class="xref">Lucene.Net.Search.IndexSearcher</span> to retrieve all documents that have the same terms in the |
| to field that match with documents matching the specified <code data-dev-comment-type="paramref" class="paramref">fromQuery</code> and have the same terms in the from field. |
| <p> |
| In the case a single document relates to more than one document the <code data-dev-comment-type="paramref" class="paramref">multipleValuesPerDocument</code> option |
| should be set to true. When the <code data-dev-comment-type="paramref" class="paramref">multipleValuesPerDocument</code> is set to <code>true</code> only the |
| the score from the first encountered join value originating from the 'from' side is mapped into the 'to' side. |
| Even in the case when a second join value related to a specific document yields a higher score. Obviously this |
| doesn't apply in the case that <a class="xref" href="Lucene.Net.Join.ScoreMode.html#Lucene_Net_Join_ScoreMode_None">None</a> is used, since no scores are computed at all. |
| <p> |
| Memory considerations: During joining all unique join values are kept in memory. On top of that when the <code data-dev-comment-type="paramref" class="paramref">scoreMode</code> |
| isn't set to <a class="xref" href="Lucene.Net.Join.ScoreMode.html#Lucene_Net_Join_ScoreMode_None">None</a> a float value per unique join value is kept in memory for computing scores. |
| When <code data-dev-comment-type="paramref" class="paramref">scoreMode</code> is set to <a class="xref" href="Lucene.Net.Join.ScoreMode.html#Lucene_Net_Join_ScoreMode_Avg">Avg</a> also an additional integer value is kept in memory per unique |
| join value.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static Query CreateJoinQuery(string fromField, bool multipleValuesPerDocument, string toField, Query fromQuery, IndexSearcher fromSearcher, ScoreMode scoreMode)</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">fromField</span></td> |
| <td><p>The from field to join from </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">multipleValuesPerDocument</span></td> |
| <td><p>Whether the from field has multiple terms per document </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">toField</span></td> |
| <td><p>The to field to join to </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.Query</span></td> |
| <td><span class="parametername">fromQuery</span></td> |
| <td><p>The query to match documents on the from side </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Search.IndexSearcher</span></td> |
| <td><span class="parametername">fromSearcher</span></td> |
| <td><p>The searcher that executed the specified <code data-dev-comment-type="paramref" class="paramref">fromQuery</code> </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Join.ScoreMode.html">ScoreMode</a></td> |
| <td><span class="parametername">scoreMode</span></td> |
| <td><p>Instructs how scores from the <code data-dev-comment-type="paramref" class="paramref">fromQuery</code> are mapped to the returned query </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><p>A <span class="xref">Lucene.Net.Search.Query</span> instance that can be used to join documents based on the terms in the from and to field</p> |
| </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.IO.IOException</span></td> |
| <td><p>If I/O related errors occur </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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Join_JoinUtil.md&value=---%0Auid%3A%20Lucene.Net.Join.JoinUtil%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_beta00011/src/Lucene.Net.Join/JoinUtil.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 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> |