Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html
blob: b327a1d5b07532567b0d33282c6031a0583ca972 [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.Highlight.TokenGroup 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_highlight.html">Highlight</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Highlight.TokenGroup Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>One, or several overlapping tokens, along with the score(s) and the scope of the original text
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#details">More...</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:ab89136b5524bc554933c6176f7e5f76a"><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_highlight_1_1_token_group.html#ab89136b5524bc554933c6176f7e5f76a">TokenGroup</a> (<a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a> tokenStream)</td></tr>
<tr class="separator:ab89136b5524bc554933c6176f7e5f76a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2daa98415e4d9f9c58ce40b21eef28b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#ac2daa98415e4d9f9c58ce40b21eef28b">GetToken</a> (int index)</td></tr>
<tr class="memdesc:ac2daa98415e4d9f9c58ce40b21eef28b"><td class="mdescLeft">&#160;</td><td class="mdescRight">the "n"th token <a href="#ac2daa98415e4d9f9c58ce40b21eef28b"></a><br/></td></tr>
<tr class="separator:ac2daa98415e4d9f9c58ce40b21eef28b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af17b5abe6770efdb96f1d0a4042e44bb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#af17b5abe6770efdb96f1d0a4042e44bb">GetScore</a> (int index)</td></tr>
<tr class="memdesc:af17b5abe6770efdb96f1d0a4042e44bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">the "n"th score <a href="#af17b5abe6770efdb96f1d0a4042e44bb"></a><br/></td></tr>
<tr class="separator:af17b5abe6770efdb96f1d0a4042e44bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a54de8e71e3707422a9a6b69afb7bca7b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#a54de8e71e3707422a9a6b69afb7bca7b">MatchStartOffset</a><code> [get, set]</code></td></tr>
<tr class="separator:a54de8e71e3707422a9a6b69afb7bca7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f265b9b93dd3556f574d836a294aae0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#a2f265b9b93dd3556f574d836a294aae0">MatchEndOffset</a><code> [get, set]</code></td></tr>
<tr class="separator:a2f265b9b93dd3556f574d836a294aae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbd1cb5d4f2912c0458060980c7507c1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#afbd1cb5d4f2912c0458060980c7507c1">NumTokens</a><code> [get, set]</code></td></tr>
<tr class="separator:afbd1cb5d4f2912c0458060980c7507c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9d9e646321e03e495ee11cd32f87dcb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#ac9d9e646321e03e495ee11cd32f87dcb">EndOffset</a><code> [get]</code></td></tr>
<tr class="memdesc:ac9d9e646321e03e495ee11cd32f87dcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">the end position in the original text <a href="#ac9d9e646321e03e495ee11cd32f87dcb"></a><br/></td></tr>
<tr class="separator:ac9d9e646321e03e495ee11cd32f87dcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4024be460e8f30a755745e771e2ddda6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#a4024be460e8f30a755745e771e2ddda6">StartOffset</a><code> [get]</code></td></tr>
<tr class="memdesc:a4024be460e8f30a755745e771e2ddda6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The start position in the original text <a href="#a4024be460e8f30a755745e771e2ddda6"></a><br/></td></tr>
<tr class="separator:a4024be460e8f30a755745e771e2ddda6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f2424ae7328d2d39b948e7faf6229d0"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html#a0f2424ae7328d2d39b948e7faf6229d0">TotalScore</a><code> [get]</code></td></tr>
<tr class="memdesc:a0f2424ae7328d2d39b948e7faf6229d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">All tokens' scores summed up <a href="#a0f2424ae7328d2d39b948e7faf6229d0"></a><br/></td></tr>
<tr class="separator:a0f2424ae7328d2d39b948e7faf6229d0"><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>One, or several overlapping tokens, along with the score(s) and the scope of the original text </p>
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00027">27</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab89136b5524bc554933c6176f7e5f76a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.TokenGroup.TokenGroup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</a>&#160;</td>
<td class="paramname"><em>tokenStream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00044">44</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="af17b5abe6770efdb96f1d0a4042e44bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Lucene.Net.Search.Highlight.TokenGroup.GetScore </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>the "n"th score </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>a value between 0 and numTokens -1</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00115">115</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ac2daa98415e4d9f9c58ce40b21eef28b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token.html">Token</a> Lucene.Net.Search.Highlight.TokenGroup.GetToken </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>the "n"th token </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">index</td><td>a value between 0 and numTokens -1</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00106">106</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ac9d9e646321e03e495ee11cd32f87dcb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TokenGroup.EndOffset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>the end position in the original text </p>
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00124">124</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2f265b9b93dd3556f574d836a294aae0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TokenGroup.MatchEndOffset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00038">38</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a54de8e71e3707422a9a6b69afb7bca7b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TokenGroup.MatchStartOffset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00037">37</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<a class="anchor" id="afbd1cb5d4f2912c0458060980c7507c1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TokenGroup.NumTokens</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00039">39</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a4024be460e8f30a755745e771e2ddda6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Lucene.Net.Search.Highlight.TokenGroup.StartOffset</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The start position in the original text </p>
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00132">132</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a0f2424ae7328d2d39b948e7faf6229d0"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Lucene.Net.Search.Highlight.TokenGroup.TotalScore</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>All tokens' scores summed up </p>
<p>Definition at line <a class="el" href="_token_group_8cs_source.html#l00140">140</a> of file <a class="el" href="_token_group_8cs_source.html">TokenGroup.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>contrib/Highlighter/<a class="el" href="_token_group_8cs_source.html">TokenGroup.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>