blob: cb3cc0dfc7befc8270c9fae60c3dd19101afc568 [file] [log] [blame]
<!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.FieldCache Interface 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
&#160;<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&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="interface_lucene_1_1_net_1_1_search_1_1_field_cache-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.FieldCache Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html">Lucene.Net.Search.FieldCacheImpl</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:a4165748294dc75d039e5e48986499181"><td class="memItemLeft" align="right" valign="top">sbyte[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a4165748294dc75d039e5e48986499181">GetBytes</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:a4165748294dc75d039e5e48986499181"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as a single byte and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a4165748294dc75d039e5e48986499181"></a><br/></td></tr>
<tr class="separator:a4165748294dc75d039e5e48986499181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acbeb3385a4b5bf5c26599ff0573565d0"><td class="memItemLeft" align="right" valign="top">sbyte[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#acbeb3385a4b5bf5c26599ff0573565d0">GetBytes</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_byte_parser.html">ByteParser</a> parser)</td></tr>
<tr class="memdesc:acbeb3385a4b5bf5c26599ff0573565d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as bytes and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#acbeb3385a4b5bf5c26599ff0573565d0"></a><br/></td></tr>
<tr class="separator:acbeb3385a4b5bf5c26599ff0573565d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6838bcb6423b86b17532f7e61044c106"><td class="memItemLeft" align="right" valign="top">short[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a6838bcb6423b86b17532f7e61044c106">GetShorts</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:a6838bcb6423b86b17532f7e61044c106"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as shorts and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a6838bcb6423b86b17532f7e61044c106"></a><br/></td></tr>
<tr class="separator:a6838bcb6423b86b17532f7e61044c106"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52060eaef982ad398e6956648cf0fcc8"><td class="memItemLeft" align="right" valign="top">short[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a52060eaef982ad398e6956648cf0fcc8">GetShorts</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_short_parser.html">ShortParser</a> parser)</td></tr>
<tr class="memdesc:a52060eaef982ad398e6956648cf0fcc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as shorts and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a52060eaef982ad398e6956648cf0fcc8"></a><br/></td></tr>
<tr class="separator:a52060eaef982ad398e6956648cf0fcc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6b3d06426f9600bfea681938919131b"><td class="memItemLeft" align="right" valign="top">int[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#ad6b3d06426f9600bfea681938919131b">GetInts</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:ad6b3d06426f9600bfea681938919131b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as integers and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#ad6b3d06426f9600bfea681938919131b"></a><br/></td></tr>
<tr class="separator:ad6b3d06426f9600bfea681938919131b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a328633afa13f551c57f15ded7c32bae3"><td class="memItemLeft" align="right" valign="top">int[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a328633afa13f551c57f15ded7c32bae3">GetInts</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_int_parser.html">IntParser</a> parser)</td></tr>
<tr class="memdesc:a328633afa13f551c57f15ded7c32bae3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as integers and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a328633afa13f551c57f15ded7c32bae3"></a><br/></td></tr>
<tr class="separator:a328633afa13f551c57f15ded7c32bae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa48f9987891967c470bf9f4e653f8370"><td class="memItemLeft" align="right" valign="top">float[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#aa48f9987891967c470bf9f4e653f8370">GetFloats</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:aa48f9987891967c470bf9f4e653f8370"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as floats and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#aa48f9987891967c470bf9f4e653f8370"></a><br/></td></tr>
<tr class="separator:aa48f9987891967c470bf9f4e653f8370"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a047a6d506d0e0dbc8cda301f38205302"><td class="memItemLeft" align="right" valign="top">float[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a047a6d506d0e0dbc8cda301f38205302">GetFloats</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_float_parser.html">FloatParser</a> parser)</td></tr>
<tr class="memdesc:a047a6d506d0e0dbc8cda301f38205302"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as floats and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a047a6d506d0e0dbc8cda301f38205302"></a><br/></td></tr>
<tr class="separator:a047a6d506d0e0dbc8cda301f38205302"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46589f51ea1d0a13d0897833e0189999"><td class="memItemLeft" align="right" valign="top">long[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a46589f51ea1d0a13d0897833e0189999">GetLongs</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:a46589f51ea1d0a13d0897833e0189999"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as longs and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a46589f51ea1d0a13d0897833e0189999"></a><br/></td></tr>
<tr class="separator:a46589f51ea1d0a13d0897833e0189999"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accef183d5dd96c70aa06e28cce3aa8e2"><td class="memItemLeft" align="right" valign="top">long[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#accef183d5dd96c70aa06e28cce3aa8e2">GetLongs</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_long_parser.html">LongParser</a> parser)</td></tr>
<tr class="memdesc:accef183d5dd96c70aa06e28cce3aa8e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as longs and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#accef183d5dd96c70aa06e28cce3aa8e2"></a><br/></td></tr>
<tr class="separator:accef183d5dd96c70aa06e28cce3aa8e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a634bda031a259ada69b8f7998b307a9e"><td class="memItemLeft" align="right" valign="top">double[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a634bda031a259ada69b8f7998b307a9e">GetDoubles</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:a634bda031a259ada69b8f7998b307a9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as integers and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a634bda031a259ada69b8f7998b307a9e"></a><br/></td></tr>
<tr class="separator:a634bda031a259ada69b8f7998b307a9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6353c22acdcd506bdb4e8d32d9780963"><td class="memItemLeft" align="right" valign="top">double[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a6353c22acdcd506bdb4e8d32d9780963">GetDoubles</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_double_parser.html">DoubleParser</a> parser)</td></tr>
<tr class="memdesc:a6353c22acdcd506bdb4e8d32d9780963"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as doubles and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. <a href="#a6353c22acdcd506bdb4e8d32d9780963"></a><br/></td></tr>
<tr class="separator:a6353c22acdcd506bdb4e8d32d9780963"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13b4c1bb69e607686a8f63e32dc5222e"><td class="memItemLeft" align="right" valign="top">System.String[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a13b4c1bb69e607686a8f63e32dc5222e">GetStrings</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:a13b4c1bb69e607686a8f63e32dc5222e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found, reads the term values in <code>field</code> and returns an array of size <code>reader.MaxDoc</code> containing the value each document has in the given field. <a href="#a13b4c1bb69e607686a8f63e32dc5222e"></a><br/></td></tr>
<tr class="separator:a13b4c1bb69e607686a8f63e32dc5222e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a777a72fcb94c94dfa8a3c9e0a085aef4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_string_index.html">StringIndex</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a777a72fcb94c94dfa8a3c9e0a085aef4">GetStringIndex</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> reader, System.String field)</td></tr>
<tr class="memdesc:a777a72fcb94c94dfa8a3c9e0a085aef4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks the internal cache for an appropriate entry, and if none is found reads the term values in <code>field</code> and returns an array of them in natural order, along with an array telling which element in the term array each document uses. <a href="#a777a72fcb94c94dfa8a3c9e0a085aef4"></a><br/></td></tr>
<tr class="separator:a777a72fcb94c94dfa8a3c9e0a085aef4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b78df530f58ae388eb296e6cfebad64"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html">CacheEntry</a>[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a3b78df530f58ae388eb296e6cfebad64">GetCacheEntries</a> ()</td></tr>
<tr class="memdesc:a3b78df530f58ae388eb296e6cfebad64"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERT: Generates an array of <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html" title="EXPERT: A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/de...">CacheEntry</a> objects representing all items currently in the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. NOTE: These <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html" title="EXPERT: A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/de...">CacheEntry</a> objects maintain a strong refrence to the Cached Values. Maintaining refrences to a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html" title="EXPERT: A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/de...">CacheEntry</a> the IndexReader associated with it has garbage collected will prevent the Value itself from being garbage collected when the Cache drops the WeakRefrence. <b>EXPERIMENTAL API:</b> This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of <a class="el" href="namespace_lucene.html">Lucene</a>. <a href="#a3b78df530f58ae388eb296e6cfebad64"></a><br/></td></tr>
<tr class="separator:a3b78df530f58ae388eb296e6cfebad64"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b912d9047004f88f30512a3694779a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a3b912d9047004f88f30512a3694779a4">PurgeAllCaches</a> ()</td></tr>
<tr class="memdesc:a3b912d9047004f88f30512a3694779a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">EXPERT: Instructs the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> to forcibly expunge all entries from the underlying caches. This is intended only to be used for test methods as a way to ensure a known base state of the Cache (with out needing to rely on GC to free WeakReferences). It should not be relied on for "Cache maintenance" in general application code. <b>EXPERIMENTAL API:</b> This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of <a class="el" href="namespace_lucene.html">Lucene</a>. <a href="#a3b912d9047004f88f30512a3694779a4"></a><br/></td></tr>
<tr class="separator:a3b912d9047004f88f30512a3694779a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a727e63e153e78af3435e9711138e5b2a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#a727e63e153e78af3435e9711138e5b2a">Purge</a> (<a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> r)</td></tr>
<tr class="memdesc:a727e63e153e78af3435e9711138e5b2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Expert: drops all cache entries associated with this reader. NOTE: this reader must precisely match the reader that the cache entry is keyed on. If you pass a top-level reader, it usually will have no effect as <a class="el" href="namespace_lucene.html">Lucene</a> now caches at the segment reader level. <a href="#a727e63e153e78af3435e9711138e5b2a"></a><br/></td></tr>
<tr class="separator:a727e63e153e78af3435e9711138e5b2a"><td class="memSeparator" colspan="2">&#160;</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:ab7af2ef47b09d80f191fc74d150ae731"><td class="memItemLeft" align="right" valign="top">StreamWriter&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html#ab7af2ef47b09d80f191fc74d150ae731">InfoStream</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ab7af2ef47b09d80f191fc74d150ae731"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the InfoStream for this <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. <a href="#ab7af2ef47b09d80f191fc74d150ae731"></a><br/></td></tr>
<tr class="separator:ab7af2ef47b09d80f191fc74d150ae731"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="_field_cache_8cs_source.html#l00376">376</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4165748294dc75d039e5e48986499181"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sbyte [] Lucene.Net.Search.FieldCache.GetBytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as a single byte and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the single byte values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a7f6762539e0f3dd7ecf1c0cd9007e57a">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="acbeb3385a4b5bf5c26599ff0573565d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">sbyte [] Lucene.Net.Search.FieldCache.GetBytes </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_byte_parser.html">ByteParser</a>&#160;</td>
<td class="paramname"><em>parser</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as bytes and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the bytes. </td></tr>
<tr><td class="paramname">parser</td><td>Computes byte for string values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a99c81386ccefadb2cf3ad8ec4517c681">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a3b78df530f58ae388eb296e6cfebad64"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html">CacheEntry</a> [] Lucene.Net.Search.FieldCache.GetCacheEntries </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>EXPERT: Generates an array of <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html" title="EXPERT: A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/de...">CacheEntry</a> objects representing all items currently in the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. NOTE: These <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html" title="EXPERT: A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/de...">CacheEntry</a> objects maintain a strong refrence to the Cached Values. Maintaining refrences to a <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_cache_entry.html" title="EXPERT: A unique Identifier/Description for each item in the FieldCache. Can be useful for logging/de...">CacheEntry</a> the IndexReader associated with it has garbage collected will prevent the Value itself from being garbage collected when the Cache drops the WeakRefrence. <b>EXPERIMENTAL API:</b> This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of <a class="el" href="namespace_lucene.html">Lucene</a>. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a553a4d7ee82af34944abad9265929196">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a634bda031a259ada69b8f7998b307a9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double [] Lucene.Net.Search.FieldCache.GetDoubles </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as integers and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the doubles. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a2cbc614fbf3ea98e26603e1d82a1015a">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a6353c22acdcd506bdb4e8d32d9780963"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double [] Lucene.Net.Search.FieldCache.GetDoubles </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_double_parser.html">DoubleParser</a>&#160;</td>
<td class="paramname"><em>parser</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as doubles and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the doubles. </td></tr>
<tr><td class="paramname">parser</td><td>Computes integer for string values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
</div>
</div>
<a class="anchor" id="aa48f9987891967c470bf9f4e653f8370"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float [] Lucene.Net.Search.FieldCache.GetFloats </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as floats and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the floats. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a71140fef18e8ec863d6e8469df33d599">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a047a6d506d0e0dbc8cda301f38205302"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float [] Lucene.Net.Search.FieldCache.GetFloats </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_float_parser.html">FloatParser</a>&#160;</td>
<td class="paramname"><em>parser</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as floats and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the floats. </td></tr>
<tr><td class="paramname">parser</td><td>Computes float for string values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#ae8f464073d6e722b8a3fd36ceda35d55">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ad6b3d06426f9600bfea681938919131b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int [] Lucene.Net.Search.FieldCache.GetInts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as integers and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the integers. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a3a9370eb92b4703ea235f16e27a855a5">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a328633afa13f551c57f15ded7c32bae3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int [] Lucene.Net.Search.FieldCache.GetInts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_int_parser.html">IntParser</a>&#160;</td>
<td class="paramname"><em>parser</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as integers and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the integers. </td></tr>
<tr><td class="paramname">parser</td><td>Computes integer for string values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a13070c3fbca6c8ba2d5f8cd70b09bb9a">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a46589f51ea1d0a13d0897833e0189999"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long [] Lucene.Net.Search.FieldCache.GetLongs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as longs and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the longs. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; java.io.IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a97cd35e3d6b19b23716ae416ed9e32cb">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="accef183d5dd96c70aa06e28cce3aa8e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long [] Lucene.Net.Search.FieldCache.GetLongs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_long_parser.html">LongParser</a>&#160;</td>
<td class="paramname"><em>parser</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as longs and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the longs. </td></tr>
<tr><td class="paramname">parser</td><td>Computes integer for string values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
</div>
</div>
<a class="anchor" id="a6838bcb6423b86b17532f7e61044c106"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short [] Lucene.Net.Search.FieldCache.GetShorts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as shorts and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the shorts. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#aae1a1cb53da0191d814a0852754fd108">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a52060eaef982ad398e6956648cf0fcc8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">short [] Lucene.Net.Search.FieldCache.GetShorts </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_short_parser.html">ShortParser</a>&#160;</td>
<td class="paramname"><em>parser</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the terms in <code>field</code> as shorts and returns an array of size <code>reader.MaxDoc</code> of the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the shorts. </td></tr>
<tr><td class="paramname">parser</td><td>Computes short for string values. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#afe97081bd13f941b88c50f93cc7290ca">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a777a72fcb94c94dfa8a3c9e0a085aef4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_string_index.html">StringIndex</a> Lucene.Net.Search.FieldCache.GetStringIndex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found reads the term values in <code>field</code> and returns an array of them in natural order, along with an array telling which element in the term array each document uses. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the strings. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Array of terms and index into the array for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a2dcc80b593b76ecdf62fe9eab843f549">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a13b4c1bb69e607686a8f63e32dc5222e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">System.String [] Lucene.Net.Search.FieldCache.GetStrings </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks the internal cache for an appropriate entry, and if none is found, reads the term values in <code>field</code> and returns an array of size <code>reader.MaxDoc</code> containing the value each document has in the given field. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">reader</td><td>Used to get field values. </td></tr>
<tr><td class="paramname">field</td><td>Which field contains the strings. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The values in the given field for each document. </dd></dl>
<p>&lt;throws&gt; IOException If any error occurs. &lt;/throws&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#a5c20db9bb01f692aa2b0e9ae33f194e9">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a727e63e153e78af3435e9711138e5b2a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.FieldCache.Purge </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>r</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Expert: drops all cache entries associated with this reader. NOTE: this reader must precisely match the reader that the cache entry is keyed on. If you pass a top-level reader, it usually will have no effect as <a class="el" href="namespace_lucene.html">Lucene</a> now caches at the segment reader level. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#ae27fb2cd376ba726a5d16db30b3c84a0">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a3b912d9047004f88f30512a3694779a4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.FieldCache.PurgeAllCaches </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>EXPERT: Instructs the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> to forcibly expunge all entries from the underlying caches. This is intended only to be used for test methods as a way to ensure a known base state of the Cache (with out needing to rely on GC to free WeakReferences). It should not be relied on for "Cache maintenance" in general application code. <b>EXPERIMENTAL API:</b> This API is considered extremely advanced and experimental. It may be removed or altered w/o warning in future releases of <a class="el" href="namespace_lucene.html">Lucene</a>. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html#aaba0a21c1776c975ee5ea87b842fb555">Lucene.Net.Search.FieldCacheImpl</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ab7af2ef47b09d80f191fc74d150ae731"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StreamWriter Lucene.Net.Search.FieldCache.InfoStream</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets or sets the InfoStream for this <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a>. </p>
<p>If non-null, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_field_cache_impl.html" title="Expert: The default cache implementation, storing all values in memory. A WeakDictionary is used for ...">FieldCacheImpl</a> will warn whenever entries are created that are not sane according to <a class="el" href="class_lucene_1_1_net_1_1_util_1_1_field_cache_sanity_checker.html" title="Provides methods for sanity checking that entries in the FieldCache are not wasteful or inconsistent...">Lucene.Net.Util.FieldCacheSanityChecker</a>. </p>
<p>Definition at line <a class="el" href="_field_cache_8cs_source.html#l00641">641</a> of file <a class="el" href="_field_cache_8cs_source.html">FieldCache.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>core/Search/<a class="el" href="_field_cache_8cs_source.html">FieldCache.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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>