blob: dfcf2eb14f55244a09076fc2aa724f8cf6956b8d [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.Documents.SetBasedFieldSelector 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_documents.html">Documents</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_set_based_field_selector.html">SetBasedFieldSelector</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_lucene_1_1_net_1_1_documents_1_1_set_based_field_selector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Documents.SetBasedFieldSelector Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Declare what fields to load normally and what fields to load lazily
<a href="class_lucene_1_1_net_1_1_documents_1_1_set_based_field_selector.html#details">More...</a></p>
<p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_field_selector.html">Lucene.Net.Documents.FieldSelector</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:ac50676d7e9151a8d8cde9d5c770a88ae"><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_documents_1_1_set_based_field_selector.html#ac50676d7e9151a8d8cde9d5c770a88ae">SetBasedFieldSelector</a> (ISet&lt; string &gt; fieldsToLoad, ISet&lt; string &gt; lazyFieldsToLoad)</td></tr>
<tr class="memdesc:ac50676d7e9151a8d8cde9d5c770a88ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass in the Set of <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> names to load and the Set of <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> names to load lazily. If both are null, the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> will not have any <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> on it. <a href="#ac50676d7e9151a8d8cde9d5c770a88ae"></a><br/></td></tr>
<tr class="separator:ac50676d7e9151a8d8cde9d5c770a88ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14902d5071dec66c81237fab6fb221c4"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html#a08c90341a652bfc2fbd4b5fe9d6783d0">FieldSelectorResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_set_based_field_selector.html#a14902d5071dec66c81237fab6fb221c4">Accept</a> (System.String fieldName)</td></tr>
<tr class="memdesc:a14902d5071dec66c81237fab6fb221c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate whether to load the field with the given name or not. If the AbstractField.Name() is not in either of the initializing Sets, then Lucene.Net.Documents.FieldSelectorResult.NO_LOAD is returned. If a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> name is in both <code>fieldsToLoad</code> and <code>lazyFieldsToLoad</code>, lazy has precedence. <a href="#a14902d5071dec66c81237fab6fb221c4"></a><br/></td></tr>
<tr class="separator:a14902d5071dec66c81237fab6fb221c4"><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>Declare what fields to load normally and what fields to load lazily </p>
<p>Definition at line <a class="el" href="_set_based_field_selector_8cs_source.html#l00028">28</a> of file <a class="el" href="_set_based_field_selector_8cs_source.html">SetBasedFieldSelector.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac50676d7e9151a8d8cde9d5c770a88ae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Documents.SetBasedFieldSelector.SetBasedFieldSelector </td>
<td>(</td>
<td class="paramtype">ISet&lt; string &gt;&#160;</td>
<td class="paramname"><em>fieldsToLoad</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">ISet&lt; string &gt;&#160;</td>
<td class="paramname"><em>lazyFieldsToLoad</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Pass in the Set of <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> names to load and the Set of <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> names to load lazily. If both are null, the <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_document.html" title="Documents are the unit of indexing and search.">Document</a> will not have any <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> on it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fieldsToLoad</td><td>A Set of String field names to load. May be empty, but not null </td></tr>
<tr><td class="paramname">lazyFieldsToLoad</td><td>A Set of String field names to load lazily. May be empty, but not null </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_set_based_field_selector_8cs_source.html#l00040">40</a> of file <a class="el" href="_set_based_field_selector_8cs_source.html">SetBasedFieldSelector.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a14902d5071dec66c81237fab6fb221c4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html#a08c90341a652bfc2fbd4b5fe9d6783d0">FieldSelectorResult</a> Lucene.Net.Documents.SetBasedFieldSelector.Accept </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>fieldName</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>Indicate whether to load the field with the given name or not. If the AbstractField.Name() is not in either of the initializing Sets, then Lucene.Net.Documents.FieldSelectorResult.NO_LOAD is returned. If a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> name is in both <code>fieldsToLoad</code> and <code>lazyFieldsToLoad</code>, lazy has precedence. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fieldName</td><td>The <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_field.html" title="A field is a section of a Document. Each field has two parts, a name and a value. Values may be free ...">Field</a> name to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html#a08c90341a652bfc2fbd4b5fe9d6783d0" title="Provides information about what should be done with this Field">FieldSelectorResult</a> </dd></dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_field_selector.html#a98a447516fbec297be1b16e990c42c64">Lucene.Net.Documents.FieldSelector</a>.</p>
<p>Definition at line <a class="el" href="_set_based_field_selector_8cs_source.html#l00055">55</a> of file <a class="el" href="_set_based_field_selector_8cs_source.html">SetBasedFieldSelector.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Document/<a class="el" href="_set_based_field_selector_8cs_source.html">SetBasedFieldSelector.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:49 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>