| <!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.DocIdSet 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_doc_id_set.html">DocIdSet</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-attribs">Static Public Attributes</a> | |
| <a href="#properties">Properties</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.DocIdSet Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>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> contains a set of doc ids. Implementing classes must only implement <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html#ada9f32eb3d60f5b8702420e19373356c" title="Provides a DocIdSetIterator to access the set. This implementation can return null or EMPTY_DOCIDSET...">Iterator</a> to provide access to the set. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html#details">More...</a></p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_1_1_anonymous_class_doc_id_set.html">Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet</a>, Lucene.Net.Search.FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html">Lucene.Net.Search.FilteredDocIdSet</a>, Lucene.Net.Search.QueryWrapperFilter.AnonymousClassDocIdSet, and <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_fixed_bit_set.html">Lucene.Net.Spatial.Util.FixedBitSet</a>.</p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
| Classes</h2></td></tr> |
| <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_1_1_anonymous_class_doc_id_set.html">AnonymousClassDocIdSet</a></td></tr> |
| <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><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:ada9f32eb3d60f5b8702420e19373356c"><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_iterator.html">DocIdSetIterator</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#ada9f32eb3d60f5b8702420e19373356c">Iterator</a> ()</td></tr> |
| <tr class="memdesc:ada9f32eb3d60f5b8702420e19373356c"><td class="mdescLeft"> </td><td class="mdescRight">Provides 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> to access the set. This implementation can return <code>null</code> or <code>EMPTY_DOCIDSET.Iterator()</code> if there are no docs that match. <a href="#ada9f32eb3d60f5b8702420e19373356c"></a><br/></td></tr> |
| <tr class="separator:ada9f32eb3d60f5b8702420e19373356c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a> |
| Static Public Attributes</h2></td></tr> |
| <tr class="memitem:a0954d462a5e3b7b8d1161d48d72ba391"><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"><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"><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:a9ef46816963037ea6b2776dfa1bcfe76"><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_doc_id_set.html#a9ef46816963037ea6b2776dfa1bcfe76">IsCacheable</a><code> [get]</code></td></tr> |
| <tr class="memdesc:a9ef46816963037ea6b2776dfa1bcfe76"><td class="mdescLeft"> </td><td class="mdescRight">This method is a hint for <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html" title="Wraps another filter's result and caches it. The purpose is to allow filters to simply filter...">CachingWrapperFilter</a>, if this <code><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></code> should be cached without copying it into a BitSet. The default is to return <code>false</code>. If you have an own <code><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></code> implementation that does its iteration very effective and fast without doing disk I/O, override this method and return true. <a href="#a9ef46816963037ea6b2776dfa1bcfe76"></a><br/></td></tr> |
| <tr class="separator:a9ef46816963037ea6b2776dfa1bcfe76"><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_doc_id_set.html" title="A DocIdSet contains a set of doc ids. Implementing classes must only implement Iterator to provide ac...">DocIdSet</a> contains a set of doc ids. Implementing classes must only implement <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html#ada9f32eb3d60f5b8702420e19373356c" title="Provides a DocIdSetIterator to access the set. This implementation can return null or EMPTY_DOCIDSET...">Iterator</a> to provide access to the set. </p> |
| |
| <p>Definition at line <a class="el" href="_doc_id_set_8cs_source.html#l00027">27</a> of file <a class="el" href="_doc_id_set_8cs_source.html">DocIdSet.cs</a>.</p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="ada9f32eb3d60f5b8702420e19373356c"></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_iterator.html">DocIdSetIterator</a> Lucene.Net.Search.DocIdSet.Iterator </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>Provides 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> to access the set. This implementation can return <code>null</code> or <code>EMPTY_DOCIDSET.Iterator()</code> if there are no docs that match. </p> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_fixed_bit_set.html#a4acc4c2560ec1432efd77ac43853e801">Lucene.Net.Spatial.Util.FixedBitSet</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set.html#a3051443d399152b11f6fd4d513901a03">Lucene.Net.Search.FilteredDocIdSet</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_1_1_anonymous_class_doc_id_set.html#abfd74c2bafda87b2f58f9d5548d2a010">Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="a0954d462a5e3b7b8d1161d48d72ba391"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">readonly <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set.html">DocIdSet</a> Lucene.Net.Search.DocIdSet.EMPTY_DOCIDSET</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>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. </p> |
| |
| <p>Definition at line <a class="el" href="_doc_id_set_8cs_source.html#l00087">87</a> of file <a class="el" href="_doc_id_set_8cs_source.html">DocIdSet.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a class="anchor" id="a9ef46816963037ea6b2776dfa1bcfe76"></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.DocIdSet.IsCacheable</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>This method is a hint for <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_caching_wrapper_filter.html" title="Wraps another filter's result and caches it. The purpose is to allow filters to simply filter...">CachingWrapperFilter</a>, if this <code><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></code> should be cached without copying it into a BitSet. The default is to return <code>false</code>. If you have an own <code><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></code> implementation that does its iteration very effective and fast without doing disk I/O, override this method and return true. </p> |
| |
| <p>Definition at line <a class="el" href="_doc_id_set_8cs_source.html#l00103">103</a> of file <a class="el" href="_doc_id_set_8cs_source.html">DocIdSet.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="_doc_id_set_8cs_source.html">DocIdSet.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:56 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> |
