blob: 9c110bb255f348f090dc811bd440ca20be46ed29 [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 PayloadNearQuery
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PayloadNearQuery
| 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="core/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.Search.Payloads.PayloadNearQuery">
<h1 id="Lucene_Net_Search_Payloads_PayloadNearQuery" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery" class="text-break">Class PayloadNearQuery
</h1>
<div class="markdown level0 summary"><p>This class is very similar to
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html">SpanNearQuery</a> except that it factors
in the value of the payloads located at each of the positions where the
<a class="xref" href="Lucene.Net.Search.Spans.TermSpans.html">TermSpans</a> occurs.
<p>
NOTE: In order to take advantage of this with the default scoring implementation
(<a class="xref" href="Lucene.Net.Search.Similarities.DefaultSimilarity.html">DefaultSimilarity</a>), you must override <a class="xref" href="Lucene.Net.Search.Similarities.DefaultSimilarity.html#Lucene_Net_Search_Similarities_DefaultSimilarity_ScorePayload_System_Int32_System_Int32_System_Int32_Lucene_Net_Util_BytesRef_">ScorePayload(Int32, Int32, Int32, BytesRef)</a>,
which returns 1 by default.
<p>
Payload scores are aggregated using a pluggable <a class="xref" href="Lucene.Net.Search.Payloads.PayloadFunction.html">PayloadFunction</a>.</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"><a class="xref" href="Lucene.Net.Search.Query.html">Query</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.Spans.SpanQuery.html">SpanQuery</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html">SpanNearQuery</a></div>
<div class="level4"><span class="xref">PayloadNearQuery</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_m_clauses">SpanNearQuery.m_clauses</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_m_slop">SpanNearQuery.m_slop</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_m_inOrder">SpanNearQuery.m_inOrder</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_m_field">SpanNearQuery.m_field</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_GetClauses">SpanNearQuery.GetClauses()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_Slop">SpanNearQuery.Slop</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_IsInOrder">SpanNearQuery.IsInOrder</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_Field">SpanNearQuery.Field</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_ExtractTerms_System_Collections_Generic_ISet_Lucene_Net_Index_Term__">SpanNearQuery.ExtractTerms(ISet&lt;Term&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_GetSpans_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_System_Collections_Generic_IDictionary_Lucene_Net_Index_Term_Lucene_Net_Index_TermContext__">SpanNearQuery.GetSpans(AtomicReaderContext, IBits, IDictionary&lt;Term, TermContext&gt;)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_Rewrite_Lucene_Net_Index_IndexReader_">SpanNearQuery.Rewrite(IndexReader)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Query.html#Lucene_Net_Search_Query_Boost">Query.Boost</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Query.html#Lucene_Net_Search_Query_ToString">Query.ToString()</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</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>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Payloads.html">Lucene.Net.Search.Payloads</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Search_Payloads_PayloadNearQuery_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class PayloadNearQuery : SpanNearQuery</code></pre>
</div>
<h3 id="constructors">Constructors
</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_Search_Payloads_PayloadNearQuery__ctor_Lucene_Net_Search_Spans_SpanQuery___System_Int32_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.%23ctor(Lucene.Net.Search.Spans.SpanQuery%5B%5D%2CSystem.Int32%2CSystem.Boolean)%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/Search/Payloads/PayloadNearQuery.cs/#L55">View Source</a>
</span>
<a id="Lucene_Net_Search_Payloads_PayloadNearQuery__ctor_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.#ctor*"></a>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery__ctor_Lucene_Net_Search_Spans_SpanQuery___System_Int32_System_Boolean_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.#ctor(Lucene.Net.Search.Spans.SpanQuery[],System.Int32,System.Boolean)">PayloadNearQuery(SpanQuery[], Int32, Boolean)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PayloadNearQuery(SpanQuery[] clauses, int slop, bool inOrder)</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><a class="xref" href="Lucene.Net.Search.Spans.SpanQuery.html">SpanQuery</a>[]</td>
<td><span class="parametername">clauses</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">slop</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">inOrder</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_Search_Payloads_PayloadNearQuery__ctor_Lucene_Net_Search_Spans_SpanQuery___System_Int32_System_Boolean_Lucene_Net_Search_Payloads_PayloadFunction_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.%23ctor(Lucene.Net.Search.Spans.SpanQuery%5B%5D%2CSystem.Int32%2CSystem.Boolean%2CLucene.Net.Search.Payloads.PayloadFunction)%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/Search/Payloads/PayloadNearQuery.cs/#L60">View Source</a>
</span>
<a id="Lucene_Net_Search_Payloads_PayloadNearQuery__ctor_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.#ctor*"></a>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery__ctor_Lucene_Net_Search_Spans_SpanQuery___System_Int32_System_Boolean_Lucene_Net_Search_Payloads_PayloadFunction_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.#ctor(Lucene.Net.Search.Spans.SpanQuery[],System.Int32,System.Boolean,Lucene.Net.Search.Payloads.PayloadFunction)">PayloadNearQuery(SpanQuery[], Int32, Boolean, PayloadFunction)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public PayloadNearQuery(SpanQuery[] clauses, int slop, bool inOrder, PayloadFunction function)</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><a class="xref" href="Lucene.Net.Search.Spans.SpanQuery.html">SpanQuery</a>[]</td>
<td><span class="parametername">clauses</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">slop</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">inOrder</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Search.Payloads.PayloadFunction.html">PayloadFunction</a></td>
<td><span class="parametername">function</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</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_Search_Payloads_PayloadNearQuery_m_fieldName.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.m_fieldName%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/Search/Payloads/PayloadNearQuery.cs/#L52">View Source</a>
</span>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery_m_fieldName" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.m_fieldName">m_fieldName</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected string m_fieldName</code></pre>
</div>
<h5 class="fieldValue">Field Value</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_Search_Payloads_PayloadNearQuery_m_function.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.m_function%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/Search/Payloads/PayloadNearQuery.cs/#L53">View Source</a>
</span>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery_m_function" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.m_function">m_function</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected PayloadFunction m_function</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Search.Payloads.PayloadFunction.html">PayloadFunction</a></td>
<td></td>
</tr>
</tbody>
</table>
<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_Search_Payloads_PayloadNearQuery_Clone.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.Clone%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/Search/Payloads/PayloadNearQuery.cs/#L72">View Source</a>
</span>
<a id="Lucene_Net_Search_Payloads_PayloadNearQuery_Clone_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.Clone*"></a>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery_Clone" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.Clone">Clone()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override object Clone()</code></pre>
</div>
<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.Object</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_Clone">SpanNearQuery.Clone()</a></div>
<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_Search_Payloads_PayloadNearQuery_CreateWeight_Lucene_Net_Search_IndexSearcher_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.CreateWeight(Lucene.Net.Search.IndexSearcher)%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/Search/Payloads/PayloadNearQuery.cs/#L67">View Source</a>
</span>
<a id="Lucene_Net_Search_Payloads_PayloadNearQuery_CreateWeight_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.CreateWeight*"></a>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery_CreateWeight_Lucene_Net_Search_IndexSearcher_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.CreateWeight(Lucene.Net.Search.IndexSearcher)">CreateWeight(IndexSearcher)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override Weight CreateWeight(IndexSearcher searcher)</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><a class="xref" href="Lucene.Net.Search.IndexSearcher.html">IndexSearcher</a></td>
<td><span class="parametername">searcher</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><a class="xref" href="Lucene.Net.Search.Weight.html">Weight</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Spans.SpanQuery.html#Lucene_Net_Search_Spans_SpanQuery_CreateWeight_Lucene_Net_Search_IndexSearcher_">SpanQuery.CreateWeight(IndexSearcher)</a></div>
<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_Search_Payloads_PayloadNearQuery_Equals_System_Object_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.Equals(System.Object)%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/Search/Payloads/PayloadNearQuery.cs/#L119">View Source</a>
</span>
<a id="Lucene_Net_Search_Payloads_PayloadNearQuery_Equals_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.Equals*"></a>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery_Equals_System_Object_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.Equals(System.Object)">Equals(Object)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object obj)</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.Object</span></td>
<td><span class="parametername">obj</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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_Equals_System_Object_">SpanNearQuery.Equals(Object)</a></div>
<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_Search_Payloads_PayloadNearQuery_GetHashCode.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.GetHashCode%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/Search/Payloads/PayloadNearQuery.cs/#L110">View Source</a>
</span>
<a id="Lucene_Net_Search_Payloads_PayloadNearQuery_GetHashCode_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.GetHashCode*"></a>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery_GetHashCode" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.GetHashCode">GetHashCode()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
</div>
<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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_GetHashCode">SpanNearQuery.GetHashCode()</a></div>
<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_Search_Payloads_PayloadNearQuery_ToString_System_String_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery.ToString(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/Search/Payloads/PayloadNearQuery.cs/#L86">View Source</a>
</span>
<a id="Lucene_Net_Search_Payloads_PayloadNearQuery_ToString_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.ToString*"></a>
<h4 id="Lucene_Net_Search_Payloads_PayloadNearQuery_ToString_System_String_" data-uid="Lucene.Net.Search.Payloads.PayloadNearQuery.ToString(System.String)">ToString(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString(string field)</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">field</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>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Lucene.Net.Search.Spans.SpanNearQuery.html#Lucene_Net_Search_Spans_SpanNearQuery_ToString_System_String_">SpanNearQuery.ToString(String)</a></div>
<h3 id="seealso">See Also</h3>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Search.Similarities.Similarity.SimScorer.html#Lucene_Net_Search_Similarities_Similarity_SimScorer_ComputePayloadFactor_System_Int32_System_Int32_System_Int32_Lucene_Net_Util_BytesRef_">ComputePayloadFactor(Int32, Int32, Int32, BytesRef)</a></div>
</div>
</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_Search_Payloads_PayloadNearQuery.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Payloads.PayloadNearQuery%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/Search/Payloads/PayloadNearQuery.cs/#L50" 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>