blob: ee847dda4e2efe0b9ee3970cd0b939cd8a541f5d [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.TermPositionVector 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_index.html">Index</a></li><li class="navelem"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html">TermPositionVector</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Index.TermPositionVector Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Extends <code>TermFreqVector</code> to provide additional information about positions in which each of the terms is found. A <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html" title="Extends TermFreqVector to provide additional information about positions in which each of the terms i...">TermPositionVector</a> not necessarily contains both positions and offsets, but at least one of these arrays exists.
<a href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html#details">More...</a></p>
<p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector.html">Lucene.Net.Index.ITermFreqVector</a>.</p>
<p>Inherited by Lucene.Net.Index.Memory.MemoryIndex.MemoryIndexReader.MemoryTermPositionVector, and <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_term_position_vector.html">Lucene.Net.Index.SegmentTermPositionVector</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:a0fdf7e199cd02ab8bc6b767b75bf0ca2"><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_index_1_1_term_position_vector.html#a0fdf7e199cd02ab8bc6b767b75bf0ca2">GetTermPositions</a> (int index)</td></tr>
<tr class="memdesc:a0fdf7e199cd02ab8bc6b767b75bf0ca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an array of positions in which the term is found. Terms are identified by the index at which its number appears in the term String array obtained from the <code>indexOf</code> method. May return null if positions have not been stored. <a href="#a0fdf7e199cd02ab8bc6b767b75bf0ca2"></a><br/></td></tr>
<tr class="separator:a0fdf7e199cd02ab8bc6b767b75bf0ca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39e0116361f7e7578e0576aae85b588f"><td class="memItemLeft" align="right" valign="top"><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="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html#a39e0116361f7e7578e0576aae85b588f">GetOffsets</a> (int index)</td></tr>
<tr class="memdesc:a39e0116361f7e7578e0576aae85b588f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns an array of <a class="el" href="struct_lucene_1_1_net_1_1_index_1_1_term_vector_offset_info.html" title="The TermVectorOffsetInfo class holds information pertaining to a Term in a Lucene.Net.Index.TermPositionVector&#39;s offset information. This offset information is the character offset as set during the Analysis phase (and thus may not be the actual offset in the original content). ">TermVectorOffsetInfo</a> in which the term is found. May return null if offsets have not been stored. <a href="#a39e0116361f7e7578e0576aae85b588f"></a><br/></td></tr>
<tr class="separator:a39e0116361f7e7578e0576aae85b588f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector.html">Lucene.Net.Index.ITermFreqVector</a></td></tr>
<tr class="memitem:a9a0fd66926229e5509e05a7e7358e8f5 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><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_index_1_1_i_term_freq_vector.html#a9a0fd66926229e5509e05a7e7358e8f5">GetTerms</a> ()</td></tr>
<tr class="separator:a9a0fd66926229e5509e05a7e7358e8f5 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac369bbcf6b0c91d554f7b5c6ad037fa8 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><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_index_1_1_i_term_freq_vector.html#ac369bbcf6b0c91d554f7b5c6ad037fa8">GetTermFrequencies</a> ()</td></tr>
<tr class="memdesc:ac369bbcf6b0c91d554f7b5c6ad037fa8 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array of term frequencies. Locations of the array correspond one to one to the terms in the array obtained from <code>getTerms</code> method. Each location in the array contains the number of times this term occurs in the document or the document field. <a href="#ac369bbcf6b0c91d554f7b5c6ad037fa8"></a><br/></td></tr>
<tr class="separator:ac369bbcf6b0c91d554f7b5c6ad037fa8 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2c0a663dfc703b4dc655b4ee6d4c0e5 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><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_index_1_1_i_term_freq_vector.html#ac2c0a663dfc703b4dc655b4ee6d4c0e5">IndexOf</a> (System.String term)</td></tr>
<tr class="memdesc:ac2c0a663dfc703b4dc655b4ee6d4c0e5 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return an index in the term numbers array returned from <code>getTerms</code> at which the term with the specified <code>term</code> appears. If this term does not appear in the array, return -1. <a href="#ac2c0a663dfc703b4dc655b4ee6d4c0e5"></a><br/></td></tr>
<tr class="separator:ac2c0a663dfc703b4dc655b4ee6d4c0e5 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76975965af10a9b4a0ec1aa86e31ad36 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><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_index_1_1_i_term_freq_vector.html#a76975965af10a9b4a0ec1aa86e31ad36">IndexesOf</a> (System.String[] terms, int start, int len)</td></tr>
<tr class="memdesc:a76975965af10a9b4a0ec1aa86e31ad36 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="mdescLeft">&#160;</td><td class="mdescRight">Just like <code>indexOf(int)</code> but searches for a number of terms at the same time. Returns an array that has the same size as the number of terms searched for, each slot containing the result of searching for that term number. <a href="#a76975965af10a9b4a0ec1aa86e31ad36"></a><br/></td></tr>
<tr class="separator:a76975965af10a9b4a0ec1aa86e31ad36 inherit pub_methods_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><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_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector.html">Lucene.Net.Index.ITermFreqVector</a></td></tr>
<tr class="memitem:ac972fabbf5770adfb80bd3020de8a151 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector.html#ac972fabbf5770adfb80bd3020de8a151">Field</a><code> [get]</code></td></tr>
<tr class="memdesc:ac972fabbf5770adfb80bd3020de8a151 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="mdescLeft">&#160;</td><td class="mdescRight">The IFieldable name. <a href="#ac972fabbf5770adfb80bd3020de8a151"></a><br/></td></tr>
<tr class="separator:ac972fabbf5770adfb80bd3020de8a151 inherit properties_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab34a8a8864a856841b9591113996180c inherit properties_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><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_index_1_1_i_term_freq_vector.html#ab34a8a8864a856841b9591113996180c">Size</a><code> [get]</code></td></tr>
<tr class="memdesc:ab34a8a8864a856841b9591113996180c inherit properties_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of terms in the term vector. <a href="#ab34a8a8864a856841b9591113996180c"></a><br/></td></tr>
<tr class="separator:ab34a8a8864a856841b9591113996180c inherit properties_interface_lucene_1_1_net_1_1_index_1_1_i_term_freq_vector"><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>Extends <code>TermFreqVector</code> to provide additional information about positions in which each of the terms is found. A <a class="el" href="interface_lucene_1_1_net_1_1_index_1_1_term_position_vector.html" title="Extends TermFreqVector to provide additional information about positions in which each of the terms i...">TermPositionVector</a> not necessarily contains both positions and offsets, but at least one of these arrays exists. </p>
<p>Definition at line <a class="el" href="_term_position_vector_8cs_source.html#l00027">27</a> of file <a class="el" href="_term_position_vector_8cs_source.html">TermPositionVector.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a39e0116361f7e7578e0576aae85b588f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_lucene_1_1_net_1_1_index_1_1_term_vector_offset_info.html">TermVectorOffsetInfo</a> [] Lucene.Net.Index.TermPositionVector.GetOffsets </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of <a class="el" href="struct_lucene_1_1_net_1_1_index_1_1_term_vector_offset_info.html" title="The TermVectorOffsetInfo class holds information pertaining to a Term in a Lucene.Net.Index.TermPositionVector&#39;s offset information. This offset information is the character offset as set during the Analysis phase (and thus may not be the actual offset in the original content). ">TermVectorOffsetInfo</a> in which the term is found. May return null if offsets have not been stored. </p>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html" title="A Token is an occurrence of a term from the text of a field. It consists of a term&#39;s text...">Lucene.Net.Analysis.Token</a></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>The position in the array to get the offsets from </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An array of <a class="el" href="struct_lucene_1_1_net_1_1_index_1_1_term_vector_offset_info.html" title="The TermVectorOffsetInfo class holds information pertaining to a Term in a Lucene.Net.Index.TermPositionVector&#39;s offset information. This offset information is the character offset as set during the Analysis phase (and thus may not be the actual offset in the original content). ">TermVectorOffsetInfo</a> objects or the empty list </dd></dl>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_term_position_vector.html#a7fdc8f6f27da3f86ded77cb2d6d6edfe">Lucene.Net.Index.SegmentTermPositionVector</a>.</p>
</div>
</div>
<a class="anchor" id="a0fdf7e199cd02ab8bc6b767b75bf0ca2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int [] Lucene.Net.Index.TermPositionVector.GetTermPositions </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>index</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of positions in which the term is found. Terms are identified by the index at which its number appears in the term String array obtained from the <code>indexOf</code> method. May return null if positions have not been stored. </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_segment_term_position_vector.html#a4d0421ecab9b04babb00240e2c0ee9b1">Lucene.Net.Index.SegmentTermPositionVector</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>core/Index/<a class="el" href="_term_position_vector_8cs_source.html">TermPositionVector.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>