blob: 8f4b26b74cfcd12e44e523468acb1b47bec83aac [file] [log] [blame]
<!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.Spans 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_spans.html">Spans</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Spans.Spans Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Expert: an enumeration of span matches. Used to implement span searching. Each span represents a range of term positions within a document. Matches are enumerated in order, by increasing document number, within that by increasing start position and finally by increasing end position.
<a href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_spans.html#details">More...</a></p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html">Lucene.Net.Search.Spans.NearSpansOrdered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html">Lucene.Net.Search.Spans.NearSpansUnordered</a>, Lucene.Net.Search.Spans.NearSpansUnordered.SpansCell, Lucene.Net.Search.Spans.SpanFirstQuery.AnonymousClassSpans, Lucene.Net.Search.Spans.SpanNotQuery.AnonymousClassSpans, Lucene.Net.Search.Spans.SpanOrQuery.AnonymousClassSpans, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html">Lucene.Net.Search.Spans.TermSpans</a>.</p>
<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:ac0b2eadf3f45f2d2df28ebb3d4ae05f9"><td class="memItemLeft" align="right" valign="top">abstract 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_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9">Next</a> ()</td></tr>
<tr class="memdesc:ac0b2eadf3f45f2d2df28ebb3d4ae05f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Move to the next match, returning true iff any such exists. <a href="#ac0b2eadf3f45f2d2df28ebb3d4ae05f9"></a><br/></td></tr>
<tr class="separator:ac0b2eadf3f45f2d2df28ebb3d4ae05f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a122cfabd2c1398c1010f35ec8232a552"><td class="memItemLeft" align="right" valign="top">abstract 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_spans.html#a122cfabd2c1398c1010f35ec8232a552">SkipTo</a> (int target)</td></tr>
<tr class="memdesc:a122cfabd2c1398c1010f35ec8232a552"><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="#a122cfabd2c1398c1010f35ec8232a552"></a><br/></td></tr>
<tr class="separator:a122cfabd2c1398c1010f35ec8232a552"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a51674bd6a0ad58587b30a76a6ed550ea"><td class="memItemLeft" align="right" valign="top">abstract 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_spans.html#a51674bd6a0ad58587b30a76a6ed550ea">Doc</a> ()</td></tr>
<tr class="memdesc:a51674bd6a0ad58587b30a76a6ed550ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the document number of the current match. Initially invalid. <a href="#a51674bd6a0ad58587b30a76a6ed550ea"></a><br/></td></tr>
<tr class="separator:a51674bd6a0ad58587b30a76a6ed550ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29d4939a4087a07a0789c5970dc6e38e"><td class="memItemLeft" align="right" valign="top">abstract 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_spans.html#a29d4939a4087a07a0789c5970dc6e38e">Start</a> ()</td></tr>
<tr class="memdesc:a29d4939a4087a07a0789c5970dc6e38e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the start position of the current match. Initially invalid. <a href="#a29d4939a4087a07a0789c5970dc6e38e"></a><br/></td></tr>
<tr class="separator:a29d4939a4087a07a0789c5970dc6e38e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26fb994fba6afc5a5c065632631106f7"><td class="memItemLeft" align="right" valign="top">abstract 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_spans.html#a26fb994fba6afc5a5c065632631106f7">End</a> ()</td></tr>
<tr class="memdesc:a26fb994fba6afc5a5c065632631106f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the end position of the current match. Initially invalid. <a href="#a26fb994fba6afc5a5c065632631106f7"></a><br/></td></tr>
<tr class="separator:a26fb994fba6afc5a5c065632631106f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af53d53f6130b7c91d98a6d29b7636aba"><td class="memItemLeft" align="right" valign="top">abstract 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_spans.html#af53d53f6130b7c91d98a6d29b7636aba">GetPayload</a> ()</td></tr>
<tr class="memdesc:af53d53f6130b7c91d98a6d29b7636aba"><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_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9" 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_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9" 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="#af53d53f6130b7c91d98a6d29b7636aba"></a><br/></td></tr>
<tr class="separator:af53d53f6130b7c91d98a6d29b7636aba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31b1b3bd90fa79d3367a084165a4b94e"><td class="memItemLeft" align="right" valign="top">abstract 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_spans.html#a31b1b3bd90fa79d3367a084165a4b94e">IsPayloadAvailable</a> ()</td></tr>
<tr class="memdesc:a31b1b3bd90fa79d3367a084165a4b94e"><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_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9" title="Move to the next match, returning true iff any such exists. ">Next()</a>. <a href="#a31b1b3bd90fa79d3367a084165a4b94e"></a><br/></td></tr>
<tr class="separator:a31b1b3bd90fa79d3367a084165a4b94e"><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>Expert: an enumeration of span matches. Used to implement span searching. Each span represents a range of term positions within a document. Matches are enumerated in order, by increasing document number, within that by increasing start position and finally by increasing end position. </p>
<p>Definition at line <a class="el" href="_spans_8cs_source.html#l00029">29</a> of file <a class="el" href="_spans_8cs_source.html">Spans.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a51674bd6a0ad58587b30a76a6ed550ea"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.Spans.Spans.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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the document number of the current match. Initially invalid. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html#a8321d8fd00232cec7e42a4ce5e5016bf">Lucene.Net.Search.Spans.NearSpansUnordered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#aac4a019f35117cc68fa5aa5ddc3ebddd">Lucene.Net.Search.Spans.NearSpansOrdered</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html#a52505c7f0aeeb6561da7c2b30a9d9fbc">Lucene.Net.Search.Spans.TermSpans</a>.</p>
</div>
</div>
<a class="anchor" id="a26fb994fba6afc5a5c065632631106f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.Spans.Spans.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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the end position of the current match. Initially invalid. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html#acdff265150acef601658dda81c33d570">Lucene.Net.Search.Spans.NearSpansUnordered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a9d0646d68949b8a4186221166fcd5c47">Lucene.Net.Search.Spans.NearSpansOrdered</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html#a98a4e51e554a4d4ecddb78fac0093e97">Lucene.Net.Search.Spans.TermSpans</a>.</p>
</div>
</div>
<a class="anchor" id="af53d53f6130b7c91d98a6d29b7636aba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract ICollection&lt;byte[]&gt; Lucene.Net.Search.Spans.Spans.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">pure 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_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9" 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_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9" 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html#ac83da0da111f0d13f346e294d28b315c">Lucene.Net.Search.Spans.NearSpansUnordered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a76f782671fad55d42c1963bc094a39f0">Lucene.Net.Search.Spans.NearSpansOrdered</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html#ac39fd2cef1afc2b9c5039cdb73bb4700">Lucene.Net.Search.Spans.TermSpans</a>.</p>
</div>
</div>
<a class="anchor" id="a31b1b3bd90fa79d3367a084165a4b94e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract bool Lucene.Net.Search.Spans.Spans.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">pure 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_spans.html#ac0b2eadf3f45f2d2df28ebb3d4ae05f9" 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html#aa0bbf9121c671c4c18af3fdf8b38f77a">Lucene.Net.Search.Spans.NearSpansUnordered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a3d0265f498e5974ac2a7e02ff2c8b248">Lucene.Net.Search.Spans.NearSpansOrdered</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html#a62747143c375acea2eb5f15d890931ee">Lucene.Net.Search.Spans.TermSpans</a>.</p>
</div>
</div>
<a class="anchor" id="ac0b2eadf3f45f2d2df28ebb3d4ae05f9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract bool Lucene.Net.Search.Spans.Spans.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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Move to the next match, returning true iff any such exists. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html#a4e58c95b8041c87d3995b27aff360bcb">Lucene.Net.Search.Spans.NearSpansUnordered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a17dc5f22f56c19772e7998dffcd39aa7">Lucene.Net.Search.Spans.NearSpansOrdered</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html#aa198f289bb61960605fdfa3554f7b828">Lucene.Net.Search.Spans.TermSpans</a>.</p>
</div>
</div>
<a class="anchor" id="a122cfabd2c1398c1010f35ec8232a552"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract bool Lucene.Net.Search.Spans.Spans.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">pure 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html#a7498c2370b41da1b5539e34af676bec4">Lucene.Net.Search.Spans.NearSpansUnordered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a2c6cebd872fe639f9d48aa8605125449">Lucene.Net.Search.Spans.NearSpansOrdered</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html#a4be76786e896c1d97cf604e2be96e456">Lucene.Net.Search.Spans.TermSpans</a>.</p>
</div>
</div>
<a class="anchor" id="a29d4939a4087a07a0789c5970dc6e38e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.Spans.Spans.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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the start position of the current match. Initially invalid. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_unordered.html#a07c0f5e15cf5c72fc1b80543c85c53e7">Lucene.Net.Search.Spans.NearSpansUnordered</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_near_spans_ordered.html#a518d39efbf71e4f555ea624c55c1689a">Lucene.Net.Search.Spans.NearSpansOrdered</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_term_spans.html#aaab9bfd5d0a3962fcce1edb6cfe52e6a">Lucene.Net.Search.Spans.TermSpans</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="_spans_8cs_source.html">Spans.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>