| <!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.Function.FieldCacheSource 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="namespace_lucene_1_1_net_1_1_search_1_1_function.html">Function</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html">FieldCacheSource</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Lucene.Net.Search.Function.FieldCacheSource Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Expert: A base class for <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html" title="Expert: source of values for basic function queries. At its default/simplest form, values - one per doc - are used as the score of that doc. Values are instantiated as DocValues for a particular reader. ValueSource implementations differ in RAM requirements: it would always be a factor of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8.">ValueSource</a> implementations that retrieve values for a single field from the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. Fields used herein nust be indexed (doesn't matter if these fields are stored or not). It is assumed that each such indexed field is untokenized, or at least has a single token in a document. For documents with multiple tokens of the same field, behavior is undefined (It is likely that current code would use the value of one of these tokens, but this is not guaranteed). Document with no tokens in this field are assigned the <code>Zero</code> value. |
| <a href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#details">More...</a></p> |
| |
| <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html">Lucene.Net.Search.Function.ByteFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_float_field_source.html">Lucene.Net.Search.Function.FloatFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_int_field_source.html">Lucene.Net.Search.Function.IntFieldSource</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_short_field_source.html">Lucene.Net.Search.Function.ShortFieldSource</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:a34fc77288528f7ca41e9a28f90215d40"><td class="memItemLeft" align="right" valign="top">override <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="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#a34fc77288528f7ca41e9a28f90215d40">GetValues</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader)</td></tr> |
| <tr class="memdesc:a34fc77288528f7ca41e9a28f90215d40"><td class="mdescLeft"> </td><td class="mdescRight">Return the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html" title="Expert: represents field values as different types. Normally created via a ValueSuorce for a particul...">DocValues</a> used by the function query. <a href="#a34fc77288528f7ca41e9a28f90215d40"></a><br/></td></tr> |
| <tr class="separator:a34fc77288528f7ca41e9a28f90215d40"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a979d5b10f64f9bb405895034be698e99"><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_function_1_1_field_cache_source.html#a979d5b10f64f9bb405895034be698e99">Description</a> ()</td></tr> |
| <tr class="memdesc:a979d5b10f64f9bb405895034be698e99"><td class="mdescLeft"> </td><td class="mdescRight">description of field, used in explain() <a href="#a979d5b10f64f9bb405895034be698e99"></a><br/></td></tr> |
| <tr class="separator:a979d5b10f64f9bb405895034be698e99"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a94586eb32518cde7ca31aac60b2035f3"><td class="memItemLeft" align="right" valign="top">abstract <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="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#a94586eb32518cde7ca31aac60b2035f3">GetCachedFieldValues</a> (<a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> cache, System.String field, <a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader)</td></tr> |
| <tr class="memdesc:a94586eb32518cde7ca31aac60b2035f3"><td class="mdescLeft"> </td><td class="mdescRight">Return cached <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html" title="Expert: represents field values as different types. Normally created via a ValueSuorce for a particul...">DocValues</a> for input field and reader. <a href="#a94586eb32518cde7ca31aac60b2035f3"></a><br/></td></tr> |
| <tr class="separator:a94586eb32518cde7ca31aac60b2035f3"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa8d1aafc99da4bee2362dee44a2b8d02"><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_function_1_1_field_cache_source.html#aa8d1aafc99da4bee2362dee44a2b8d02">Equals</a> (System.Object o)</td></tr> |
| <tr class="memdesc:aa8d1aafc99da4bee2362dee44a2b8d02"><td class="mdescLeft"> </td><td class="mdescRight">Needed for possible caching of query results - used by ValueSourceQuery.Equals(Object). <a href="#aa8d1aafc99da4bee2362dee44a2b8d02"></a><br/></td></tr> |
| <tr class="separator:aa8d1aafc99da4bee2362dee44a2b8d02"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a20c16e1f441c28eb9d939f1072083044"><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_function_1_1_field_cache_source.html#a20c16e1f441c28eb9d939f1072083044">GetHashCode</a> ()</td></tr> |
| <tr class="memdesc:a20c16e1f441c28eb9d939f1072083044"><td class="mdescLeft"> </td><td class="mdescRight">Needed for possible caching of query results - used by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source_query.html#a7f1a2a5b13e425af8014a6a838eeaa57" title="Returns a hash code value for this object. ">ValueSourceQuery.GetHashCode()</a>. <a href="#a20c16e1f441c28eb9d939f1072083044"></a><br/></td></tr> |
| <tr class="separator:a20c16e1f441c28eb9d939f1072083044"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a41b45a4c408ca4827a38b0f8541e6628"><td class="memItemLeft" align="right" valign="top">abstract bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#a41b45a4c408ca4827a38b0f8541e6628">CachedFieldSourceEquals</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html">FieldCacheSource</a> other)</td></tr> |
| <tr class="memdesc:a41b45a4c408ca4827a38b0f8541e6628"><td class="mdescLeft"> </td><td class="mdescRight">Check if equals to another <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html" title="Expert: A base class for ValueSource implementations that retrieve values for a single field from the...">FieldCacheSource</a>, already knowing that cache and field are equal. <a href="#a41b45a4c408ca4827a38b0f8541e6628"></a><br/></td></tr> |
| <tr class="separator:a41b45a4c408ca4827a38b0f8541e6628"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:afdffdaf3bc5d6f5336114c5e10c4f716"><td class="memItemLeft" align="right" valign="top">abstract int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#afdffdaf3bc5d6f5336114c5e10c4f716">CachedFieldSourceHashCode</a> ()</td></tr> |
| <tr class="memdesc:afdffdaf3bc5d6f5336114c5e10c4f716"><td class="mdescLeft"> </td><td class="mdescRight">Return a hash code of a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html" title="Expert: A base class for ValueSource implementations that retrieve values for a single field from the...">FieldCacheSource</a>, without the hash-codes of the field and the cache (those are taken care of elsewhere). <a href="#afdffdaf3bc5d6f5336114c5e10c4f716"></a><br/></td></tr> |
| <tr class="separator:afdffdaf3bc5d6f5336114c5e10c4f716"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html">Lucene.Net.Search.Function.ValueSource</a></td></tr> |
| <tr class="memitem:a502b061330d9e0ba6139ac58a4ffa0b9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><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_function_1_1_value_source.html#a502b061330d9e0ba6139ac58a4ffa0b9">ToString</a> ()</td></tr> |
| <tr class="separator:a502b061330d9e0ba6139ac58a4ffa0b9 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:aafb6d2c8c5811ea13f922cfde71ea9f5"><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_function_1_1_field_cache_source.html#aafb6d2c8c5811ea13f922cfde71ea9f5">FieldCacheSource</a> (System.String field)</td></tr> |
| <tr class="memdesc:aafb6d2c8c5811ea13f922cfde71ea9f5"><td class="mdescLeft"> </td><td class="mdescRight">Create a cached field source for the input field. <a href="#aafb6d2c8c5811ea13f922cfde71ea9f5"></a><br/></td></tr> |
| <tr class="separator:aafb6d2c8c5811ea13f922cfde71ea9f5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Expert: A base class for <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html" title="Expert: source of values for basic function queries. At its default/simplest form, values - one per doc - are used as the score of that doc. Values are instantiated as DocValues for a particular reader. ValueSource implementations differ in RAM requirements: it would always be a factor of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8.">ValueSource</a> implementations that retrieve values for a single field from the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. </p> |
| <p>Fields used herein nust be indexed (doesn't matter if these fields are stored or not). </p> |
| <p>It is assumed that each such indexed field is untokenized, or at least has a single token in a document. For documents with multiple tokens of the same field, behavior is undefined (It is likely that current code would use the value of one of these tokens, but this is not guaranteed). </p> |
| <p>Document with no tokens in this field are assigned the <code>Zero</code> value. </p> |
| <p><font color="#FF0000"> WARNING: The status of the <b><a class="el" href="namespace_lucene_1_1_net_1_1_search_1_1_function.html">Search.Function</a></b> package is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.</font></p> |
| <p><b>NOTE</b>: with the switch in 2.9 to segment-based searching, if <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#a34fc77288528f7ca41e9a28f90215d40" title="Return the DocValues used by the function query.">GetValues</a> is invoked with a composite (multi-segment) reader, this can easily cause double RAM usage for the values in the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. It's best to switch your application to pass only atomic (single segment) readers to this API.</p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_source_8cs_source.html#l00050">50</a> of file <a class="el" href="_field_cache_source_8cs_source.html">FieldCacheSource.cs</a>.</p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="aafb6d2c8c5811ea13f922cfde71ea9f5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Lucene.Net.Search.Function.FieldCacheSource.FieldCacheSource </td> |
| <td>(</td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>field</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a cached field source for the input field. </p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_source_8cs_source.html#l00055">55</a> of file <a class="el" href="_field_cache_source_8cs_source.html">FieldCacheSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a41b45a4c408ca4827a38b0f8541e6628"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract bool Lucene.Net.Search.Function.FieldCacheSource.CachedFieldSourceEquals </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html">FieldCacheSource</a> </td> |
| <td class="paramname"><em>other</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>Check if equals to another <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html" title="Expert: A base class for ValueSource implementations that retrieve values for a single field from the...">FieldCacheSource</a>, already knowing that cache and field are equal. </p> |
| <dl class="section see"><dt>See Also</dt><dd>Object.Equals(Object)</dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#ad54246ff07e18a172337c2fbe24422b0">Lucene.Net.Search.Function.ByteFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_int_field_source.html#a77d5fa50661e48e4cdfdcb80b5efaa5c">Lucene.Net.Search.Function.IntFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_short_field_source.html#ac83e5f5e46b63a6ea2840a009f88f1dc">Lucene.Net.Search.Function.ShortFieldSource</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_float_field_source.html#a4da3176d3fc39ec3cac0ed2367cc7cbb">Lucene.Net.Search.Function.FloatFieldSource</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="afdffdaf3bc5d6f5336114c5e10c4f716"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">abstract int Lucene.Net.Search.Function.FieldCacheSource.CachedFieldSourceHashCode </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>Return a hash code of a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html" title="Expert: A base class for ValueSource implementations that retrieve values for a single field from the...">FieldCacheSource</a>, without the hash-codes of the field and the cache (those are taken care of elsewhere). </p> |
| <dl class="section see"><dt>See Also</dt><dd>Object.GetHashCode()</dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#a53f8a748219a6e73c84a7c4ee28632e0">Lucene.Net.Search.Function.ByteFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_int_field_source.html#a11a91b73b4af387ca1661ec8c9873021">Lucene.Net.Search.Function.IntFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_short_field_source.html#a9386db82944a142c7c2b710aaed81206">Lucene.Net.Search.Function.ShortFieldSource</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_float_field_source.html#a6081c3de1fbebb0e9546b8ac9bd72a97">Lucene.Net.Search.Function.FloatFieldSource</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a979d5b10f64f9bb405895034be698e99"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override System.String Lucene.Net.Search.Function.FieldCacheSource.Description </td> |
| <td>(</td> |
| <td class="paramname"></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>description of field, used in explain() </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a20134fc1e0bb7739626e2434f95473ba">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Reimplemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_int_field_source.html#ab69553c9b9f5ce665904b053b0888e63">Lucene.Net.Search.Function.IntFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_short_field_source.html#aa8c11abbcbc28027f301609d6e929192">Lucene.Net.Search.Function.ShortFieldSource</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_float_field_source.html#ac49bd1d14efacbb611f8e3aee523496b">Lucene.Net.Search.Function.FloatFieldSource</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_source_8cs_source.html#l00067">67</a> of file <a class="el" href="_field_cache_source_8cs_source.html">FieldCacheSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="aa8d1aafc99da4bee2362dee44a2b8d02"></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.Search.Function.FieldCacheSource.Equals </td> |
| <td>(</td> |
| <td class="paramtype">System.Object </td> |
| <td class="paramname"><em>o</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>Needed for possible caching of query results - used by ValueSourceQuery.Equals(Object).</p> |
| <dl class="section see"><dt>See Also</dt><dd>Object.Equals(Object)</dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#aed70eaaa40d4170914f814a7ced188bc">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_source_8cs_source.html#l00082">82</a> of file <a class="el" href="_field_cache_source_8cs_source.html">FieldCacheSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a94586eb32518cde7ca31aac60b2035f3"></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_function_1_1_doc_values.html">DocValues</a> Lucene.Net.Search.Function.FieldCacheSource.GetCachedFieldValues </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> </td> |
| <td class="paramname"><em>cache</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">System.String </td> |
| <td class="paramname"><em>field</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></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> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Return cached <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html" title="Expert: represents field values as different types. Normally created via a ValueSuorce for a particul...">DocValues</a> for input field and reader.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">cache</td><td><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> so that values of a field are loaded once per reader (RAM allowing) </td></tr> |
| <tr><td class="paramname">field</td><td>Field for which values are required. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html" title="Expert: source of values for basic function queries. At its default/simplest form, values - one per doc - are used as the score of that doc. Values are instantiated as DocValues for a particular reader. ValueSource implementations differ in RAM requirements: it would always be a factor of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8.">ValueSource</a></dd></dl> |
| |
| <p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#a02ce560008c513a9fdd09478a929a219">Lucene.Net.Search.Function.ByteFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_int_field_source.html#a3f53088da908fa81288d599ce0c4589b">Lucene.Net.Search.Function.IntFieldSource</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_short_field_source.html#a3617236097f14ab4e9976fe749944744">Lucene.Net.Search.Function.ShortFieldSource</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_float_field_source.html#a316540595e8d6652d0f5956062baeac4">Lucene.Net.Search.Function.FloatFieldSource</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a20c16e1f441c28eb9d939f1072083044"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">override int Lucene.Net.Search.Function.FieldCacheSource.GetHashCode </td> |
| <td>(</td> |
| <td class="paramname"></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>Needed for possible caching of query results - used by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source_query.html#a7f1a2a5b13e425af8014a6a838eeaa57" title="Returns a hash code value for this object. ">ValueSourceQuery.GetHashCode()</a>.</p> |
| <dl class="section see"><dt>See Also</dt><dd>Object.GetHashCode()</dd></dl> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a614e97264e961aa7c769a6e592f30f09">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_source_8cs_source.html#l00093">93</a> of file <a class="el" href="_field_cache_source_8cs_source.html">FieldCacheSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a34fc77288528f7ca41e9a28f90215d40"></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_function_1_1_doc_values.html">DocValues</a> Lucene.Net.Search.Function.FieldCacheSource.GetValues </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">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Return the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_doc_values.html" title="Expert: represents field values as different types. Normally created via a ValueSuorce for a particul...">DocValues</a> used by the function query.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">reader</td><td>the IndexReader used to read these values. If any caching is involved, that caching would also be IndexReader based. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p><throws> IOException for any error. </throws> </p> |
| |
| <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_value_source.html#a4fe47158939f191400db3b71dec5a61f">Lucene.Net.Search.Function.ValueSource</a>.</p> |
| |
| <p>Definition at line <a class="el" href="_field_cache_source_8cs_source.html#l00061">61</a> of file <a class="el" href="_field_cache_source_8cs_source.html">FieldCacheSource.cs</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>core/Search/Function/<a class="el" href="_field_cache_source_8cs_source.html">FieldCacheSource.cs</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:12:58 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> |
