Package org.apache.lucene.search.highlight

# Interface Formatter

All Known Implementing Classes:
  `GradientFormatter`, `SimpleHTMLFormatter`, `SpanGradientFormatter`

public interface Formatter
Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages.

## Method Summary

Modifier and Type
Method
Description
`String`
`highlightTerm(String originalText, TokenGroup tokenGroup)`

## Method Details

### highlightTerm

String highlightTerm(String originalText, TokenGroup tokenGroup)

Parameters:
  `originalText` - The section of text being considered for markup
  `tokenGroup` - contains one or several overlapping Tokens along with their scores and positions.