Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_filtered_term_enum.html
blob: f3f1fb488ae78c332c339ebd5f0fba99a12cf3a3 [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.FilteredTermEnum 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="class_lucene_1_1_net_1_1_search_1_1_filtered_term_enum.html">FilteredTermEnum</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_filtered_term_enum-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.FilteredTermEnum Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract class for enumerating a subset of all terms. Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it.
<a href="class_lucene_1_1_net_1_1_search_1_1_filtered_term_enum.html#details">More...</a></p>
<p>Inherits TermEnum.</p>
<p>Inherited by <a class="el" href="class_contrib_1_1_regex_1_1_regex_term_enum.html">Contrib.Regex.RegexTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_fuzzy_term_enum.html">Lucene.Net.Search.FuzzyTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_prefix_term_enum.html">Lucene.Net.Search.PrefixTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_single_term_enum.html">Lucene.Net.Search.SingleTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_term_enum.html">Lucene.Net.Search.TermRangeTermEnum</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_wildcard_term_enum.html">Lucene.Net.Search.WildcardTermEnum</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:a41d6598579fb711d4a971de901383496"><td class="memItemLeft" align="right" valign="top">abstract float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_term_enum.html#a41d6598579fb711d4a971de901383496">Difference</a> ()</td></tr>
<tr class="memdesc:a41d6598579fb711d4a971de901383496"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality measure on the term <a href="#a41d6598579fb711d4a971de901383496"></a><br/></td></tr>
<tr class="separator:a41d6598579fb711d4a971de901383496"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc3944566e2ea67215cb6443b2907033"><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_filtered_term_enum.html#afc3944566e2ea67215cb6443b2907033">EndEnum</a> ()</td></tr>
<tr class="memdesc:afc3944566e2ea67215cb6443b2907033"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicates the end of the enumeration has been reached <a href="#afc3944566e2ea67215cb6443b2907033"></a><br/></td></tr>
<tr class="separator:afc3944566e2ea67215cb6443b2907033"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbe5c7994a87bc31447f30332d2bc425"><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_filtered_term_enum.html#afbe5c7994a87bc31447f30332d2bc425">DocFreq</a> ()</td></tr>
<tr class="memdesc:afbe5c7994a87bc31447f30332d2bc425"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated. <a href="#afbe5c7994a87bc31447f30332d2bc425"></a><br/></td></tr>
<tr class="separator:afbe5c7994a87bc31447f30332d2bc425"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4bfec678e04824c242c337bf5e9419bc"><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_filtered_term_enum.html#a4bfec678e04824c242c337bf5e9419bc">Next</a> ()</td></tr>
<tr class="memdesc:a4bfec678e04824c242c337bf5e9419bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increments the enumeration to the next element. True if one exists. <a href="#a4bfec678e04824c242c337bf5e9419bc"></a><br/></td></tr>
<tr class="separator:a4bfec678e04824c242c337bf5e9419bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a50ee951d75ce03d68cc553ad8a818a23"><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_filtered_term_enum.html#a50ee951d75ce03d68cc553ad8a818a23">FilteredTermEnum</a> ()</td></tr>
<tr class="separator:a50ee951d75ce03d68cc553ad8a818a23"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80f2180ad539d44b1459191d61300d1a"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_term_enum.html#a80f2180ad539d44b1459191d61300d1a">Dispose</a> (bool disposing)</td></tr>
<tr class="separator:a80f2180ad539d44b1459191d61300d1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ade48f20cda1d3cfafb5f16c92eb71dda"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_term_enum.html#ade48f20cda1d3cfafb5f16c92eb71dda">Term</a><code> [get]</code></td></tr>
<tr class="memdesc:ade48f20cda1d3cfafb5f16c92eb71dda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated. <a href="#ade48f20cda1d3cfafb5f16c92eb71dda"></a><br/></td></tr>
<tr class="separator:ade48f20cda1d3cfafb5f16c92eb71dda"><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>Abstract class for enumerating a subset of all terms. </p>
<p>Term enumerations are always ordered by Term.compareTo(). Each term in the enumeration is greater than all that precede it. </p>
<p>Definition at line <a class="el" href="_filtered_term_enum_8cs_source.html#l00030">30</a> of file <a class="el" href="_filtered_term_enum_8cs_source.html">FilteredTermEnum.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a50ee951d75ce03d68cc553ad8a818a23"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.FilteredTermEnum.FilteredTermEnum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_filtered_term_enum_8cs_source.html#l00038">38</a> of file <a class="el" href="_filtered_term_enum_8cs_source.html">FilteredTermEnum.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a41d6598579fb711d4a971de901383496"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract float Lucene.Net.Search.FilteredTermEnum.Difference </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>Equality measure on the term </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_fuzzy_term_enum.html#a6ff05fcbb96c2d3bd5568e9069c87741">Lucene.Net.Search.FuzzyTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_term_enum.html#a54ff13fa008b60e7c9ee04d8ea7d4138">Lucene.Net.Search.TermRangeTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_wildcard_term_enum.html#a2d9f0655b60e03a0e357e1b5be5122c3">Lucene.Net.Search.WildcardTermEnum</a>, <a class="el" href="class_contrib_1_1_regex_1_1_regex_term_enum.html#a1acaaa57b6b7af7ca2b48e0bf707d87e">Contrib.Regex.RegexTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_single_term_enum.html#ac7cdc6b28baa8db3c32a5d24dc78647d">Lucene.Net.Search.SingleTermEnum</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_prefix_term_enum.html#a4cfe169f75d4edfaebdabd9cc3fbec5d">Lucene.Net.Search.PrefixTermEnum</a>.</p>
</div>
</div>
<a class="anchor" id="a80f2180ad539d44b1459191d61300d1a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Search.FilteredTermEnum.Dispose </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>disposing</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_filtered_term_enum_8cs_source.html#l00112">112</a> of file <a class="el" href="_filtered_term_enum_8cs_source.html">FilteredTermEnum.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afbe5c7994a87bc31447f30332d2bc425"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override int Lucene.Net.Search.FilteredTermEnum.DocFreq </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the docFreq of the current Term in the enumeration. Returns -1 if no Term matches or all terms have been enumerated. </p>
<p>Definition at line <a class="el" href="_filtered_term_enum_8cs_source.html#l00070">70</a> of file <a class="el" href="_filtered_term_enum_8cs_source.html">FilteredTermEnum.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afc3944566e2ea67215cb6443b2907033"></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.FilteredTermEnum.EndEnum </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>Indicates the end of the enumeration has been reached </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_fuzzy_term_enum.html#a35b90d54e3ed942ca2608130d7ce478d">Lucene.Net.Search.FuzzyTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_term_enum.html#a2933fcc69df127e3d494a01ae458975d">Lucene.Net.Search.TermRangeTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_wildcard_term_enum.html#a7760059137ac9b577e4caca1a4705411">Lucene.Net.Search.WildcardTermEnum</a>, <a class="el" href="class_contrib_1_1_regex_1_1_regex_term_enum.html#ae0c31a19966480d7334d25481fbad4fb">Contrib.Regex.RegexTermEnum</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_single_term_enum.html#aa80a38b5f33f6c8f6ced0bf1cfde4e7d">Lucene.Net.Search.SingleTermEnum</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_prefix_term_enum.html#a8d3cda498ab37bc5ae2a7ae951519af0">Lucene.Net.Search.PrefixTermEnum</a>.</p>
</div>
</div>
<a class="anchor" id="a4bfec678e04824c242c337bf5e9419bc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Search.FilteredTermEnum.Next </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Increments the enumeration to the next element. True if one exists. </p>
<p>Definition at line <a class="el" href="_filtered_term_enum_8cs_source.html#l00079">79</a> of file <a class="el" href="_filtered_term_enum_8cs_source.html">FilteredTermEnum.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ade48f20cda1d3cfafb5f16c92eb71dda"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override <a class="el" href="_more_like_this_8cs.html#a8797eb30ce21b31829d3e3a43a20e3b9">Term</a> Lucene.Net.Search.FilteredTermEnum.Term</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the current Term in the enumeration. Returns null if no Term matches or all terms have been enumerated. </p>
<p>Definition at line <a class="el" href="_filtered_term_enum_8cs_source.html#l00108">108</a> of file <a class="el" href="_filtered_term_enum_8cs_source.html">FilteredTermEnum.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Search/<a class="el" href="_filtered_term_enum_8cs_source.html">FilteredTermEnum.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:57 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>