docs/3.0.3/class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html - lucenenet-site - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.3"/>
 <title>Lucene.Net: Lucene.Net.Search.Spans.NearSpansOrdered Class Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/search.js"></script>
 <script type="text/javascript">
   $(document).ready(function() { searchBox.OnSelectItem(0); });
 </script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
   <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
   <td style="padding-left: 0.5em;">
    <div id="projectname">Lucene.Net
    &#160;<span id="projectnumber">3.0.3</span>
    </div>
    <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.8.3 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="Index.html"><span>Main&#160;Page</span></a></li>
       <li><a href="namespaces.html"><span>Packages</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
           <img id="MSearchSelect" src="search/mag_sel.png"
                onmouseover="return searchBox.OnSearchSelectShow()"
                onmouseout="return searchBox.OnSearchSelectHide()"
                alt=""/>
           <input type="text" id="MSearchField" value="Search" accesskey="S"
                onfocus="searchBox.OnSearchFieldFocus(true)"
                onblur="searchBox.OnSearchFieldFocus(false)"
                onkeyup="searchBox.OnSearchFieldChange(event)"/>
           </span><span class="right">
             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
           </span>
         </div>
       </li>
     </ul>
   </div>
   <div id="navrow2" class="tabs2">
     <ul class="tablist">
       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
     </ul>
   </div>
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <iframe src="javascript:void(0)" frameborder="0"
         name="MSearchResults" id="MSearchResults">
 </iframe>
 </div>

 <div id="nav-path" class="navpath">
   <ul>
 <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_spans.html">Spans</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html">NearSpansOrdered</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#nested-classes">Classes</a> &#124;
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">Lucene.Net.Search.Spans.NearSpansOrdered Class Reference</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html" title="Expert: an enumeration of span matches. Used to implement span searching. Each span represents a rang...">Spans</a> that is formed from the ordered subspans of a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html" title="Matches spans which are near one another. One can specify slop, the maximum number of intervening unm...">SpanNearQuery</a> where the subspans do not overlap and have a maximum slop between them. The formed spans only contains minimum slop matches.<br/>
  The matching slop is computed from the distance(s) between the non overlapping matching <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html" title="Expert: an enumeration of span matches. Used to implement span searching. Each span represents a rang...">Spans</a>.<br/>
  Successive matches are always formed from the successive <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html" title="Expert: an enumeration of span matches. Used to implement span searching. Each span represents a rang...">Spans</a> of the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html" title="Matches spans which are near one another. One can specify slop, the maximum number of intervening unm...">SpanNearQuery</a>. The formed spans may contain overlaps when the slop is at least 1. For example, when querying using <code>t1 t2 t3</code> with slop at least 1, the fragment: <code>t1 t2 t1 t3 t2 t3</code> matches twice: <code>t1 t2 .. t3 </code> <code> t1 .. t2 t3</code>
  <a href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#details">More...</a></p>

 <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html">Lucene.Net.Search.Spans.Spans</a>.</p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 Classes</h2></td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><b>AnonymousClassComparator</b></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:abb2afceb504d82742861d28eed7dbde0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#abb2afceb504d82742861d28eed7dbde0">NearSpansOrdered</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html">SpanNearQuery</a> spanNearQuery, <a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader)</td></tr>
 <tr class="separator:abb2afceb504d82742861d28eed7dbde0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4282d1179eff16a2c12f8a1ccaed1a15"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a4282d1179eff16a2c12f8a1ccaed1a15">NearSpansOrdered</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html">SpanNearQuery</a> spanNearQuery, <a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, bool collectPayloads)</td></tr>
 <tr class="separator:a4282d1179eff16a2c12f8a1ccaed1a15"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aac4a019f35117cc68fa5aa5ddc3ebddd"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#aac4a019f35117cc68fa5aa5ddc3ebddd">Doc</a> ()</td></tr>
 <tr class="memdesc:aac4a019f35117cc68fa5aa5ddc3ebddd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the document number of the current match. Initially invalid.  <a href="#aac4a019f35117cc68fa5aa5ddc3ebddd"></a><br/></td></tr>
 <tr class="separator:aac4a019f35117cc68fa5aa5ddc3ebddd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a518d39efbf71e4f555ea624c55c1689a"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a518d39efbf71e4f555ea624c55c1689a">Start</a> ()</td></tr>
 <tr class="memdesc:a518d39efbf71e4f555ea624c55c1689a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the start position of the current match. Initially invalid.  <a href="#a518d39efbf71e4f555ea624c55c1689a"></a><br/></td></tr>
 <tr class="separator:a518d39efbf71e4f555ea624c55c1689a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a9d0646d68949b8a4186221166fcd5c47"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a9d0646d68949b8a4186221166fcd5c47">End</a> ()</td></tr>
 <tr class="memdesc:a9d0646d68949b8a4186221166fcd5c47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the end position of the current match. Initially invalid.  <a href="#a9d0646d68949b8a4186221166fcd5c47"></a><br/></td></tr>
 <tr class="separator:a9d0646d68949b8a4186221166fcd5c47"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a7c36a065edd3a57a35d6194e938f9784"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html">Spans</a>[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a7c36a065edd3a57a35d6194e938f9784">GetSubSpans</a> ()</td></tr>
 <tr class="separator:a7c36a065edd3a57a35d6194e938f9784"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a76f782671fad55d42c1963bc094a39f0"><td class="memItemLeft" align="right" valign="top">override ICollection&lt; byte[]&gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a76f782671fad55d42c1963bc094a39f0">GetPayload</a> ()</td></tr>
 <tr class="memdesc:a76f782671fad55d42c1963bc094a39f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the payload data for the current span. This is invalid until <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7" title="Move to the next match, returning true iff any such exists. ">Next()</a> is called for the first time. This method must not be called more than once after each call of <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7" title="Move to the next match, returning true iff any such exists. ">Next()</a>. However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_query.html" title="Base class for span-based queries. ">SpanQuery</a> does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option.<br/>
   <a href="#a76f782671fad55d42c1963bc094a39f0"></a><br/></td></tr>
 <tr class="separator:a76f782671fad55d42c1963bc094a39f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a3d0265f498e5974ac2a7e02ff2c8b248"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a3d0265f498e5974ac2a7e02ff2c8b248">IsPayloadAvailable</a> ()</td></tr>
 <tr class="memdesc:a3d0265f498e5974ac2a7e02ff2c8b248"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if a payload can be loaded at this position. <a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_payloads.html">Payloads</a> can only be loaded once per call to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7" title="Move to the next match, returning true iff any such exists. ">Next()</a>.  <a href="#a3d0265f498e5974ac2a7e02ff2c8b248"></a><br/></td></tr>
 <tr class="separator:a3d0265f498e5974ac2a7e02ff2c8b248"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a17dc5f22f56c19772e7998dffcd39aa7"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7">Next</a> ()</td></tr>
 <tr class="memdesc:a17dc5f22f56c19772e7998dffcd39aa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move to the next match, returning true iff any such exists.  <a href="#a17dc5f22f56c19772e7998dffcd39aa7"></a><br/></td></tr>
 <tr class="separator:a17dc5f22f56c19772e7998dffcd39aa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2c6cebd872fe639f9d48aa8605125449"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a2c6cebd872fe639f9d48aa8605125449">SkipTo</a> (int target)</td></tr>
 <tr class="memdesc:a2c6cebd872fe639f9d48aa8605125449"><td class="mdescLeft">&#160;</td><td class="mdescRight">Skips to the first match beyond the current, whose document number is greater than or equal to <em>target</em>. Returns true iff there is such a match. Behaves as if written:  <a href="#a2c6cebd872fe639f9d48aa8605125449"></a><br/></td></tr>
 <tr class="separator:a2c6cebd872fe639f9d48aa8605125449"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0b43ece13e7840272e14b652f1d7a6a2"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a0b43ece13e7840272e14b652f1d7a6a2">ToString</a> ()</td></tr>
 <tr class="separator:a0b43ece13e7840272e14b652f1d7a6a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>A <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html" title="Expert: an enumeration of span matches. Used to implement span searching. Each span represents a rang...">Spans</a> that is formed from the ordered subspans of a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html" title="Matches spans which are near one another. One can specify slop, the maximum number of intervening unm...">SpanNearQuery</a> where the subspans do not overlap and have a maximum slop between them. </p>
 <p>The formed spans only contains minimum slop matches.<br/>
  The matching slop is computed from the distance(s) between the non overlapping matching <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html" title="Expert: an enumeration of span matches. Used to implement span searching. Each span represents a rang...">Spans</a>.<br/>
  Successive matches are always formed from the successive <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html" title="Expert: an enumeration of span matches. Used to implement span searching. Each span represents a rang...">Spans</a> of the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html" title="Matches spans which are near one another. One can specify slop, the maximum number of intervening unm...">SpanNearQuery</a>. </p>
 <p>The formed spans may contain overlaps when the slop is at least 1. For example, when querying using <code>t1 t2 t3</code> with slop at least 1, the fragment: <code>t1 t2 t1 t3 t2 t3</code> matches twice: <code>t1 t2 .. t3 </code> <code> t1 .. t2 t3</code> </p>
 <p>Expert: Only public for subclassing. Most implementations should not need this class </p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00047">47</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="abb2afceb504d82742861d28eed7dbde0"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">Lucene.Net.Search.Spans.NearSpansOrdered.NearSpansOrdered </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html">SpanNearQuery</a>&#160;</td>
           <td class="paramname"><em>spanNearQuery</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
           <td class="paramname"><em>reader</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00098">98</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a4282d1179eff16a2c12f8a1ccaed1a15"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">Lucene.Net.Search.Spans.NearSpansOrdered.NearSpansOrdered </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_near_query.html">SpanNearQuery</a>&#160;</td>
           <td class="paramname"><em>spanNearQuery</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
           <td class="paramname"><em>reader</em>, </td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
           <td class="paramtype">bool&#160;</td>
           <td class="paramname"><em>collectPayloads</em>&#160;</td>
         </tr>
         <tr>
           <td></td>
           <td>)</td>
           <td></td><td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00102">102</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a class="anchor" id="aac4a019f35117cc68fa5aa5ddc3ebddd"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override int Lucene.Net.Search.Spans.NearSpansOrdered.Doc </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Returns the document number of the current match. Initially invalid. </p>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#a51674bd6a0ad58587b30a76a6ed550ea">Lucene.Net.Search.Spans.Spans</a>.</p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00124">124</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a9d0646d68949b8a4186221166fcd5c47"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override int Lucene.Net.Search.Spans.NearSpansOrdered.End </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Returns the end position of the current match. Initially invalid. </p>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#a26fb994fba6afc5a5c065632631106f7">Lucene.Net.Search.Spans.Spans</a>.</p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00136">136</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a76f782671fad55d42c1963bc094a39f0"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override ICollection&lt;byte[]&gt; Lucene.Net.Search.Spans.NearSpansOrdered.GetPayload </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Returns the payload data for the current span. This is invalid until <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7" title="Move to the next match, returning true iff any such exists. ">Next()</a> is called for the first time. This method must not be called more than once after each call of <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7" title="Move to the next match, returning true iff any such exists. ">Next()</a>. However, most payloads are loaded lazily, so if the payload data for the current position is not needed, this method may not be called at all for performance reasons. An ordered <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_query.html" title="Base class for span-based queries. ">SpanQuery</a> does not lazy load, so if you have payloads in your index and you do not want ordered SpanNearQuerys to collect payloads, you can disable collection with a constructor option.<br/>
  </p>
 <p>Note that the return type is a collection, thus the ordering should not be relied upon. <br/>
  </p>
 <p>&lt;font color="#FF0000"&gt; WARNING: The status of the <b><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_payloads.html">Payloads</a></b> feature is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.&lt;/font&gt;</p>
 <dl class="section return"><dt>Returns</dt><dd>a List of byte arrays containing the data of this payload, otherwise null if isPayloadAvailable is false </dd></dl>
 <p>&lt;throws&gt; java.io.IOException &lt;/throws&gt; </p>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#af53d53f6130b7c91d98a6d29b7636aba">Lucene.Net.Search.Spans.Spans</a>.</p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00149">149</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a7c36a065edd3a57a35d6194e938f9784"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">virtual <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html">Spans</a> [] Lucene.Net.Search.Spans.NearSpansOrdered.GetSubSpans </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00141">141</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a3d0265f498e5974ac2a7e02ff2c8b248"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override bool Lucene.Net.Search.Spans.NearSpansOrdered.IsPayloadAvailable </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Checks if a payload can be loaded at this position. <a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_payloads.html">Payloads</a> can only be loaded once per call to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7" title="Move to the next match, returning true iff any such exists. ">Next()</a>. </p>
 <dl class="section return"><dt>Returns</dt><dd>true if there is a payload available at this position that can be loaded </dd></dl>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#a31b1b3bd90fa79d3367a084165a4b94e">Lucene.Net.Search.Spans.Spans</a>.</p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00156">156</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a17dc5f22f56c19772e7998dffcd39aa7"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override bool Lucene.Net.Search.Spans.NearSpansOrdered.Next </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Move to the next match, returning true iff any such exists. </p>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9">Lucene.Net.Search.Spans.Spans</a>.</p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00162">162</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a2c6cebd872fe639f9d48aa8605125449"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override bool Lucene.Net.Search.Spans.NearSpansOrdered.SkipTo </td>
           <td>(</td>
           <td class="paramtype">int&#160;</td>
           <td class="paramname"><em>target</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Skips to the first match beyond the current, whose document number is greater than or equal to <em>target</em>. Returns true iff there is such a match. Behaves as if written: </p>
 <p><code> boolean skipTo(int target) { do { if (!next()) return false; } while (target &gt; doc()); return true; } </code> Most implementations are considerably more efficient than that. </p>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#a122cfabd2c1398c1010f35ec8232a552">Lucene.Net.Search.Spans.Spans</a>.</p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00185">185</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a518d39efbf71e4f555ea624c55c1689a"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override int Lucene.Net.Search.Spans.NearSpansOrdered.Start </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Returns the start position of the current match. Initially invalid. </p>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#a29d4939a4087a07a0789c5970dc6e38e">Lucene.Net.Search.Spans.Spans</a>.</p>

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00130">130</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a0b43ece13e7840272e14b652f1d7a6a2"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">override System.String Lucene.Net.Search.Spans.NearSpansOrdered.ToString </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Definition at line <a class="el" href="_near_spans_ordered_8cs_source.html#l00431">431</a> of file <a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a>.</p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>core/Search/Spans/<a class="el" href="_near_spans_ordered_8cs_source.html">NearSpansOrdered.cs</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Thu Jan 3 2013 02:12:58 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.3
 </small></address>
 </body>
 </html>