Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_index_1_1_parallel_array_term_vector_mapper.html
blob: 9622b5c76509e26e104cca779cccb98379ec4c4f [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.Index.ParallelArrayTermVectorMapper 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_index.html">Index</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_parallel_array_term_vector_mapper.html">ParallelArrayTermVectorMapper</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_index_1_1_parallel_array_term_vector_mapper-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.ParallelArrayTermVectorMapper Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Models the existing parallel array structure
<a href="class_lucene_1_1_net_1_1_index_1_1_parallel_array_term_vector_mapper.html#details">More...</a></p>
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html">Lucene.Net.Index.TermVectorMapper</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:ae9ce0a31afe9dd8f2df41ba604d34156"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_parallel_array_term_vector_mapper.html#ae9ce0a31afe9dd8f2df41ba604d34156">SetExpectations</a> (System.String field, int numTerms, bool storeOffsets, bool storePositions)</td></tr>
<tr class="memdesc:ae9ce0a31afe9dd8f2df41ba604d34156"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tell the mapper what to expect in regards to field, number of terms, offset and position storage. This method will be called once before retrieving the vector for a field. <a href="#ae9ce0a31afe9dd8f2df41ba604d34156"></a><br/></td></tr>
<tr class="separator:ae9ce0a31afe9dd8f2df41ba604d34156"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd921376ef904120bf0205587e2506cb"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_parallel_array_term_vector_mapper.html#afd921376ef904120bf0205587e2506cb">Map</a> (System.String term, int frequency, <a class="el" href="struct_lucene_1_1_net_1_1_index_1_1_term_vector_offset_info.html">TermVectorOffsetInfo</a>[] offsets, int[] positions)</td></tr>
<tr class="memdesc:afd921376ef904120bf0205587e2506cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Map the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> Vector information into your own structure <a href="#afd921376ef904120bf0205587e2506cb"></a><br/></td></tr>
<tr class="separator:afd921376ef904120bf0205587e2506cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab287b593a1dca303e07406eaa0066d92"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector.html">ITermFreqVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_parallel_array_term_vector_mapper.html#ab287b593a1dca303e07406eaa0066d92">MaterializeVector</a> ()</td></tr>
<tr class="memdesc:ab287b593a1dca303e07406eaa0066d92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct the vector <a href="#ab287b593a1dca303e07406eaa0066d92"></a><br/></td></tr>
<tr class="separator:ab287b593a1dca303e07406eaa0066d92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html">Lucene.Net.Index.TermVectorMapper</a></td></tr>
<tr class="memitem:aaf997c96f990d276611df1191300d79b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html#aaf997c96f990d276611df1191300d79b">SetDocumentNumber</a> (int documentNumber)</td></tr>
<tr class="memdesc:aaf997c96f990d276611df1191300d79b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Passes down the index of the document whose term vector is currently being mapped, once for each top level call to a term vector reader. Default implementation IGNORES the document number. Override if your implementation needs the document number. NOTE: Document numbers are internal to <a class="el" href="namespace_lucene.html">Lucene</a> and subject to change depending on indexing operations. <a href="#aaf997c96f990d276611df1191300d79b"></a><br/></td></tr>
<tr class="separator:aaf997c96f990d276611df1191300d79b inherit pub_methods_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><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 properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html">Lucene.Net.Index.TermVectorMapper</a></td></tr>
<tr class="memitem:a6c6f9f71ff2fe0c785604630e8e41811 inherit properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html#a6c6f9f71ff2fe0c785604630e8e41811">IsIgnoringPositions</a><code> [get]</code></td></tr>
<tr class="memdesc:a6c6f9f71ff2fe0c785604630e8e41811 inherit properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate to <a class="el" href="namespace_lucene.html">Lucene</a> that even if there are positions stored, this mapper is not interested in them and they can be skipped over. Derived classes should set this to true if they want to ignore positions. The default is false, meaning positions will be loaded if they are stored. <a href="#a6c6f9f71ff2fe0c785604630e8e41811"></a><br/></td></tr>
<tr class="separator:a6c6f9f71ff2fe0c785604630e8e41811 inherit properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35863657b1cfd3ce99251063f979edbc inherit properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html#a35863657b1cfd3ce99251063f979edbc">IsIgnoringOffsets</a><code> [get]</code></td></tr>
<tr class="memdesc:a35863657b1cfd3ce99251063f979edbc inherit properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><td class="mdescLeft">&#160;</td><td class="mdescRight"> <a href="#a35863657b1cfd3ce99251063f979edbc"></a><br/></td></tr>
<tr class="separator:a35863657b1cfd3ce99251063f979edbc inherit properties_class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper"><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>Models the existing parallel array structure</p>
<p>Definition at line <a class="el" href="_term_vectors_reader_8cs_source.html#l00671">671</a> of file <a class="el" href="_term_vectors_reader_8cs_source.html">TermVectorsReader.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afd921376ef904120bf0205587e2506cb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Index.ParallelArrayTermVectorMapper.Map </td>
<td>(</td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>term</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>frequency</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_lucene_1_1_net_1_1_index_1_1_term_vector_offset_info.html">TermVectorOffsetInfo</a>[]&#160;</td>
<td class="paramname"><em>offsets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int[]&#160;</td>
<td class="paramname"><em>positions</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>Map the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term.html" title="A Term represents a word from text. This is the unit of search. It is composed of two elements...">Term</a> Vector information into your own structure</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">term</td><td>The term to add to the vector </td></tr>
<tr><td class="paramname">frequency</td><td>The frequency of the term in the document </td></tr>
<tr><td class="paramname">offsets</td><td>null if the offset is not specified, otherwise the offset into the field of the term </td></tr>
<tr><td class="paramname">positions</td><td>null if the position is not specified, otherwise the position in the field of the term </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html#abd24ad5232238a1079d57b830cf3673b">Lucene.Net.Index.TermVectorMapper</a>.</p>
<p>Definition at line <a class="el" href="_term_vectors_reader_8cs_source.html#l00696">696</a> of file <a class="el" href="_term_vectors_reader_8cs_source.html">TermVectorsReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab287b593a1dca303e07406eaa0066d92"></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="interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector.html">ITermFreqVector</a> Lucene.Net.Index.ParallelArrayTermVectorMapper.MaterializeVector </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>Construct the vector</p>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector.html" title="Provides access to stored term vector of a document field. The vector consists of the name of the fie...">ITermFreqVector</a> based on the mappings. </dd></dl>
<p>Definition at line <a class="el" href="_term_vectors_reader_8cs_source.html#l00714">714</a> of file <a class="el" href="_term_vectors_reader_8cs_source.html">TermVectorsReader.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae9ce0a31afe9dd8f2df41ba604d34156"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override void Lucene.Net.Index.ParallelArrayTermVectorMapper.SetExpectations </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">int&#160;</td>
<td class="paramname"><em>numTerms</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>storeOffsets</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>storePositions</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>Tell the mapper what to expect in regards to field, number of terms, offset and position storage. This method will be called once before retrieving the vector for a field. </p>
<p>This method will be called before Map(String,int,TermVectorOffsetInfo[],int[]). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">field</td><td>The field the vector is for </td></tr>
<tr><td class="paramname">numTerms</td><td>The number of terms that need to be mapped </td></tr>
<tr><td class="paramname">storeOffsets</td><td>true if the mapper should expect offset information </td></tr>
<tr><td class="paramname">storePositions</td><td>true if the mapper should expect positions info </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_term_vector_mapper.html#a94f3510f1f0261b885883722abb03e5f">Lucene.Net.Index.TermVectorMapper</a>.</p>
<p>Definition at line <a class="el" href="_term_vectors_reader_8cs_source.html#l00683">683</a> of file <a class="el" href="_term_vectors_reader_8cs_source.html">TermVectorsReader.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Index/<a class="el" href="_term_vectors_reader_8cs_source.html">TermVectorsReader.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:55 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>