Package ubic.gemma.core.search

Class DefaultHighlighter

java.lang.Object

ubic.gemma.core.search.DefaultHighlighter

All Implemented Interfaces:

Highlighter

public class DefaultHighlighter
extends Object
implements Highlighter

Constructor Summary

Constructors

Constructor	Description
DefaultHighlighter()

Method Summary

Modifier and Type	Method	Description
org.apache.lucene.search.highlight.Highlighter	createLuceneHighlighter(org.apache.lucene.search.highlight.QueryScorer queryScorer)	Obtain a highlighter for Lucene hits to be used with Highlighter.highlightDocument(Document, org.apache.lucene.search.highlight.Highlighter, Analyzer, Set).
Map<String,String>	highlightDocument(org.apache.lucene.document.Document document, org.apache.lucene.search.highlight.Highlighter highlighter, org.apache.lucene.analysis.Analyzer analyzer, Set<String> fields)	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()

Method Detail

highlightTerm

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

Description copied from interface: Highlighter

Produce a highlight for a given ontology term.

Specified by:

highlightTerm in interface Highlighter

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

createLuceneHighlighter

public org.apache.lucene.search.highlight.Highlighter createLuceneHighlighter(org.apache.lucene.search.highlight.QueryScorer queryScorer)

Description copied from interface: Highlighter

Obtain a highlighter for Lucene hits to be used with Highlighter.highlightDocument(Document, org.apache.lucene.search.highlight.Highlighter, Analyzer, Set).

Specified by:

createLuceneHighlighter in interface Highlighter

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,
                                                  Set<String> fields)

Description copied from interface: Highlighter

Highlight a given Lucene document.

Specified by:

highlightDocument in interface Highlighter