blob: 7e31ad238e98279c611342f6fda04e8c0231db0f [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.QueryTermScorer 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_query_term_scorer.html">QueryTermScorer</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_query_term_scorer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Highlight.QueryTermScorer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Inherits <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html">Lucene.Net.Search.Highlight.IScorer</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:ac94b422993f5c28fa00d043ba0b9669e"><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_query_term_scorer.html#ac94b422993f5c28fa00d043ba0b9669e">QueryTermScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query)</td></tr>
<tr class="separator:ac94b422993f5c28fa00d043ba0b9669e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0a2731e79180c0d4c1a8a0adfbc6c65"><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_query_term_scorer.html#ab0a2731e79180c0d4c1a8a0adfbc6c65">QueryTermScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, String fieldName)</td></tr>
<tr class="separator:ab0a2731e79180c0d4c1a8a0adfbc6c65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a860e8cfb981030d95a147a9a09f2b425"><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_query_term_scorer.html#a860e8cfb981030d95a147a9a09f2b425">QueryTermScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a> reader, String fieldName)</td></tr>
<tr class="separator:a860e8cfb981030d95a147a9a09f2b425"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c9e5a20be660b323c81c8f814144a92"><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_query_term_scorer.html#a7c9e5a20be660b323c81c8f814144a92">QueryTermScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html">WeightedTerm</a>[] weightedTerms)</td></tr>
<tr class="separator:a7c9e5a20be660b323c81c8f814144a92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f004ec39439ebe080b0a7d9d5956c81"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_analysis_1_1_token_stream.html">TokenStream</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_query_term_scorer.html#a7f004ec39439ebe080b0a7d9d5956c81">Init</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="memdesc:a7f004ec39439ebe080b0a7d9d5956c81"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to init the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> with a <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a>. You can grab references to the attributes you are interested in here and access them from <a class="el" href="">getTokenScore()</a>. <a href="#a7f004ec39439ebe080b0a7d9d5956c81"></a><br/></td></tr>
<tr class="separator:a7f004ec39439ebe080b0a7d9d5956c81"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a228e097ac874e45f285696f8cc148af0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_term_scorer.html#a228e097ac874e45f285696f8cc148af0">StartFragment</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html">TextFragment</a> newFragment)</td></tr>
<tr class="memdesc:a228e097ac874e45f285696f8cc148af0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when a new fragment is started for consideration. <a href="#a228e097ac874e45f285696f8cc148af0"></a><br/></td></tr>
<tr class="separator:a228e097ac874e45f285696f8cc148af0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f60362611d1687e0a3db56e3cd6b7e9"><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_query_term_scorer.html#a5f60362611d1687e0a3db56e3cd6b7e9">GetTokenScore</a> ()</td></tr>
<tr class="memdesc:a5f60362611d1687e0a3db56e3cd6b7e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called for each token in the current fragment. The <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_highlighter.html">Highlighter</a> will increment the <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> passed to init on every call. <a href="#a5f60362611d1687e0a3db56e3cd6b7e9"></a><br/></td></tr>
<tr class="separator:a5f60362611d1687e0a3db56e3cd6b7e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a923672c04403683f347fab4d43b8b4a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_term_scorer.html#a923672c04403683f347fab4d43b8b4a5">AllFragmentsProcessed</a> ()</td></tr>
<tr class="separator:a923672c04403683f347fab4d43b8b4a5"><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:a3a285bda6b8325ed0c02068b7ff68555"><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_query_term_scorer.html#a3a285bda6b8325ed0c02068b7ff68555">FragmentScore</a><code> [get]</code></td></tr>
<tr class="separator:a3a285bda6b8325ed0c02068b7ff68555"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a57d3ac5820af847a2b6dd7a7aa08eace"><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_query_term_scorer.html#a57d3ac5820af847a2b6dd7a7aa08eace">MaxTermWeight</a><code> [get]</code></td></tr>
<tr class="separator:a57d3ac5820af847a2b6dd7a7aa08eace"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header properties_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer"><td colspan="2" onclick="javascript:toggleInherit('properties_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html">Lucene.Net.Search.Highlight.IScorer</a></td></tr>
<tr class="memitem:adbec56edc4723d754a0a561e13448500 inherit properties_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#adbec56edc4723d754a0a561e13448500">FragmentScore</a><code> [get]</code></td></tr>
<tr class="separator:adbec56edc4723d754a0a561e13448500 inherit properties_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer"><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>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00040">40</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac94b422993f5c28fa00d043ba0b9669e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td>
<td class="paramname"><em>query</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00057">57</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ab0a2731e79180c0d4c1a8a0adfbc6c65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>fieldName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00069">69</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a860e8cfb981030d95a147a9a09f2b425"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a>&#160;</td>
<td class="paramname"><em>query</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_reader.html">IndexReader</a>&#160;</td>
<td class="paramname"><em>reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>fieldName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00085">85</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7c9e5a20be660b323c81c8f814144a92"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryTermScorer.QueryTermScorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_term.html">WeightedTerm</a>[]&#160;</td>
<td class="paramname"><em>weightedTerms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00090">90</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a923672c04403683f347fab4d43b8b4a5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.QueryTermScorer.AllFragmentsProcessed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00174">174</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a5f60362611d1687e0a3db56e3cd6b7e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Lucene.Net.Search.Highlight.QueryTermScorer.GetTokenScore </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Called for each token in the current fragment. The <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_highlighter.html">Highlighter</a> will increment the <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> passed to init on every call. </p>
<dl class="section return"><dt>Returns</dt><dd>a score which is passed to the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_highlighter.html">Highlighter</a> class to influence the mark-up of the text (this return value is NOT used to score the fragment)</dd></dl>
<p>summary&gt; Called when the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_highlighter.html">Highlighter</a> has no more tokens for the current fragment - the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> returns the weighting it has derived for the most recent fragment, typically based on the results of <a class="el" href="">getTokenScore()</a>. </p>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a386b2f3c2ee1a185730051b984a8c959">Lucene.Net.Search.Highlight.IScorer</a>.</p>
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00138">138</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7f004ec39439ebe080b0a7d9d5956c81"></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_stream.html">TokenStream</a> Lucene.Net.Search.Highlight.QueryTermScorer.Init </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>Called to init the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html" title="Expert: Common scoring functionality for different types of queries.">Scorer</a> with a <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a>. You can grab references to the attributes you are interested in here and access them from <a class="el" href="">getTokenScore()</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tokenStream</td><td>the <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> that will be scored.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>either a <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> that the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_highlighter.html" title="Class used to markup highlighted terms found in the best sections of a text, using configurable IFrag...">Highlighter</a> should continue using (eg if you read the tokenSream in this method) or null to continue using the same <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> that was passed in. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">IOException</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a403959941cead54e98d2358d38bd0e39">Lucene.Net.Search.Highlight.IScorer</a>.</p>
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00111">111</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a228e097ac874e45f285696f8cc148af0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.QueryTermScorer.StartFragment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_text_fragment.html">TextFragment</a>&#160;</td>
<td class="paramname"><em>newFragment</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Called when a new fragment is started for consideration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">newFragment</td><td>the fragment that will be scored next</td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a6bbfff6d8c93feffb959e405210cd5c7">Lucene.Net.Search.Highlight.IScorer</a>.</p>
<p>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00125">125</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a3a285bda6b8325ed0c02068b7ff68555"></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.QueryTermScorer.FragmentScore</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>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00163">163</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a57d3ac5820af847a2b6dd7a7aa08eace"></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.QueryTermScorer.MaxTermWeight</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>Definition at line <a class="el" href="_query_term_scorer_8cs_source.html#l00186">186</a> of file <a class="el" href="_query_term_scorer_8cs_source.html">QueryTermScorer.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="_query_term_scorer_8cs_source.html">QueryTermScorer.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>