net.sf.mmm.search.engine.impl.lucene

Class LuceneSearchHighlighter

java.lang.Object

net.sf.mmm.search.engine.impl.lucene.LuceneSearchHighlighter

All Implemented Interfaces:

SearchHighlighter

public class LuceneSearchHighlighter
extends Object
implements SearchHighlighter

This is the implementation of the SearchHighlighter interface using lucene as underlying search-engine.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.analysis.Analyzer	analyzer the lucene analyzer
private org.apache.lucene.search.highlight.Highlighter	highlighter the lucene highlighter

Constructor Summary

Constructors

Constructor and Description
LuceneSearchHighlighter(org.apache.lucene.analysis.Analyzer searchAnalyzer, org.apache.lucene.search.highlight.Formatter formatter, org.apache.lucene.search.Query searchQuery) The constructor.

Method Summary

Modifier and Type	Method and Description
String	getHighlightedText(String text) This method highlights the given text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

highlighter

private final org.apache.lucene.search.highlight.Highlighter highlighter

the lucene highlighter

analyzer

private final org.apache.lucene.analysis.Analyzer analyzer

the lucene analyzer

Constructor Detail

LuceneSearchHighlighter

public LuceneSearchHighlighter(org.apache.lucene.analysis.Analyzer searchAnalyzer,
                               org.apache.lucene.search.highlight.Formatter formatter,
                               org.apache.lucene.search.Query searchQuery)

The constructor.

Parameters:

searchAnalyzer - is the Analyzer used by the search-engine.

formatter - is the formatter used to highlight terms.

searchQuery - is the Query of the search. Matching terms of this query shall be highlighted.

Method Detail

getHighlightedText

public String getHighlightedText(String text)

This method highlights the given text.

Specified by:

getHighlightedText in interface SearchHighlighter

Parameters:

text - is the plain text to highlight.

Returns:

the highlighted text.

See Also:

SearchHit.getHighlightedText()