blob: 7945fd54045736ade8a6dabaec9a0ed653f2cd5a [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.QueryScorer 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_scorer.html">QueryScorer</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_scorer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Highlight.QueryScorer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html" title="Adds to the score for a fragment based on its tokens">IScorer</a> implementation which scores text fragments by the number of unique query terms found. This class converts appropriate <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a>s to <a class="el" href="_span_query_filter_8cs.html#acc785bedc86fa99fa13c32eaf059baab">SpanQuery</a>s and attempts to score only those terms that participated in generating the 'hit' on the document.
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html#details">More...</a></p>
<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:a79bda10ccdf7858edee160b696c63032"><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_scorer.html#a79bda10ccdf7858edee160b696c63032">QueryScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query)</td></tr>
<tr class="memdesc:a79bda10ccdf7858edee160b696c63032"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance <a href="#a79bda10ccdf7858edee160b696c63032"></a><br/></td></tr>
<tr class="separator:a79bda10ccdf7858edee160b696c63032"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abbd39369c4699ca2d0ae9a91e643462c"><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_scorer.html#abbd39369c4699ca2d0ae9a91e643462c">QueryScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, String field)</td></tr>
<tr class="memdesc:abbd39369c4699ca2d0ae9a91e643462c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance <a href="#abbd39369c4699ca2d0ae9a91e643462c"></a><br/></td></tr>
<tr class="separator:abbd39369c4699ca2d0ae9a91e643462c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc7939f1d7f3a8454360f97b7fc9da41"><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_scorer.html#acc7939f1d7f3a8454360f97b7fc9da41">QueryScorer</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 field)</td></tr>
<tr class="memdesc:acc7939f1d7f3a8454360f97b7fc9da41"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance <a href="#acc7939f1d7f3a8454360f97b7fc9da41"></a><br/></td></tr>
<tr class="separator:acc7939f1d7f3a8454360f97b7fc9da41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a507a212c36fb9b0ba520fbc295968479"><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_scorer.html#a507a212c36fb9b0ba520fbc295968479">QueryScorer</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 field, String defaultField)</td></tr>
<tr class="memdesc:a507a212c36fb9b0ba520fbc295968479"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance <a href="#a507a212c36fb9b0ba520fbc295968479"></a><br/></td></tr>
<tr class="separator:a507a212c36fb9b0ba520fbc295968479"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35cda4dd46294b1fd17ac6570422ec08"><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_scorer.html#a35cda4dd46294b1fd17ac6570422ec08">QueryScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html">Query</a> query, String field, String defaultField)</td></tr>
<tr class="memdesc:a35cda4dd46294b1fd17ac6570422ec08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance <a href="#a35cda4dd46294b1fd17ac6570422ec08"></a><br/></td></tr>
<tr class="separator:a35cda4dd46294b1fd17ac6570422ec08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae77c88d78c79be1aed0ba2cd2106d838"><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_scorer.html#ae77c88d78c79be1aed0ba2cd2106d838">QueryScorer</a> (<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a>[] weightedTerms)</td></tr>
<tr class="memdesc:ae77c88d78c79be1aed0ba2cd2106d838"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance <a href="#ae77c88d78c79be1aed0ba2cd2106d838"></a><br/></td></tr>
<tr class="separator:ae77c88d78c79be1aed0ba2cd2106d838"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67151b0beabf0aea2e0805660cf2c097"><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_scorer.html#a67151b0beabf0aea2e0805660cf2c097">GetTokenScore</a> ()</td></tr>
<tr class="memdesc:a67151b0beabf0aea2e0805660cf2c097"><td class="mdescLeft">&#160;</td><td class="mdescRight"><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a386b2f3c2ee1a185730051b984a8c959" title="Called for each token in the current fragment. The Highlighter will increment the TokenStream passed ...">IScorer.GetTokenScore</a></dd></dl>
<a href="#a67151b0beabf0aea2e0805660cf2c097"></a><br/></td></tr>
<tr class="separator:a67151b0beabf0aea2e0805660cf2c097"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f5aa50db1a026318ca0694e826f6463"><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_scorer.html#a9f5aa50db1a026318ca0694e826f6463">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:a9f5aa50db1a026318ca0694e826f6463"><td class="mdescLeft">&#160;</td><td class="mdescRight"><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a403959941cead54e98d2358d38bd0e39" title="Called to init the Scorer with a TokenStream. You can grab references to the attributes you are inter...">IScorer.Init</a></dd></dl>
<a href="#a9f5aa50db1a026318ca0694e826f6463"></a><br/></td></tr>
<tr class="separator:a9f5aa50db1a026318ca0694e826f6463"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99ca8d14ff2ca5bde0b34c42a8d154f4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</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_scorer.html#a99ca8d14ff2ca5bde0b34c42a8d154f4">GetWeightedSpanTerm</a> (String token)</td></tr>
<tr class="memdesc:a99ca8d14ff2ca5bde0b34c42a8d154f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html" title="Lightweight class to hold term, Weight, and positions used for scoring this term. ...">WeightedSpanTerm</a> for the specified token. Useful for passing Span information to a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html" title="Implements the policy for breaking text into multiple fragments for consideration by the Highlighter ...">IFragmenter</a>. <a href="#a99ca8d14ff2ca5bde0b34c42a8d154f4"></a><br/></td></tr>
<tr class="separator:a99ca8d14ff2ca5bde0b34c42a8d154f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a640c5aa7f4fefa01528b893082cce592"><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_scorer.html#a640c5aa7f4fefa01528b893082cce592">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:a640c5aa7f4fefa01528b893082cce592"><td class="mdescLeft">&#160;</td><td class="mdescRight"><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a6bbfff6d8c93feffb959e405210cd5c7" title="Called when a new fragment is started for consideration. ">IScorer.StartFragment</a></dd></dl>
<a href="#a640c5aa7f4fefa01528b893082cce592"></a><br/></td></tr>
<tr class="separator:a640c5aa7f4fefa01528b893082cce592"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4e3020e2121089e869d6997a1884986"><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_scorer.html#af4e3020e2121089e869d6997a1884986">SetWrapIfNotCachingTokenFilter</a> (bool wrap)</td></tr>
<tr class="memdesc:af4e3020e2121089e869d6997a1884986"><td class="mdescLeft">&#160;</td><td class="mdescRight">By default, <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a>s that are not of the type <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> are wrapped in a <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> to ensure an efficient reset - if you are already using a different caching <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> impl and you don't want it to be wrapped, set this to false. <a href="#af4e3020e2121089e869d6997a1884986"></a><br/></td></tr>
<tr class="separator:af4e3020e2121089e869d6997a1884986"><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:ae8edb9f7aafa7add4d4c13416081975b"><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_scorer.html#ae8edb9f7aafa7add4d4c13416081975b">FragmentScore</a><code> [get]</code></td></tr>
<tr class="memdesc:ae8edb9f7aafa7add4d4c13416081975b"><td class="mdescLeft">&#160;</td><td class="mdescRight"><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#adbec56edc4723d754a0a561e13448500">IScorer.FragmentScore</a></dd></dl>
<a href="#ae8edb9f7aafa7add4d4c13416081975b"></a><br/></td></tr>
<tr class="separator:ae8edb9f7aafa7add4d4c13416081975b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f1088d5fa818bbeed6d1df9dbccbc65"><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_scorer.html#a2f1088d5fa818bbeed6d1df9dbccbc65">MaxTermWeight</a><code> [get]</code></td></tr>
<tr class="memdesc:a2f1088d5fa818bbeed6d1df9dbccbc65"><td class="mdescLeft">&#160;</td><td class="mdescRight">The highest weighted term (useful for passing to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html" title="Formats text with different color intensity depending on the score of the term. ">GradientFormatter</a> to set top end of coloring scale). <a href="#a2f1088d5fa818bbeed6d1df9dbccbc65"></a><br/></td></tr>
<tr class="separator:a2f1088d5fa818bbeed6d1df9dbccbc65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c222f6aba96ff08fe04cd5de6000f8e"><td class="memItemLeft" align="right" valign="top">bool&#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_scorer.html#a7c222f6aba96ff08fe04cd5de6000f8e">IsExpandMultiTermQuery</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a7c222f6aba96ff08fe04cd5de6000f8e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls whether or not multi-term queries are expanded against a MemoryIndex <a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>. <a href="#a7c222f6aba96ff08fe04cd5de6000f8e"></a><br/></td></tr>
<tr class="separator:a7c222f6aba96ff08fe04cd5de6000f8e"><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><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html" title="Adds to the score for a fragment based on its tokens">IScorer</a> implementation which scores text fragments by the number of unique query terms found. This class converts appropriate <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a>s to <a class="el" href="_span_query_filter_8cs.html#acc785bedc86fa99fa13c32eaf059baab">SpanQuery</a>s and attempts to score only those terms that participated in generating the 'hit' on the document. </p>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00037">37</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a79bda10ccdf7858edee160b696c63032"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryScorer.QueryScorer </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>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> to use for highlighting</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00058">58</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="abbd39369c4699ca2d0ae9a91e643462c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryScorer.QueryScorer </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>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> to use for highlighting</td></tr>
<tr><td class="paramname">field</td><td>Field to highlight - pass null to ignore fields</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00068">68</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="acc7939f1d7f3a8454360f97b7fc9da41"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryScorer.QueryScorer </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>field</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> to use for highlighting</td></tr>
<tr><td class="paramname">reader</td><td><a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> to use for quasi tf/idf scoring</td></tr>
<tr><td class="paramname">field</td><td>Field to highlight - pass null to ignore fields</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00079">79</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a507a212c36fb9b0ba520fbc295968479"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryScorer.QueryScorer </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>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>defaultField</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> to use for highlighting</td></tr>
<tr><td class="paramname">reader</td><td><a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a> to use for quasi tf/idf scoring</td></tr>
<tr><td class="paramname">field</td><td>Field to highlight - pass null to ignore fields</td></tr>
<tr><td class="paramname">defaultField</td><td>The default field for queries with the field name unspecified</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00091">91</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a35cda4dd46294b1fd17ac6570422ec08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryScorer.QueryScorer </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>field</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>defaultField</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">query</td><td><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_query.html" title="The abstract base class for queries. Instantiable subclasses are: TermQuery MultiTermQuery BooleanQ...">Query</a> to use for highlighting</td></tr>
<tr><td class="paramname">field</td><td>Field to highlight - pass null to ignore fields</td></tr>
<tr><td class="paramname">defaultField</td><td>The default field for queries with the field name unspecified</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00104">104</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="ae77c88d78c79be1aed0ba2cd2106d838"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.QueryScorer.QueryScorer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a>[]&#160;</td>
<td class="paramname"><em>weightedTerms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_query_scorer.html" title="IScorer implementation which scores text fragments by the number of unique query terms found...">QueryScorer</a> instance </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">weightedTerms</td><td>an array of pre-created <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html" title="Lightweight class to hold term, Weight, and positions used for scoring this term. ...">WeightedSpanTerm</a>s</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00114">114</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a67151b0beabf0aea2e0805660cf2c097"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Lucene.Net.Search.Highlight.QueryScorer.GetTokenScore </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a386b2f3c2ee1a185730051b984a8c959" title="Called for each token in the current fragment. The Highlighter will increment the TokenStream passed ...">IScorer.GetTokenScore</a></dd></dl>
</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_scorer_8cs_source.html#l00149">149</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a99ca8d14ff2ca5bde0b34c42a8d154f4"></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_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a> Lucene.Net.Search.Highlight.QueryScorer.GetWeightedSpanTerm </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>token</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html" title="Lightweight class to hold term, Weight, and positions used for scoring this term. ...">WeightedSpanTerm</a> for the specified token. Useful for passing Span information to a <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_fragmenter.html" title="Implements the policy for breaking text into multiple fragments for consideration by the Highlighter ...">IFragmenter</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td>token to get <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html">WeightedSpanTerm</a> for</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_weighted_span_term.html" title="Lightweight class to hold term, Weight, and positions used for scoring this term. ...">WeightedSpanTerm</a> for token</dd></dl>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00202">202</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a9f5aa50db1a026318ca0694e826f6463"></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.QueryScorer.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><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a403959941cead54e98d2358d38bd0e39" title="Called to init the Scorer with a TokenStream. You can grab references to the attributes you are inter...">IScorer.Init</a></dd></dl>
</p>
<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_scorer_8cs_source.html#l00180">180</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af4e3020e2121089e869d6997a1884986"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.QueryScorer.SetWrapIfNotCachingTokenFilter </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>wrap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>By default, <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a>s that are not of the type <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> are wrapped in a <a class="el" href="_query_parser_8cs.html#a6b125de7dbff35724b7a50ca1188b182">CachingTokenFilter</a> to ensure an efficient reset - if you are already using a different caching <a class="el" href="_attribute_source_8cs.html#a205730fc8c2839cf92051d131140dae0">TokenStream</a> impl and you don't want it to be wrapped, set this to false. </p>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00265">265</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a640c5aa7f4fefa01528b893082cce592"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Lucene.Net.Search.Highlight.QueryScorer.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><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#a6bbfff6d8c93feffb959e405210cd5c7" title="Called when a new fragment is started for consideration. ">IScorer.StartFragment</a></dd></dl>
</p>
<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_scorer_8cs_source.html#l00242">242</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ae8edb9f7aafa7add4d4c13416081975b"></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.QueryScorer.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><dl class="section see"><dt>See Also</dt><dd><a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_scorer.html#adbec56edc4723d754a0a561e13448500">IScorer.FragmentScore</a></dd></dl>
</p>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00136">136</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a7c222f6aba96ff08fe04cd5de6000f8e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Lucene.Net.Search.Highlight.QueryScorer.IsExpandMultiTermQuery</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>Controls whether or not multi-term queries are expanded against a MemoryIndex <a class="el" href="_reader_util_8cs.html#a2a6914ea10bbe06764856e29e5674e66">IndexReader</a>. </p>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00253">253</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a2f1088d5fa818bbeed6d1df9dbccbc65"></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.QueryScorer.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>The highest weighted term (useful for passing to <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html" title="Formats text with different color intensity depending on the score of the term. ">GradientFormatter</a> to set top end of coloring scale). </p>
<p>Definition at line <a class="el" href="_query_scorer_8cs_source.html#l00144">144</a> of file <a class="el" href="_query_scorer_8cs_source.html">QueryScorer.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_scorer_8cs_source.html">QueryScorer.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>