org.apache.solr.highlight
Class DefaultSolrHighlighter

java.lang.Object
  org.apache.solr.highlight.SolrHighlighter
      org.apache.solr.highlight.DefaultSolrHighlighter

public class DefaultSolrHighlighter
extends SolrHighlighter

Since:

solr 1.3

Field Summary

Fields inherited from class org.apache.solr.highlight.SolrHighlighter

formatters, fragmenters, log

Constructor Summary

DefaultSolrHighlighter()

Method Summary

NamedList<Object>	doHighlighting(DocList docs, org.apache.lucene.search.Query query, SolrQueryRequest req, String[] defaultFields) Generates a list of Highlighted query fragments for each item in a list of documents, or returns null if highlighting is disabled.
protected org.apache.lucene.search.highlight.Formatter	getFormatter(String fieldName, SolrParams params) Return a formatter appropriate for this field.
protected org.apache.lucene.search.highlight.Fragmenter	getFragmenter(String fieldName, SolrParams params) Return a fragmenter appropriate for this field.
protected org.apache.lucene.search.highlight.Highlighter	getHighlighter(org.apache.lucene.search.Query query, String fieldName, SolrQueryRequest request) Return a Highlighter appropriate for this field.
protected int	getMaxSnippets(String fieldName, SolrParams params) Return the max number of snippets for this field.
protected org.apache.lucene.search.highlight.Highlighter	getPhraseHighlighter(org.apache.lucene.search.Query query, String fieldName, SolrQueryRequest request, org.apache.lucene.analysis.CachingTokenFilter tokenStream) Return a phrase Highlighter appropriate for this field.
protected org.apache.lucene.search.highlight.QueryScorer	getQueryScorer(org.apache.lucene.search.Query query, String fieldName, SolrQueryRequest request) Return a QueryScorer suitable for this Query and field.
void	initalize(Config config)
protected boolean	isMergeContiguousFragments(String fieldName, SolrParams params) Return whether adjacent fragments should be merged.

Methods inherited from class org.apache.solr.highlight.SolrHighlighter

emptyArray, getHighlightFields, isHighlightingEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSolrHighlighter

public DefaultSolrHighlighter()

Method Detail

initalize

public void initalize(Config config)

Specified by:

initalize in class SolrHighlighter

getPhraseHighlighter

protected org.apache.lucene.search.highlight.Highlighter getPhraseHighlighter(org.apache.lucene.search.Query query,
                                                                              String fieldName,
                                                                              SolrQueryRequest request,
                                                                              org.apache.lucene.analysis.CachingTokenFilter tokenStream)
                                                                       throws IOException

Return a phrase Highlighter appropriate for this field.

Parameters:

query - The current Query

fieldName - The name of the field

request - The current SolrQueryRequest

tokenStream - document text CachingTokenStream

Throws:

IOException

getHighlighter

protected org.apache.lucene.search.highlight.Highlighter getHighlighter(org.apache.lucene.search.Query query,
                                                                        String fieldName,
                                                                        SolrQueryRequest request)

Return a Highlighter appropriate for this field.

Parameters:

query - The current Query

fieldName - The name of the field

request - The current SolrQueryRequest

getQueryScorer

protected org.apache.lucene.search.highlight.QueryScorer getQueryScorer(org.apache.lucene.search.Query query,
                                                                        String fieldName,
                                                                        SolrQueryRequest request)

Return a QueryScorer suitable for this Query and field.

Parameters:

query - The current query

fieldName - The name of the field

request - The SolrQueryRequest

getMaxSnippets

protected int getMaxSnippets(String fieldName,
                             SolrParams params)

Return the max number of snippets for this field. If this has not been configured for this field, fall back to the configured default or the solr default.

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

isMergeContiguousFragments

protected boolean isMergeContiguousFragments(String fieldName,
                                             SolrParams params)

Return whether adjacent fragments should be merged.

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

getFormatter

protected org.apache.lucene.search.highlight.Formatter getFormatter(String fieldName,
                                                                    SolrParams params)

Return a formatter appropriate for this field. If a formatter has not been configured for this field, fall back to the configured default or the solr default (SimpleHTMLFormatter).

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

Returns:

An appropriate Formatter.

getFragmenter

protected org.apache.lucene.search.highlight.Fragmenter getFragmenter(String fieldName,
                                                                      SolrParams params)

Return a fragmenter appropriate for this field. If a fragmenter has not been configured for this field, fall back to the configured default or the solr default (GapFragmenter).

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

Returns:

An appropriate Fragmenter.

doHighlighting

public NamedList<Object> doHighlighting(DocList docs,
                                        org.apache.lucene.search.Query query,
                                        SolrQueryRequest req,
                                        String[] defaultFields)
                                 throws IOException

Generates a list of Highlighted query fragments for each item in a list of documents, or returns null if highlighting is disabled.

Specified by:

doHighlighting in class SolrHighlighter

Parameters:

docs - query results

query - the query

req - the current request

defaultFields - default list of fields to summarize

Returns:

NamedList containing a NamedList for each document, which in turns contains sets (field, summary) pairs.

Throws:

IOException