blob: 7f85dcb0383f2ac72f026d1a02bfe09c199f0118 [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.Function.ByteFieldSource 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
&#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="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_byte_field_source.html">ByteFieldSource</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Function.ByteFieldSource Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Expert: obtains single byte field values from the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> using <code>getBytes()</code> and makes those values available as other numeric types, casting as needed.
<a href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_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_field_cache_source.html">Lucene.Net.Search.Function.FieldCacheSource</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:a101e30971e67042f61484551e81f749f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#a101e30971e67042f61484551e81f749f">ByteFieldSource</a> (System.String field)</td></tr>
<tr class="memdesc:a101e30971e67042f61484551e81f749f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a cached byte field source with default string-to-byte parser. <a href="#a101e30971e67042f61484551e81f749f"></a><br/></td></tr>
<tr class="separator:a101e30971e67042f61484551e81f749f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72a8d5c53750a77f6b91470df592961e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#a72a8d5c53750a77f6b91470df592961e">ByteFieldSource</a> (System.String field, <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_byte_parser.html">Lucene.Net.Search.ByteParser</a> parser)</td></tr>
<tr class="memdesc:a72a8d5c53750a77f6b91470df592961e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a cached byte field source with a specific string-to-byte parser. <a href="#a72a8d5c53750a77f6b91470df592961e"></a><br/></td></tr>
<tr class="separator:a72a8d5c53750a77f6b91470df592961e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c0cd3cb9aa50b419ee4c8fffc728ba7"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#a7c0cd3cb9aa50b419ee4c8fffc728ba7">Description</a> ()</td></tr>
<tr class="memdesc:a7c0cd3cb9aa50b419ee4c8fffc728ba7"><td class="mdescLeft">&#160;</td><td class="mdescRight">description of field, used in explain() <a href="#a7c0cd3cb9aa50b419ee4c8fffc728ba7"></a><br/></td></tr>
<tr class="separator:a7c0cd3cb9aa50b419ee4c8fffc728ba7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02ce560008c513a9fdd09478a929a219"><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>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#a02ce560008c513a9fdd09478a929a219">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:a02ce560008c513a9fdd09478a929a219"><td class="mdescLeft">&#160;</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="#a02ce560008c513a9fdd09478a929a219"></a><br/></td></tr>
<tr class="separator:a02ce560008c513a9fdd09478a929a219"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad54246ff07e18a172337c2fbe24422b0"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#ad54246ff07e18a172337c2fbe24422b0">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> o)</td></tr>
<tr class="memdesc:ad54246ff07e18a172337c2fbe24422b0"><td class="mdescLeft">&#160;</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="#ad54246ff07e18a172337c2fbe24422b0"></a><br/></td></tr>
<tr class="separator:ad54246ff07e18a172337c2fbe24422b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53f8a748219a6e73c84a7c4ee28632e0"><td class="memItemLeft" align="right" valign="top">override int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_byte_field_source.html#a53f8a748219a6e73c84a7c4ee28632e0">CachedFieldSourceHashCode</a> ()</td></tr>
<tr class="memdesc:a53f8a748219a6e73c84a7c4ee28632e0"><td class="mdescLeft">&#160;</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="#a53f8a748219a6e73c84a7c4ee28632e0"></a><br/></td></tr>
<tr class="separator:a53f8a748219a6e73c84a7c4ee28632e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html">Lucene.Net.Search.Function.FieldCacheSource</a></td></tr>
<tr class="memitem:a34fc77288528f7ca41e9a28f90215d40 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><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>&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="mdescLeft">&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a979d5b10f64f9bb405895034be698e99 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">description of field, used in explain() <a href="#a979d5b10f64f9bb405895034be698e99"></a><br/></td></tr>
<tr class="separator:a979d5b10f64f9bb405895034be698e99 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa8d1aafc99da4bee2362dee44a2b8d02 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memItemLeft" align="right" valign="top">override bool&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="mdescLeft">&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20c16e1f441c28eb9d939f1072083044 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memItemLeft" align="right" valign="top">override int&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="mdescLeft">&#160;</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 inherit pub_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memSeparator" colspan="2">&#160;</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="-"/>&#160;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&#160;</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">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html">Lucene.Net.Search.Function.FieldCacheSource</a></td></tr>
<tr class="memitem:aafb6d2c8c5811ea13f922cfde71ea9f5 inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="memItemLeft" align="right" valign="top">&#160;</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 inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a cached field source for the input field. <a href="#aafb6d2c8c5811ea13f922cfde71ea9f5"></a><br/></td></tr>
<tr class="separator:aafb6d2c8c5811ea13f922cfde71ea9f5 inherit pro_methods_class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source"><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>Expert: obtains single byte field values from the <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_field_cache.html">FieldCache</a> using <code>getBytes()</code> and makes those values available as other numeric types, casting as needed. </p>
<p>&lt;font color="#FF0000"&gt; 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.&lt;/font&gt;</p>
<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_field_cache_source.html" title="Expert: A base class for ValueSource implementations that retrieve values for a single field from the...">Lucene.Net.Search.Function.FieldCacheSource</a></dd></dl>
<p>for requirements" on the field.</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.">FieldCacheSource.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="_byte_field_source_8cs_source.html#l00048">48</a> of file <a class="el" href="_byte_field_source_8cs_source.html">ByteFieldSource.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a101e30971e67042f61484551e81f749f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Function.ByteFieldSource.ByteFieldSource </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a cached byte field source with default string-to-byte parser. </p>
<p>Definition at line <a class="el" href="_byte_field_source_8cs_source.html#l00096">96</a> of file <a class="el" href="_byte_field_source_8cs_source.html">ByteFieldSource.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a72a8d5c53750a77f6b91470df592961e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Function.ByteFieldSource.ByteFieldSource </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">Lucene.Net.Search.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>Create a cached byte field source with a specific string-to-byte parser. </p>
<p>Definition at line <a class="el" href="_byte_field_source_8cs_source.html#l00101">101</a> of file <a class="el" href="_byte_field_source_8cs_source.html">ByteFieldSource.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ad54246ff07e18a172337c2fbe24422b0"></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.ByteFieldSource.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>&#160;</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">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>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#a41b45a4c408ca4827a38b0f8541e6628">Lucene.Net.Search.Function.FieldCacheSource</a>.</p>
<p>Definition at line <a class="el" href="_byte_field_source_8cs_source.html#l00120">120</a> of file <a class="el" href="_byte_field_source_8cs_source.html">ByteFieldSource.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a53f8a748219a6e73c84a7c4ee28632e0"></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.ByteFieldSource.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">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>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#afdffdaf3bc5d6f5336114c5e10c4f716">Lucene.Net.Search.Function.FieldCacheSource</a>.</p>
<p>Definition at line <a class="el" href="_byte_field_source_8cs_source.html#l00131">131</a> of file <a class="el" href="_byte_field_source_8cs_source.html">ByteFieldSource.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7c0cd3cb9aa50b419ee4c8fffc728ba7"></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.ByteFieldSource.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>Definition at line <a class="el" href="_byte_field_source_8cs_source.html#l00107">107</a> of file <a class="el" href="_byte_field_source_8cs_source.html">ByteFieldSource.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a02ce560008c513a9fdd09478a929a219"></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.ByteFieldSource.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>&#160;</td>
<td class="paramname"><em>cache</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="_more_like_this_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</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 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>Implements <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_function_1_1_field_cache_source.html#a94586eb32518cde7ca31aac60b2035f3">Lucene.Net.Search.Function.FieldCacheSource</a>.</p>
<p>Definition at line <a class="el" href="_byte_field_source_8cs_source.html#l00113">113</a> of file <a class="el" href="_byte_field_source_8cs_source.html">ByteFieldSource.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="_byte_field_source_8cs_source.html">ByteFieldSource.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 &#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>