org.apache.lucene.search.highlight
Class GradientFormatter
- Formatter
public class GradientFormatter
Formats text with different color intensity depending on the score of the
term.
GradientFormatter(float maxScore, String minForegroundColor, String maxForegroundColor, String minBackgroundColor, String maxBackgroundColor) - Sets the color range for the IDF scores
|
highlightBackground
protected boolean highlightBackground
highlightForeground
protected boolean highlightForeground
GradientFormatter
public GradientFormatter(float maxScore,
String minForegroundColor,
String maxForegroundColor,
String minBackgroundColor,
String maxBackgroundColor)
Sets the color range for the IDF scores
maxScore
- The score (and above) displayed as maxColor (See QueryScorer.getMaxWeight
which can be used to callibrate scoring scale)minForegroundColor
- The hex color used for representing IDF scores of zero eg
#FFFFFF (white) or null if no foreground color requiredmaxForegroundColor
- The largest hex color used for representing IDF scores eg
#000000 (black) or null if no foreground color requiredminBackgroundColor
- The hex color used for representing IDF scores of zero eg
#FFFFFF (white) or null if no background color requiredmaxBackgroundColor
- The largest hex color used for representing IDF scores eg
#000000 (black) or null if no background color required
getBackgroundColorString
protected String getBackgroundColorString(float score)
getForegroundColorString
protected String getForegroundColorString(float score)
hexToInt
public static final int hexToInt(String hex)
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.
hex
- A string in capital or lower case hex, of no more then 16
characters.
highlightTerm
public String highlightTerm(String originalText,
TokenGroup tokenGroup)
- highlightTerm in interface Formatter
originalText
- The section of text being considered for markuptokenGroup
- contains one or several overlapping Tokens along with
their scores and positions.
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.