org.apache.lucene.search.highlight

Class SpanGradientFormatter

Implemented Interfaces:
Formatter

public class SpanGradientFormatter
extends GradientFormatter

Formats text with different color intensity depending on the score of the term using the span tag. GradientFormatter uses a bgcolor argument to the font tag which doesn't work in Mozilla, thus this class.
Author:
David Spencer dave@searchmorph.com
See Also:
GradientFormatter

Field Summary

Fields inherited from class org.apache.lucene.search.highlight.GradientFormatter

highlightBackground, highlightForeground

Constructor Summary

SpanGradientFormatter(float maxScore, String minForegroundColor, String maxForegroundColor, String minBackgroundColor, String maxBackgroundColor)

Method Summary

String
highlightTerm(String originalText, TokenGroup tokenGroup)

Methods inherited from class org.apache.lucene.search.highlight.GradientFormatter

getBackgroundColorString, getForegroundColorString, hexToInt, highlightTerm

Constructor Details

SpanGradientFormatter

public SpanGradientFormatter(float maxScore,
                             String minForegroundColor,
                             String maxForegroundColor,
                             String minBackgroundColor,
                             String maxBackgroundColor)

Method Details

highlightTerm

public String highlightTerm(String originalText,
                            TokenGroup tokenGroup)
Specified by:
highlightTerm in interface Formatter
Overrides:
highlightTerm in interface GradientFormatter
Parameters:
originalText - The section of text being considered for markup
tokenGroup - contains one or several overlapping Tokens along with their scores and positions.

Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.