| <!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.TermRangeFilter 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_term_range_filter.html">TermRangeFilter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.TermRangeFilter Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>A <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> that restricts search results to a range of values in a given field. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#details">More...</a></p> |
| |
| <p>Inherits <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>.</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:ae308c6ce62fa753b84563fc323e0943b"><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_term_range_filter.html#ae308c6ce62fa753b84563fc323e0943b">TermRangeFilter</a> (System.String fieldName, System.String lowerTerm, System.String upperTerm, bool includeLower, bool includeUpper)</td></tr> |
| <tr class="memdesc:ae308c6ce62fa753b84563fc323e0943b"><td class="mdescLeft"> </td><td class="mdescRight">lowerTerm is null and includeLower is true (similar for upperTerm and includeUpper) <a href="#ae308c6ce62fa753b84563fc323e0943b"></a><br/></td></tr> |
| <tr class="separator:ae308c6ce62fa753b84563fc323e0943b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8febbf0e16db18c313834ba7da8d7284"><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_term_range_filter.html#a8febbf0e16db18c313834ba7da8d7284">TermRangeFilter</a> (System.String fieldName, System.String lowerTerm, System.String upperTerm, bool includeLower, bool includeUpper, System.Globalization.CompareInfo collator)</td></tr> |
| <tr class="memdesc:a8febbf0e16db18c313834ba7da8d7284"><td class="mdescLeft"> </td><td class="mdescRight"><b>WARNING:</b> Using this constructor and supplying a non-null value in the <code>collator</code> parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined. Depending on the number of index Terms in this Field, the operation could be very slow. <a href="#a8febbf0e16db18c313834ba7da8d7284"></a><br/></td></tr> |
| <tr class="separator:a8febbf0e16db18c313834ba7da8d7284"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <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></td></tr> |
| <tr class="memitem:acf5ba76c860338e3fd2a2d28512979e8 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">override System.String </td><td class="memItemRight" valign="bottom"><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#acf5ba76c860338e3fd2a2d28512979e8">ToString</a> ()</td></tr> |
| <tr class="separator:acf5ba76c860338e3fd2a2d28512979e8 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2ab4767f0e8a982b97f47e601a643df9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><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_multi_term_query_wrapper_filter_3_01_t_01_4.html#a2ab4767f0e8a982b97f47e601a643df9">Equals</a> (System.Object o)</td></tr> |
| <tr class="separator:a2ab4767f0e8a982b97f47e601a643df9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac653a96cccc4fc5497435d68cd42fcc4 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><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_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4.html#ac653a96cccc4fc5497435d68cd42fcc4">GetHashCode</a> ()</td></tr> |
| <tr class="separator:ac653a96cccc4fc5497435d68cd42fcc4 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8eca53fc227cab0d2b6f1113a9d7715f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><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#a8eca53fc227cab0d2b6f1113a9d7715f">ClearTotalNumberOfTerms</a> ()</td></tr> |
| <tr class="memdesc:a8eca53fc227cab0d2b6f1113a9d7715f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="mdescLeft"> </td><td class="mdescRight">Expert: Resets the counting of unique terms. Do this before executing the filter. <a href="#a8eca53fc227cab0d2b6f1113a9d7715f"></a><br/></td></tr> |
| <tr class="separator:a8eca53fc227cab0d2b6f1113a9d7715f inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a66444087efd0f4dfb8543d090d6a0299 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><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_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4.html#a66444087efd0f4dfb8543d090d6a0299">GetDocIdSet</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader)</td></tr> |
| <tr class="memdesc:a66444087efd0f4dfb8543d090d6a0299 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#a66444087efd0f4dfb8543d090d6a0299"></a><br/></td></tr> |
| <tr class="separator:a66444087efd0f4dfb8543d090d6a0299 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:af2c915620e3a3a52b583872323a4619a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html">TermRangeFilter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#af2c915620e3a3a52b583872323a4619a">Less</a> (System.String fieldName, System.String upperTerm)</td></tr> |
| <tr class="memdesc:af2c915620e3a3a52b583872323a4619a"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a filter for field <code>fieldName</code> matching less than or equal to <code>upperTerm</code>. <a href="#af2c915620e3a3a52b583872323a4619a"></a><br/></td></tr> |
| <tr class="separator:af2c915620e3a3a52b583872323a4619a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab06a736c8bebed8f95090629441ef110"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html">TermRangeFilter</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#ab06a736c8bebed8f95090629441ef110">More</a> (System.String fieldName, System.String lowerTerm)</td></tr> |
| <tr class="memdesc:ab06a736c8bebed8f95090629441ef110"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a filter for field <code>fieldName</code> matching greater than or equal to <code>lowerTerm</code>. <a href="#ab06a736c8bebed8f95090629441ef110"></a><br/></td></tr> |
| <tr class="separator:ab06a736c8bebed8f95090629441ef110"><td class="memSeparator" colspan="2"> </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:a3b472cfaf029c95dd1e35dd306a25f91"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#a3b472cfaf029c95dd1e35dd306a25f91">Field</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a3b472cfaf029c95dd1e35dd306a25f91"><td class="mdescLeft"> </td><td class="mdescRight">Returns the field name for this filter <a href="#a3b472cfaf029c95dd1e35dd306a25f91"></a><br/></td></tr> |
| <tr class="separator:a3b472cfaf029c95dd1e35dd306a25f91"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a35f68cf5d71bc40bcab8198b60b42e28"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#a35f68cf5d71bc40bcab8198b60b42e28">LowerTerm</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a35f68cf5d71bc40bcab8198b60b42e28"><td class="mdescLeft"> </td><td class="mdescRight">Returns the lower value of this range filter <a href="#a35f68cf5d71bc40bcab8198b60b42e28"></a><br/></td></tr> |
| <tr class="separator:a35f68cf5d71bc40bcab8198b60b42e28"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e397120faa0940fc70d2901ae1e2b4c"><td class="memItemLeft" align="right" valign="top">virtual string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#a4e397120faa0940fc70d2901ae1e2b4c">UpperTerm</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4e397120faa0940fc70d2901ae1e2b4c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the upper value of this range filter <a href="#a4e397120faa0940fc70d2901ae1e2b4c"></a><br/></td></tr> |
| <tr class="separator:a4e397120faa0940fc70d2901ae1e2b4c"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a1e975cbe82b1c48742283b9651994054"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#a1e975cbe82b1c48742283b9651994054">IncludesLower</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a1e975cbe82b1c48742283b9651994054"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the lower endpoint is inclusive <a href="#a1e975cbe82b1c48742283b9651994054"></a><br/></td></tr> |
| <tr class="separator:a1e975cbe82b1c48742283b9651994054"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a482233b5a0fed0500b158c78203b9670"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#a482233b5a0fed0500b158c78203b9670">IncludesUpper</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a482233b5a0fed0500b158c78203b9670"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the upper endpoint is inclusive <a href="#a482233b5a0fed0500b158c78203b9670"></a><br/></td></tr> |
| <tr class="separator:a482233b5a0fed0500b158c78203b9670"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af653e93577c3c842d6138091c1069e58"><td class="memItemLeft" align="right" valign="top">virtual CompareInfo </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html#af653e93577c3c842d6138091c1069e58">Collator</a><code> [get]</code></td></tr> |
| <tr class="memdesc:af653e93577c3c842d6138091c1069e58"><td class="mdescLeft"> </td><td class="mdescRight">Returns the collator used to determine range inclusion, if any. <a href="#af653e93577c3c842d6138091c1069e58"></a><br/></td></tr> |
| <tr class="separator:af653e93577c3c842d6138091c1069e58"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header properties_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4')"><img src="closed.png" alt="-"/> Properties inherited from <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></td></tr> |
| <tr class="memitem:a4ab989c719195e06e06247273bec2f46 inherit properties_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><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#a4ab989c719195e06e06247273bec2f46">TotalNumberOfTerms</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a4ab989c719195e06e06247273bec2f46 inherit properties_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="mdescLeft"> </td><td class="mdescRight">Expert: Return the number of unique terms visited during execution of the filter. If there are many of them, you may consider using another filter type or optimize your total term count in index. This method is not thread safe, be sure to only call it when no filter is running! If you re-use the same filter instance for another search, be sure to first reset the term counter with <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#a8eca53fc227cab0d2b6f1113a9d7715f" title="Expert: Resets the counting of unique terms. Do this before executing the filter. ...">ClearTotalNumberOfTerms</a>. <a href="#a4ab989c719195e06e06247273bec2f46"></a><br/></td></tr> |
| <tr class="separator:a4ab989c719195e06e06247273bec2f46 inherit properties_class_lucene_1_1_net_1_1_search_1_1_multi_term_query_wrapper_filter_3_01_t_01_4"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A <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> that restricts search results to a range of values in a given field. </p> |
| <p>This filter matches the documents looking for terms that fall into the supplied range according to String.CompareTo(String). It is not intended for numerical ranges, use NumericRangeFilter{T} instead.</p> |
| <p>If you construct a large number of range filters with different ranges but on the same field, FieldCacheRangeFilter may have significantly better performance. </p> |
| <p><since> 2.9 </since> </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00037">37</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="ae308c6ce62fa753b84563fc323e0943b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.TermRangeFilter.TermRangeFilter </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>lowerTerm</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>upperTerm</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>includeLower</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>includeUpper</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>lowerTerm is null and includeLower is true (similar for upperTerm and includeUpper) </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldName</td><td>The field this range applies to </td></tr> |
| <tr><td class="paramname">lowerTerm</td><td>The lower bound on this range </td></tr> |
| <tr><td class="paramname">upperTerm</td><td>The upper bound on this range </td></tr> |
| <tr><td class="paramname">includeLower</td><td>Does this range include the lower bound? </td></tr> |
| <tr><td class="paramname">includeUpper</td><td>Does this range include the upper bound? </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IllegalArgumentException if both terms are null or if </throws> </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00054">54</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a8febbf0e16db18c313834ba7da8d7284"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.TermRangeFilter.TermRangeFilter </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>lowerTerm</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>upperTerm</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>includeLower</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>includeUpper</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.Globalization.CompareInfo </td> |
| <td class="paramname"><em>collator</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p><b>WARNING:</b> Using this constructor and supplying a non-null value in the <code>collator</code> parameter will cause every single index Term in the Field referenced by lowerTerm and/or upperTerm to be examined. Depending on the number of index Terms in this Field, the operation could be very slow. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">fieldName</td><td></td></tr> |
| <tr><td class="paramname">lowerTerm</td><td>The lower bound on this range </td></tr> |
| <tr><td class="paramname">upperTerm</td><td>The upper bound on this range </td></tr> |
| <tr><td class="paramname">includeLower</td><td>Does this range include the lower bound? </td></tr> |
| <tr><td class="paramname">includeUpper</td><td>Does this range include the upper bound? </td></tr> |
| <tr><td class="paramname">collator</td><td>The collator to use when determining range inclusion; set to null to use Unicode code point ordering instead of collation. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IllegalArgumentException if both terms are null or if </throws> </p> |
| <p>lowerTerm is null and includeLower is true (similar for upperTerm and includeUpper) </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00081">81</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="af2c915620e3a3a52b583872323a4619a"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html">TermRangeFilter</a> Lucene.Net.Search.TermRangeFilter.Less </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>upperTerm</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a filter for field <code>fieldName</code> matching less than or equal to <code>upperTerm</code>. </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00088">88</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ab06a736c8bebed8f95090629441ef110"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_range_filter.html">TermRangeFilter</a> Lucene.Net.Search.TermRangeFilter.More </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>fieldName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>lowerTerm</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Constructs a filter for field <code>fieldName</code> matching greater than or equal to <code>lowerTerm</code>. </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00096">96</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="af653e93577c3c842d6138091c1069e58"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual CompareInfo Lucene.Net.Search.TermRangeFilter.Collator</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 collator used to determine range inclusion, if any. </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00133">133</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3b472cfaf029c95dd1e35dd306a25f91"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual string Lucene.Net.Search.TermRangeFilter.Field</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 field name for this filter </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00103">103</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a1e975cbe82b1c48742283b9651994054"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Search.TermRangeFilter.IncludesLower</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 <code>true</code> if the lower endpoint is inclusive </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00121">121</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a482233b5a0fed0500b158c78203b9670"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual bool Lucene.Net.Search.TermRangeFilter.IncludesUpper</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 <code>true</code> if the upper endpoint is inclusive </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00127">127</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a35f68cf5d71bc40bcab8198b60b42e28"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual string Lucene.Net.Search.TermRangeFilter.LowerTerm</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 lower value of this range filter </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00109">109</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4e397120faa0940fc70d2901ae1e2b4c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual string Lucene.Net.Search.TermRangeFilter.UpperTerm</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 upper value of this range filter </p> |
| |
| <p>Definition at line <a class="el" href="_term_range_filter_8cs_source.html#l00115">115</a> of file <a class="el" href="_term_range_filter_8cs_source.html">TermRangeFilter.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="_term_range_filter_8cs_source.html">TermRangeFilter.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> |
