org.apache.jackrabbit.core.query.lucene
Interface HighlightingExcerptProvider

All Superinterfaces:

ExcerptProvider

All Known Implementing Classes:

AbstractExcerpt, DefaultHTMLExcerpt, DefaultXMLExcerpt, WeightedHTMLExcerpt, WeightedXMLExcerpt

public interface HighlightingExcerptProvider
extends ExcerptProvider

HighlightingExcerptProvider extends the ExcerptProvider interface with a method that highlights matching terms in arbitrary text.

Field Summary

Fields inherited from interface org.apache.jackrabbit.core.query.lucene.ExcerptProvider

REP_EXCERPT

Method Summary

java.lang.String

highlight(java.lang.String text) Highlights the matching terms in the passed text.

Methods inherited from interface org.apache.jackrabbit.core.query.lucene.ExcerptProvider

getExcerpt, init

Method Detail

highlight

java.lang.String highlight(java.lang.String text)
                           throws java.io.IOException

Highlights the matching terms in the passed text.

Parameters:

text - the input text.

Returns:

the highlighted text.

Throws:

java.io.IOException - if an error occurs while highlighting the text.