| <!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.Spatial.Util.ValueSourceFilter.ValueSourceFilteredDocIdSet 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 |
|  <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 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 List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </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_spatial.html">Spatial</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_spatial_1_1_util.html">Util</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter.html">ValueSourceFilter</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter_1_1_value_source_filtered_doc_id_set.html">ValueSourceFilteredDocIdSet</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter_1_1_value_source_filtered_doc_id_set-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Spatial.Util.ValueSourceFilter.ValueSourceFilteredDocIdSet Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html">Lucene.Net.Search.FilteredDocIdSet</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:a34b42e0fc9093349a18045843e5ee8d0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter_1_1_value_source_filtered_doc_id_set.html#a34b42e0fc9093349a18045843e5ee8d0">ValueSourceFilteredDocIdSet</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> innerSet, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html">DocValues</a> values, <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter.html">ValueSourceFilter</a> caller)</td></tr> |
| <tr class="separator:a34b42e0fc9093349a18045843e5ee8d0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af3c45d76aaf81e40d9c7bea2e3e47ecd"><td class="memItemLeft" align="right" valign="top">override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter_1_1_value_source_filtered_doc_id_set.html#af3c45d76aaf81e40d9c7bea2e3e47ecd">Match</a> (int doc)</td></tr> |
| <tr class="memdesc:af3c45d76aaf81e40d9c7bea2e3e47ecd"><td class="mdescLeft"> </td><td class="mdescRight">Validation method to determine whether a docid should be in the result set. <a href="#af3c45d76aaf81e40d9c7bea2e3e47ecd"></a><br/></td></tr> |
| <tr class="separator:af3c45d76aaf81e40d9c7bea2e3e47ecd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html">Lucene.Net.Search.FilteredDocIdSet</a></td></tr> |
| <tr class="memitem:a3051443d399152b11f6fd4d513901a03 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html">DocIdSetIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html#a3051443d399152b11f6fd4d513901a03">Iterator</a> ()</td></tr> |
| <tr class="memdesc:a3051443d399152b11f6fd4d513901a03 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="mdescLeft"> </td><td class="mdescRight">Implementation of the contract to build a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html" title="This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore NO_MORE_DOCS is set to Int32.MaxValue in order to be used as a sentinel object. Implementations of this class are expected to consider int.MaxValue as an invalid value. ">DocIdSetIterator</a>. <a href="#a3051443d399152b11f6fd4d513901a03"></a><br/></td></tr> |
| <tr class="separator:a3051443d399152b11f6fd4d513901a03 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set')"><img src="closed.png" alt="-"/> Static Public Attributes inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">Lucene.Net.Search.DocIdSet</a></td></tr> |
| <tr class="memitem:a0954d462a5e3b7b8d1161d48d72ba391 inherit pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set"><td class="memItemLeft" align="right" valign="top">static readonly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html#a0954d462a5e3b7b8d1161d48d72ba391">EMPTY_DOCIDSET</a></td></tr> |
| <tr class="memdesc:a0954d462a5e3b7b8d1161d48d72ba391 inherit pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set"><td class="mdescLeft"> </td><td class="mdescRight">An empty <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html" title="A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide ac...">DocIdSet</a> instance for easy use, e.g. in Filters that hit no documents. <a href="#a0954d462a5e3b7b8d1161d48d72ba391"></a><br/></td></tr> |
| <tr class="separator:a0954d462a5e3b7b8d1161d48d72ba391 inherit pub_static_attribs_class_lucene_1_1_net_1_1_search_1_1_doc_id_set"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pro_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html">Lucene.Net.Search.FilteredDocIdSet</a></td></tr> |
| <tr class="memitem:a154793ccadd4fecf9a543308913ef36d inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html#a154793ccadd4fecf9a543308913ef36d">FilteredDocIdSet</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> innerSet)</td></tr> |
| <tr class="memdesc:a154793ccadd4fecf9a543308913ef36d inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a154793ccadd4fecf9a543308913ef36d"></a><br/></td></tr> |
| <tr class="separator:a154793ccadd4fecf9a543308913ef36d inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set')"><img src="closed.png" alt="-"/> Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html">Lucene.Net.Search.FilteredDocIdSet</a></td></tr> |
| <tr class="memitem:a6b96ca2812a85de74b9474508e2ce10f inherit properties_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="memItemLeft" align="right" valign="top">override bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html#a6b96ca2812a85de74b9474508e2ce10f">IsCacheable</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a6b96ca2812a85de74b9474508e2ce10f inherit properties_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="mdescLeft"> </td><td class="mdescRight">This <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html" title="A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide ac...">DocIdSet</a> implementation is cacheable if the inner set is cacheable. <a href="#a6b96ca2812a85de74b9474508e2ce10f"></a><br/></td></tr> |
| <tr class="separator:a6b96ca2812a85de74b9474508e2ce10f inherit properties_class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"> |
| <p>Definition at line <a class="el" href="_value_source_filter_8cs_source.html#l00053">53</a> of file <a class="el" href="_value_source_filter_8cs_source.html">ValueSourceFilter.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a34b42e0fc9093349a18045843e5ee8d0"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Spatial.Util.ValueSourceFilter.ValueSourceFilteredDocIdSet.ValueSourceFilteredDocIdSet </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> </td> |
| <td class="paramname"><em>innerSet</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html">DocValues</a> </td> |
| <td class="paramname"><em>values</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter.html">ValueSourceFilter</a> </td> |
| <td class="paramname"><em>caller</em> </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="_value_source_filter_8cs_source.html#l00058">58</a> of file <a class="el" href="_value_source_filter_8cs_source.html">ValueSourceFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="af3c45d76aaf81e40d9c7bea2e3e47ecd"></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.Spatial.Util.ValueSourceFilter.ValueSourceFilteredDocIdSet.Match </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>docid</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>Validation method to determine whether a docid should be in the result set.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">docid</td><td>docid to be tested </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>true if input docid should be in the result set, false otherwise. </dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html#a63bb60b136a97e414bfe0a5cb239804c">Lucene.Net.Search.FilteredDocIdSet</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_value_source_filter_8cs_source.html#l00065">65</a> of file <a class="el" href="_value_source_filter_8cs_source.html">ValueSourceFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>contrib/Spatial/Util/<a class="el" href="_value_source_filter_8cs_source.html">ValueSourceFilter.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:59 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |