Package ubic.gemma.core.search

Class DefaultHighlighter

java.lang.Object

ubic.gemma.core.search.DefaultHighlighter

All Implemented Interfaces:

Highlighter, LuceneHighlighter, OntologyHighlighter

public class DefaultHighlighter
extends Object
implements LuceneHighlighter, OntologyHighlighter

Constructor Summary

Constructors

Constructor	Description
DefaultHighlighter()
DefaultHighlighter(org.apache.lucene.search.highlight.Formatter formatter)

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.highlight.Formatter	getFormatter()	Obtain a formatter for highlights.
Map<String,String>	highlight(String value, String field)	Produce a highlight for a given field.
Map<String,String>	highlightDocument(org.apache.lucene.document.Document document, org.apache.lucene.search.highlight.Highlighter highlighter, org.apache.lucene.analysis.Analyzer analyzer)	Highlight a given Lucene document.
Map<String,String>	highlightTerm(String termUri, String termLabel, String field)	Produce a highlight for a given ontology term.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHighlighter

public DefaultHighlighter()

DefaultHighlighter

public DefaultHighlighter(org.apache.lucene.search.highlight.Formatter formatter)

Method Detail

highlight

public Map<String,String> highlight(String value,
                                          String field)

Description copied from interface: Highlighter

Produce a highlight for a given field.

Specified by:

highlight in interface Highlighter

highlightTerm

public Map<String,String> highlightTerm(@Nullable
                                              String termUri,
                                              String termLabel,
                                              String field)

Description copied from interface: OntologyHighlighter

Produce a highlight for a given ontology term.

Specified by:

highlightTerm in interface OntologyHighlighter

Parameters:

termUri - a URI for the term or null for a full-text term

termLabel - a label for the term

field - an object path through which the term was found

Returns:

a suitable highlight, or null if none is found

getFormatter

public org.apache.lucene.search.highlight.Formatter getFormatter()

Description copied from interface: LuceneHighlighter

Obtain a formatter for highlights.

Specified by:

getFormatter in interface LuceneHighlighter

highlightDocument

public Map<String,String> highlightDocument(org.apache.lucene.document.Document document,
                                                  org.apache.lucene.search.highlight.Highlighter highlighter,
                                                  org.apache.lucene.analysis.Analyzer analyzer)

Description copied from interface: LuceneHighlighter

Highlight a given Lucene document.

Specified by:

highlightDocument in interface LuceneHighlighter