org.apache.solr.highlight

Class DefaultSolrHighlighter

java.lang.Object

org.apache.solr.highlight.SolrHighlighter

org.apache.solr.highlight.DefaultSolrHighlighter

All Implemented Interfaces:

PluginInfoInitialized

Direct Known Subclasses:

SolrHighlighterX

public class DefaultSolrHighlighter
extends SolrHighlighter
implements PluginInfoInitialized

Since:

solr 1.3

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	initialized
static org.slf4j.Logger	log
private SolrCore	solrCore

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

boundaryScanners, encoders, formatters, fragListBuilders, fragmenters, fragmentsBuilders

Constructor Summary

Constructors

Constructor and Description
DefaultSolrHighlighter()
DefaultSolrHighlighter(SolrCore solrCore)

Method Summary

Modifier and Type	Method and Description
private void	alternateField(NamedList docSummaries, SolrParams params, org.apache.lucene.document.Document doc, java.lang.String fieldName)
private org.apache.lucene.analysis.TokenStream	createAnalyzerTStream(IndexSchema schema, java.lang.String fieldName, java.lang.String docText)
NamedList<java.lang.Object>	doHighlighting(DocList docs, org.apache.lucene.search.Query query, SolrQueryRequest req, java.lang.String[] defaultFields) Generates a list of Highlighted query fragments for each item in a list of documents, or returns null if highlighting is disabled.
private void	doHighlightingByFastVectorHighlighter(org.apache.lucene.search.vectorhighlight.FastVectorHighlighter highlighter, org.apache.lucene.search.vectorhighlight.FieldQuery fieldQuery, SolrQueryRequest req, NamedList docSummaries, int docId, org.apache.lucene.document.Document doc, java.lang.String fieldName)
private void	doHighlightingByHighlighter(org.apache.lucene.search.Query query, SolrQueryRequest req, NamedList docSummaries, int docId, org.apache.lucene.document.Document doc, java.lang.String fieldName)
private org.apache.lucene.search.vectorhighlight.BoundaryScanner	getBoundaryScanner(java.lang.String fieldName, SolrParams params)
protected org.apache.lucene.search.highlight.Encoder	getEncoder(java.lang.String fieldName, SolrParams params) Return an Encoder appropriate for this field.
protected org.apache.lucene.search.highlight.Formatter	getFormatter(java.lang.String fieldName, SolrParams params) Return a Formatter appropriate for this field.
protected org.apache.lucene.search.vectorhighlight.FragListBuilder	getFragListBuilder(java.lang.String fieldName, SolrParams params)
protected org.apache.lucene.search.highlight.Fragmenter	getFragmenter(java.lang.String fieldName, SolrParams params) Return a Fragmenter appropriate for this field.
protected org.apache.lucene.search.vectorhighlight.FragmentsBuilder	getFragmentsBuilder(java.lang.String fieldName, SolrParams params)
protected org.apache.lucene.search.highlight.Highlighter	getHighlighter(org.apache.lucene.search.Query query, java.lang.String fieldName, SolrQueryRequest request) Return a Highlighter appropriate for this field.
protected int	getMaxSnippets(java.lang.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, java.lang.String fieldName, SolrQueryRequest request, org.apache.lucene.analysis.CachingTokenFilter tokenStream) Return a phrase Highlighter appropriate for this field.
private org.apache.lucene.search.highlight.Scorer	getQueryScorer(org.apache.lucene.search.Query query, java.lang.String fieldName, SolrQueryRequest request) Return a Scorer suitable for this Query and field.
private SolrFragmentsBuilder	getSolrFragmentsBuilder(java.lang.String fieldName, SolrParams params)
private org.apache.lucene.search.highlight.QueryScorer	getSpanQueryScorer(org.apache.lucene.search.Query query, java.lang.String fieldName, org.apache.lucene.analysis.TokenStream tokenStream, SolrQueryRequest request) Return a QueryScorer suitable for this Query and field.
void	init(PluginInfo info)
void	initalize(SolrConfig config) Deprecated.
protected boolean	isMergeContiguousFragments(java.lang.String fieldName, SolrParams params) Return whether adjacent fragments should be merged.
private boolean	useFastVectorHighlighter(SolrParams params, IndexSchema schema, java.lang.String fieldName)

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

Field Detail

log

public static org.slf4j.Logger log

solrCore

private SolrCore solrCore

initialized

private boolean initialized

Constructor Detail

DefaultSolrHighlighter

public DefaultSolrHighlighter()

DefaultSolrHighlighter

public DefaultSolrHighlighter(SolrCore solrCore)

Method Detail

init

public void init(PluginInfo info)

Specified by:

init in interface PluginInfoInitialized

initalize

@Deprecated
public void initalize(SolrConfig config)

Deprecated.

Specified by:

initalize in class SolrHighlighter

getPhraseHighlighter

protected org.apache.lucene.search.highlight.Highlighter getPhraseHighlighter(org.apache.lucene.search.Query query,
                                                                              java.lang.String fieldName,
                                                                              SolrQueryRequest request,
                                                                              org.apache.lucene.analysis.CachingTokenFilter tokenStream)
                                                                       throws java.io.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:

java.io.IOException

getHighlighter

protected org.apache.lucene.search.highlight.Highlighter getHighlighter(org.apache.lucene.search.Query query,
                                                                        java.lang.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

getSpanQueryScorer

private org.apache.lucene.search.highlight.QueryScorer getSpanQueryScorer(org.apache.lucene.search.Query query,
                                                                          java.lang.String fieldName,
                                                                          org.apache.lucene.analysis.TokenStream tokenStream,
                                                                          SolrQueryRequest request)
                                                                   throws java.io.IOException

Return a QueryScorer suitable for this Query and field.

Parameters:

query - The current query

tokenStream - document text CachingTokenStream

fieldName - The name of the field

request - The SolrQueryRequest

Throws:

java.io.IOException

getQueryScorer

private org.apache.lucene.search.highlight.Scorer getQueryScorer(org.apache.lucene.search.Query query,
                                                                 java.lang.String fieldName,
                                                                 SolrQueryRequest request)

Return a Scorer suitable for this Query and field.

Parameters:

query - The current query

fieldName - The name of the field

request - The SolrQueryRequest

getMaxSnippets

protected int getMaxSnippets(java.lang.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(java.lang.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(java.lang.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.

getEncoder

protected org.apache.lucene.search.highlight.Encoder getEncoder(java.lang.String fieldName,
                                                                SolrParams params)

Return an Encoder appropriate for this field. If an encoder has not been configured for this field, fall back to the configured default or the solr default (DefaultEncoder).

Parameters:

fieldName - The name of the field

params - The params controlling Highlighting

Returns:

An appropriate Encoder.

getFragmenter

protected org.apache.lucene.search.highlight.Fragmenter getFragmenter(java.lang.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.

getFragListBuilder

protected org.apache.lucene.search.vectorhighlight.FragListBuilder getFragListBuilder(java.lang.String fieldName,
                                                                                      SolrParams params)

getFragmentsBuilder

protected org.apache.lucene.search.vectorhighlight.FragmentsBuilder getFragmentsBuilder(java.lang.String fieldName,
                                                                                        SolrParams params)

getSolrFragmentsBuilder

private SolrFragmentsBuilder getSolrFragmentsBuilder(java.lang.String fieldName,
                                                     SolrParams params)

getBoundaryScanner

private org.apache.lucene.search.vectorhighlight.BoundaryScanner getBoundaryScanner(java.lang.String fieldName,
                                                                                    SolrParams params)

doHighlighting

public NamedList<java.lang.Object> doHighlighting(DocList docs,
                                                  org.apache.lucene.search.Query query,
                                                  SolrQueryRequest req,
                                                  java.lang.String[] defaultFields)
                                           throws java.io.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:

java.io.IOException

useFastVectorHighlighter

private boolean useFastVectorHighlighter(SolrParams params,
                                         IndexSchema schema,
                                         java.lang.String fieldName)

doHighlightingByHighlighter

private void doHighlightingByHighlighter(org.apache.lucene.search.Query query,
                                         SolrQueryRequest req,
                                         NamedList docSummaries,
                                         int docId,
                                         org.apache.lucene.document.Document doc,
                                         java.lang.String fieldName)
                                  throws java.io.IOException

Throws:

java.io.IOException

doHighlightingByFastVectorHighlighter

private void doHighlightingByFastVectorHighlighter(org.apache.lucene.search.vectorhighlight.FastVectorHighlighter highlighter,
                                                   org.apache.lucene.search.vectorhighlight.FieldQuery fieldQuery,
                                                   SolrQueryRequest req,
                                                   NamedList docSummaries,
                                                   int docId,
                                                   org.apache.lucene.document.Document doc,
                                                   java.lang.String fieldName)
                                            throws java.io.IOException

Throws:

java.io.IOException

alternateField

private void alternateField(NamedList docSummaries,
                            SolrParams params,
                            org.apache.lucene.document.Document doc,
                            java.lang.String fieldName)

createAnalyzerTStream

private org.apache.lucene.analysis.TokenStream createAnalyzerTStream(IndexSchema schema,
                                                                     java.lang.String fieldName,
                                                                     java.lang.String docText)
                                                              throws java.io.IOException

Throws:

java.io.IOException