| <!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.TermsFilter 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_terms_filter.html">TermsFilter</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_terms_filter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Spatial.Util.TermsFilter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Constructs a filter for docs matching any of the terms added to this class. Unlike a RangeFilter this can be used for filtering on multiple terms that are not necessarily in a sequence. An example might be a collection of primary keys from a database query result or perhaps a choice of "category" labels picked by the end user. As a filter, this is much faster than the equivalent query (a BooleanQuery with many "should" TermQueries) |
| <a href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_filter.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html">Lucene.Net.Search.Filter</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:ab7f6198344b6a282b7fd8c7162dfb368"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_filter.html#ab7f6198344b6a282b7fd8c7162dfb368">AddTerm</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> term)</td></tr> |
| <tr class="memdesc:ab7f6198344b6a282b7fd8c7162dfb368"><td class="mdescLeft"> </td><td class="mdescRight">Adds a term to the list of acceptable terms <a href="#ab7f6198344b6a282b7fd8c7162dfb368"></a><br/></td></tr> |
| <tr class="separator:ab7f6198344b6a282b7fd8c7162dfb368"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a86e48d553a1a78c4b4ad066f9105d7fa"><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.html">DocIdSet</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_filter.html#a86e48d553a1a78c4b4ad066f9105d7fa">GetDocIdSet</a> (<a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader)</td></tr> |
| <tr class="memdesc:a86e48d553a1a78c4b4ad066f9105d7fa"><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#a86e48d553a1a78c4b4ad066f9105d7fa"></a><br/></td></tr> |
| <tr class="separator:a86e48d553a1a78c4b4ad066f9105d7fa"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ce40741e4ee53db34a62eef1dbe82c8"><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_terms_filter.html#a2ce40741e4ee53db34a62eef1dbe82c8">Equals</a> (object obj)</td></tr> |
| <tr class="separator:a2ce40741e4ee53db34a62eef1dbe82c8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:add639433ea18619f0e1c79a43c34cadc"><td class="memItemLeft" align="right" valign="top">override int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_terms_filter.html#add639433ea18619f0e1c79a43c34cadc">GetHashCode</a> ()</td></tr> |
| <tr class="separator:add639433ea18619f0e1c79a43c34cadc"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Constructs a filter for docs matching any of the terms added to this class. Unlike a RangeFilter this can be used for filtering on multiple terms that are not necessarily in a sequence. An example might be a collection of primary keys from a database query result or perhaps a choice of "category" labels picked by the end user. As a filter, this is much faster than the equivalent query (a BooleanQuery with many "should" TermQueries) </p> |
| |
| <p>Definition at line <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html#l00033">33</a> of file <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ab7f6198344b6a282b7fd8c7162dfb368"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Lucene.Net.Spatial.Util.TermsFilter.AddTerm </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html">Term</a> </td> |
| <td class="paramname"><em>term</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Adds a term to the list of acceptable terms </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">term</td><td></td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Definition at line <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html#l00041">41</a> of file <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a2ce40741e4ee53db34a62eef1dbe82c8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override bool Lucene.Net.Spatial.Util.TermsFilter.Equals </td> |
| <td>(</td> |
| <td class="paramtype">object </td> |
| <td class="paramname"><em>obj</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Definition at line <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html#l00084">84</a> of file <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a86e48d553a1a78c4b4ad066f9105d7fa"></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="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> Lucene.Net.Spatial.Util.TermsFilter.GetDocIdSet </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p></p> |
| <p>Creates a <a class="el" href="_sorted_v_int_list_8cs.html#a4245eee1c0c260a340820cfe67797b43">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 Filter.</p> |
| <p>Note: This method will be called once per segment in the index during searching. The returned <a class="el" href="_sorted_v_int_list_8cs.html#a4245eee1c0c260a340820cfe67797b43">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 DocIdSet 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 Filter. </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>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filter.html#a6acd9f9caec9c3a4adba5580593f76c7">Lucene.Net.Search.Filter</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html#l00046">46</a> of file <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html">TermsFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="add639433ea18619f0e1c79a43c34cadc"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Spatial.Util.TermsFilter.GetHashCode </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="_spatial_2_util_2_terms_filter_8cs_source.html#l00107">107</a> of file <a class="el" href="_spatial_2_util_2_terms_filter_8cs_source.html">TermsFilter.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="_spatial_2_util_2_terms_filter_8cs_source.html">TermsFilter.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> |
