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_gradient_formatter.html
blob: 438d72f2bee2a5363dcc3de1e12a684112925509 [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.GradientFormatter 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_gradient_formatter.html">GradientFormatter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.Highlight.GradientFormatter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Formats text with different color intensity depending on the score of the term.
<a href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.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_formatter.html">Lucene.Net.Search.Highlight.IFormatter</a>.</p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_span_gradient_formatter.html">Lucene.Net.Search.Highlight.SpanGradientFormatter</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:a8e9cd06fd87043c18141e50f1f65247f"><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_gradient_formatter.html#a8e9cd06fd87043c18141e50f1f65247f">GradientFormatter</a> (float maxScore, string minForegroundColor, string maxForegroundColor, string minBackgroundColor, string maxBackgroundColor)</td></tr>
<tr class="memdesc:a8e9cd06fd87043c18141e50f1f65247f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the color range for the IDF scores <a href="#a8e9cd06fd87043c18141e50f1f65247f"></a><br/></td></tr>
<tr class="separator:a8e9cd06fd87043c18141e50f1f65247f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b4f3a8217fab56248ace5ac7fafc442"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_gradient_formatter.html#a8b4f3a8217fab56248ace5ac7fafc442">HighlightTerm</a> (string originalText, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a> tokenGroup)</td></tr>
<tr class="separator:a8b4f3a8217fab56248ace5ac7fafc442"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter.html">Lucene.Net.Search.Highlight.IFormatter</a></td></tr>
<tr class="memitem:a3be9a7a66150550600d98b7173865e91 inherit pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter"><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_search_1_1_highlight_1_1_i_formatter.html#a3be9a7a66150550600d98b7173865e91">HighlightTerm</a> (System.String originalText, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a> tokenGroup)</td></tr>
<tr class="separator:a3be9a7a66150550600d98b7173865e91 inherit pub_methods_interface_lucene_1_1_net_1_1_search_1_1_highlight_1_1_i_formatter"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:afd072131c91ac935019b71dfa24d8240"><td class="memItemLeft" align="right" valign="top">static 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_gradient_formatter.html#afd072131c91ac935019b71dfa24d8240">HexToInt</a> (string hex)</td></tr>
<tr class="memdesc:afd072131c91ac935019b71dfa24d8240"><td class="mdescLeft">&#160;</td><td class="mdescRight">Converts a hex string into an int. Integer.parseInt(hex, 16) assumes the input is nonnegative unless there is a preceding minus sign. This method reads the input as twos complement instead, so if the input is 8 bytes long, it will correctly restore a negative int produced by Integer.toHexString() but not neccesarily one produced by Integer.toString(x,16) since that method will produce a string like '-FF' for negative integer values. <a href="#afd072131c91ac935019b71dfa24d8240"></a><br/></td></tr>
<tr class="separator:afd072131c91ac935019b71dfa24d8240"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a1b6873296437ac90756611694b6fadc3"><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_gradient_formatter.html#a1b6873296437ac90756611694b6fadc3">highlightForeground</a></td></tr>
<tr class="separator:a1b6873296437ac90756611694b6fadc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22614f768067dc477953f15fbb0b2ec3"><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_gradient_formatter.html#a22614f768067dc477953f15fbb0b2ec3">highlightBackground</a></td></tr>
<tr class="separator:a22614f768067dc477953f15fbb0b2ec3"><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>Formats text with different color intensity depending on the score of the term. </p>
<p>Definition at line <a class="el" href="_gradient_formatter_8cs_source.html#l00025">25</a> of file <a class="el" href="_gradient_formatter_8cs_source.html">GradientFormatter.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8e9cd06fd87043c18141e50f1f65247f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Search.Highlight.GradientFormatter.GradientFormatter </td>
<td>(</td>
<td class="paramtype">float&#160;</td>
<td class="paramname"><em>maxScore</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>minForegroundColor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>maxForegroundColor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>minBackgroundColor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>maxBackgroundColor</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the color range for the IDF scores</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">maxScore</td><td>The score (and above) displayed as maxColor (See QueryScorer.getMaxWeight which can be used to callibrate scoring scale) </td></tr>
<tr><td class="paramname">minForegroundColor</td><td>The hex color used for representing IDF scores of zero eg #FFFFFF (white) or null if no foreground color required </td></tr>
<tr><td class="paramname">maxForegroundColor</td><td>The largest hex color used for representing IDF scores eg #000000 (black) or null if no foreground color required </td></tr>
<tr><td class="paramname">minBackgroundColor</td><td>The hex color used for representing IDF scores of zero eg #FFFFFF (white) or null if no background color required </td></tr>
<tr><td class="paramname">maxBackgroundColor</td><td>The largest hex color used for representing IDF scores eg #000000 (black) or null if no background color required </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_gradient_formatter_8cs_source.html#l00057">57</a> of file <a class="el" href="_gradient_formatter_8cs_source.html">GradientFormatter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="afd072131c91ac935019b71dfa24d8240"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static int Lucene.Net.Search.Highlight.GradientFormatter.HexToInt </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>hex</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts a hex string into an int. Integer.parseInt(hex, 16) assumes the input is nonnegative unless there is a preceding minus sign. This method reads the input as twos complement instead, so if the input is 8 bytes long, it will correctly restore a negative int produced by Integer.toHexString() but not neccesarily one produced by Integer.toString(x,16) since that method will produce a string like '-FF' for negative integer values. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hex</td><td>A string in capital or lower case hex, of no more then 16 characters. </td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">FormatException</td><td>if the string is more than 16 characters long, or if any character is not in the set [0-9a-fA-f]</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="_gradient_formatter_8cs_source.html#l00194">194</a> of file <a class="el" href="_gradient_formatter_8cs_source.html">GradientFormatter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a8b4f3a8217fab56248ace5ac7fafc442"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual string Lucene.Net.Search.Highlight.GradientFormatter.HighlightTerm </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>originalText</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_highlight_1_1_token_group.html">TokenGroup</a>&#160;</td>
<td class="paramname"><em>tokenGroup</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_gradient_formatter_8cs_source.html#l00104">104</a> of file <a class="el" href="_gradient_formatter_8cs_source.html">GradientFormatter.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a22614f768067dc477953f15fbb0b2ec3"></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.GradientFormatter.highlightBackground</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_gradient_formatter_8cs_source.html#l00034">34</a> of file <a class="el" href="_gradient_formatter_8cs_source.html">GradientFormatter.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a1b6873296437ac90756611694b6fadc3"></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.GradientFormatter.highlightForeground</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_gradient_formatter_8cs_source.html#l00031">31</a> of file <a class="el" href="_gradient_formatter_8cs_source.html">GradientFormatter.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="_gradient_formatter_8cs_source.html">GradientFormatter.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>