blob: 7b15fc3520eb9f4d725417827b79392461f76bd5 [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.MapFieldSelector 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_map_field_selector.html">MapFieldSelector</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_map_field_selector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Documents.MapFieldSelector Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_field_selector.html" title="Similar to a java.io.FileFilter, the FieldSelector allows one to make decisions about what Fields get...">FieldSelector</a> based on a Map of field names to <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>s
<a href="class_lucene_1_1_net_1_1_documents_1_1_map_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:a98f1c175790b2bca2380a6d6419692ed"><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_map_field_selector.html#a98f1c175790b2bca2380a6d6419692ed">MapFieldSelector</a> (IDictionary&lt; string, <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html#a08c90341a652bfc2fbd4b5fe9d6783d0">FieldSelectorResult</a> &gt; fieldSelections)</td></tr>
<tr class="memdesc:a98f1c175790b2bca2380a6d6419692ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_map_field_selector.html" title="A FieldSelector based on a Map of field names to FieldSelectorResults">MapFieldSelector</a> <a href="#a98f1c175790b2bca2380a6d6419692ed"></a><br/></td></tr>
<tr class="separator:a98f1c175790b2bca2380a6d6419692ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a068b77bd4bdae9eef4c07beb20d253fa"><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_map_field_selector.html#a068b77bd4bdae9eef4c07beb20d253fa">MapFieldSelector</a> (IList&lt; string &gt; fields)</td></tr>
<tr class="memdesc:a068b77bd4bdae9eef4c07beb20d253fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_map_field_selector.html" title="A FieldSelector based on a Map of field names to FieldSelectorResults">MapFieldSelector</a> <a href="#a068b77bd4bdae9eef4c07beb20d253fa"></a><br/></td></tr>
<tr class="separator:a068b77bd4bdae9eef4c07beb20d253fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85f2521cfd889f358e73dec143d0d8e4"><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_map_field_selector.html#a85f2521cfd889f358e73dec143d0d8e4">MapFieldSelector</a> (params System.String[] fields)</td></tr>
<tr class="memdesc:a85f2521cfd889f358e73dec143d0d8e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_map_field_selector.html" title="A FieldSelector based on a Map of field names to FieldSelectorResults">MapFieldSelector</a> <a href="#a85f2521cfd889f358e73dec143d0d8e4"></a><br/></td></tr>
<tr class="separator:a85f2521cfd889f358e73dec143d0d8e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b0481b3d80eba931b4172100e8dd902"><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_map_field_selector.html#a1b0481b3d80eba931b4172100e8dd902">Accept</a> (System.String field)</td></tr>
<tr class="memdesc:a1b0481b3d80eba931b4172100e8dd902"><td class="mdescLeft">&#160;</td><td class="mdescRight">Load field according to its associated value in fieldSelections <a href="#a1b0481b3d80eba931b4172100e8dd902"></a><br/></td></tr>
<tr class="separator:a1b0481b3d80eba931b4172100e8dd902"><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>A <a class="el" href="interface_lucene_1_1_net_1_1_documents_1_1_field_selector.html" title="Similar to a java.io.FileFilter, the FieldSelector allows one to make decisions about what Fields get...">FieldSelector</a> based on a Map of field names to <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>s</p>
<p>Definition at line <a class="el" href="_map_field_selector_8cs_source.html#l00027">27</a> of file <a class="el" href="_map_field_selector_8cs_source.html">MapFieldSelector.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a98f1c175790b2bca2380a6d6419692ed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Documents.MapFieldSelector.MapFieldSelector </td>
<td>(</td>
<td class="paramtype">IDictionary&lt; string, <a class="el" href="namespace_lucene_1_1_net_1_1_documents.html#a08c90341a652bfc2fbd4b5fe9d6783d0">FieldSelectorResult</a> &gt;&#160;</td>
<td class="paramname"><em>fieldSelections</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_map_field_selector.html" title="A FieldSelector based on a Map of field names to FieldSelectorResults">MapFieldSelector</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fieldSelections</td><td>maps from field names (String) to <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>s </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_map_field_selector_8cs_source.html#l00034">34</a> of file <a class="el" href="_map_field_selector_8cs_source.html">MapFieldSelector.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a068b77bd4bdae9eef4c07beb20d253fa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Documents.MapFieldSelector.MapFieldSelector </td>
<td>(</td>
<td class="paramtype">IList&lt; string &gt;&#160;</td>
<td class="paramname"><em>fields</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_map_field_selector.html" title="A FieldSelector based on a Map of field names to FieldSelectorResults">MapFieldSelector</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fields</td><td>fields to LOAD. List of Strings. All other fields are NO_LOAD. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_map_field_selector_8cs_source.html#l00042">42</a> of file <a class="el" href="_map_field_selector_8cs_source.html">MapFieldSelector.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a85f2521cfd889f358e73dec143d0d8e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Documents.MapFieldSelector.MapFieldSelector </td>
<td>(</td>
<td class="paramtype">params System.String[]&#160;</td>
<td class="paramname"><em>fields</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a a <a class="el" href="class_lucene_1_1_net_1_1_documents_1_1_map_field_selector.html" title="A FieldSelector based on a Map of field names to FieldSelectorResults">MapFieldSelector</a></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fields</td><td>fields to LOAD. All other fields are NO_LOAD. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_map_field_selector_8cs_source.html#l00052">52</a> of file <a class="el" href="_map_field_selector_8cs_source.html">MapFieldSelector.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1b0481b3d80eba931b4172100e8dd902"></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.MapFieldSelector.Accept </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>field</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Load field according to its associated value in fieldSelections</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>a field name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the fieldSelections value that field maps to or NO_LOAD if none. </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="_map_field_selector_8cs_source.html#l00062">62</a> of file <a class="el" href="_map_field_selector_8cs_source.html">MapFieldSelector.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="_map_field_selector_8cs_source.html">MapFieldSelector.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>