| <!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.Filter 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_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Filter</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_search_1_1_filter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Filter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Abstract base class for restricting which documents may be returned during searching. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_filter.html#details">More...</a></p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_chained_filter.html">Lucene.Net.Analysis.ChainedFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_filter.html">Lucene.Net.Search.BooleanFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html">Lucene.Net.Search.CachingWrapperFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_duplicate_filter.html">Lucene.Net.Search.DuplicateFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_range_filter_3_01_t_01_4.html">Lucene.Net.Search.FieldCacheRangeFilter< T ></a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_terms_filter.html">Lucene.Net.Search.FieldCacheTermsFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4.html">Lucene.Net.Search.MultiTermQueryWrapperFilter< T ></a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query_wrapper_filter.html">Lucene.Net.Search.QueryWrapperFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_span_filter.html">Lucene.Net.Search.SpanFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_terms_filter.html">Lucene.Net.Search.TermsFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_prefix_1_1_recursive_prefix_tree_filter.html">Lucene.Net.Spatial.Prefix.RecursivePrefixTreeFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_filter.html">Lucene.Net.Spatial.Util.TermsFilter</a>, and <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_value_source_filter.html">Lucene.Net.Spatial.Util.ValueSourceFilter</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:a6acd9f9caec9c3a4adba5580593f76c7"><td class="memItemLeft" align="right" valign="top">abstract <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_filter.html#a6acd9f9caec9c3a4adba5580593f76c7">GetDocIdSet</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader)</td></tr> |
| <tr class="memdesc:a6acd9f9caec9c3a4adba5580593f76c7"><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#a6acd9f9caec9c3a4adba5580593f76c7"></a><br/></td></tr> |
| <tr class="separator:a6acd9f9caec9c3a4adba5580593f76c7"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Abstract base class for restricting which documents may be returned during searching.</p> |
| |
| <p>Definition at line <a class="el" href="_filter_8cs_source.html#l00028">28</a> of file <a class="el" href="_filter_8cs_source.html">Filter.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a6acd9f9caec9c3a4adba5580593f76c7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> Lucene.Net.Search.Filter.GetDocIdSet </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> </td> |
| <td class="paramname"><em>reader</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></p> |
| <p>Creates a <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> enumerating the documents that should be permitted in search results. <b>NOTE:</b> null can be returned if no documents are accepted by this <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html" title="Abstract base class for restricting which documents may be returned during searching.">Filter</a>.</p> |
| <p>Note: This method will be called once per segment in the index during searching. The returned <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> must refer to document IDs for that segment, not for the top-level reader.</p> |
| <p>/summary> </p> |
| <dl class="section return"><dt>Returns</dt><dd>a <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> that provides the documents which should be permitted or prohibited in search results. <b>NOTE:</b> null can be returned if no documents will be accepted by this <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html" title="Abstract base class for restricting which documents may be returned during searching.">Filter</a>. </dd></dl> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>A <a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> instance opened on the index currently searched on. Note, it is likely that the provided reader does not represent the whole underlying index i.e. if the index has more than one segment the given reader only represents a single segment. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="_filter_8cs.html#a673a4822c0bf5f5fdadb59f7ad92338c">DocIdBitSet</a></dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_range_filter_3_01_t_01_4.html#a4dc691f99442493ad21539213a061721">Lucene.Net.Search.FieldCacheRangeFilter< T ></a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html#a6331e109689ac5b8aafaf8cf0094f737">Lucene.Net.Search.CachingWrapperFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_terms_filter.html#a0da6373b91326e10ba978415ebddc898">Lucene.Net.Search.FieldCacheTermsFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4.html#a66444087efd0f4dfb8543d090d6a0299">Lucene.Net.Search.MultiTermQueryWrapperFilter< T ></a>, <a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_chained_filter.html#a8006778890081fda13a09ab4262f2ac5">Lucene.Net.Analysis.ChainedFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query_wrapper_filter.html#aa60ea4910f680501adb0228512e6f4ed">Lucene.Net.Search.QueryWrapperFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_span_filter.html#a75aad539fc9cea6480741a4e608db038">Lucene.Net.Search.CachingSpanFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_duplicate_filter.html#a78f54e70ad16b1fcf38c0fc4428a6175">Lucene.Net.Search.DuplicateFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_filter.html#ac622ed26332d6ffb1b1e1215f53ef3f7">Lucene.Net.Search.BooleanFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_span_query_filter.html#a76c6fe7173d8a00b420716f9d4b72e91">Lucene.Net.Search.SpanQueryFilter</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_terms_filter.html#aa7eb768c6a4835a226520a6db07c5d85">Lucene.Net.Search.TermsFilter</a>, and <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_filter.html#a86e48d553a1a78c4b4ad066f9105d7fa">Lucene.Net.Spatial.Util.TermsFilter</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Search/<a class="el" href="_filter_8cs_source.html">Filter.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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
