HitHighlighter

extends Object

java.lang.Object
↳	com.atlassian.confluence.search.summary.HitHighlighter

Class Overview

Finds search hits in content based on a given Lucene query. Highlights those hits with a formatter. This class is not thread safe.

Summary

Public Constructors
	HitHighlighter(Query query, Analyzer analyzer) Create a new highlighter that uses the default formatter, and HTML encoding.
	HitHighlighter(Query query, Analyzer analyzer, Formatter formatter) Create a new highlighter with specified formatter with HTML encoding.
	HitHighlighter(Query query, Analyzer analyzer, Formatter formatter, Encoder encoder) Create a new highlighter

Public Methods
String	getBestFragments(String text) Use the Lucene Highlighter directly.
String	getSummary(String text) Get a summary, suitable for displaying excerpts of search results.
String	highlightText(String text) Highlights text without fragmenting it.
String	highlightWikiMarkup(String markup) Highlight text without fragmenting, after stripping wiki markup.
void	setFragmenter(Fragmenter originalFragmenter)
void	setNoFragments()

[Expand]

Inherited Methods

From class java.lang.Object

Public Constructors

public HitHighlighter (Query query, Analyzer analyzer)

Create a new highlighter that uses the default formatter, and HTML encoding. The output format for hit highlights is: Lorem ipsum <span class="search-highlight>dolor</span> sit amet

public HitHighlighter (Query query, Analyzer analyzer, Formatter formatter)

Create a new highlighter with specified formatter with HTML encoding.

public HitHighlighter (Query query, Analyzer analyzer, Formatter formatter, Encoder encoder)

Create a new highlighter

Public Methods

public String getBestFragments (String text)

Use the Lucene Highlighter directly. Text that doesn't match the query will return an empty string.

public String getSummary (String text)

Get a summary, suitable for displaying excerpts of search results.

Returns

a summary, or an empty string if the summary is null or empty.

public String highlightText (String text)

Highlights text without fragmenting it.

public String highlightWikiMarkup (String markup)

Highlight text without fragmenting, after stripping wiki markup.

Classes