org.apache.solr.handler.component

Class AlfrescoSolrHighlighter

java.lang.Object

org.apache.solr.highlight.SolrHighlighter

org.apache.solr.handler.component.AlfrescoSolrHighlighter

All Implemented Interfaces:

org.apache.solr.util.plugin.PluginInfoInitialized

public class AlfrescoSolrHighlighter
extends org.apache.solr.highlight.SolrHighlighter
implements org.apache.solr.util.plugin.PluginInfoInitialized

Author:

Andy

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,org.apache.solr.highlight.SolrBoundaryScanner>	boundaryScanners
protected Map<String,org.apache.solr.highlight.SolrEncoder>	encoders
protected Map<String,org.apache.solr.highlight.SolrFormatter>	formatters
protected Map<String,org.apache.solr.highlight.SolrFragListBuilder>	fragListBuilders
protected Map<String,org.apache.solr.highlight.SolrFragmenter>	fragmenters
protected Map<String,org.apache.solr.highlight.SolrFragmentsBuilder>	fragmentsBuilders

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

DEFAULT_PHRASE_LIMIT, log

Constructor Summary

Constructors

Constructor and Description
AlfrescoSolrHighlighter()
AlfrescoSolrHighlighter(org.apache.solr.core.SolrCore solrCore)

Method Summary

Modifier and Type	Method and Description
org.apache.solr.common.util.NamedList<Object>	doHighlighting(org.apache.solr.search.DocList docs, org.apache.lucene.search.Query query, org.apache.solr.request.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.Encoder	getEncoder(String fieldName, org.apache.solr.common.params.SolrParams params) Return an Encoder appropriate for this field.
protected org.apache.lucene.search.highlight.Formatter	getFormatter(String fieldName, org.apache.solr.common.params.SolrParams params) Return a Formatter appropriate for this field.
protected org.apache.lucene.search.vectorhighlight.FragListBuilder	getFragListBuilder(String fieldName, org.apache.solr.common.params.SolrParams params)
protected org.apache.lucene.search.highlight.Fragmenter	getFragmenter(String fieldName, org.apache.solr.common.params.SolrParams params) Return a Fragmenter appropriate for this field.
protected org.apache.lucene.search.vectorhighlight.FragmentsBuilder	getFragmentsBuilder(String fieldName, org.apache.solr.common.params.SolrParams params)
protected org.apache.lucene.search.highlight.Highlighter	getHighlighter(org.apache.lucene.search.Query query, String requestFieldname, String schemaFieldName, org.apache.solr.request.SolrQueryRequest request) Return a Highlighter appropriate for this field.
protected int	getMaxSnippets(String fieldName, org.apache.solr.common.params.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 requestFieldname, String schemaFieldName, org.apache.solr.request.SolrQueryRequest request, org.apache.lucene.analysis.CachingTokenFilter tokenStream) Return a phrase Highlighter appropriate for this field.
void	init(org.apache.solr.core.PluginInfo info)
void	initalize(org.apache.solr.core.SolrConfig config) Deprecated.
protected boolean	isMergeContiguousFragments(String fieldName, org.apache.solr.common.params.SolrParams params) Return whether adjacent fragments should be merged.
static String	locateContentHome(String solrHome)

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

formatters

protected final Map<String,org.apache.solr.highlight.SolrFormatter> formatters

encoders

protected final Map<String,org.apache.solr.highlight.SolrEncoder> encoders

fragmenters

protected final Map<String,org.apache.solr.highlight.SolrFragmenter> fragmenters

fragListBuilders

protected final Map<String,org.apache.solr.highlight.SolrFragListBuilder> fragListBuilders

fragmentsBuilders

protected final Map<String,org.apache.solr.highlight.SolrFragmentsBuilder> fragmentsBuilders

boundaryScanners

protected final Map<String,org.apache.solr.highlight.SolrBoundaryScanner> boundaryScanners

Constructor Detail

AlfrescoSolrHighlighter

public AlfrescoSolrHighlighter()

AlfrescoSolrHighlighter

public AlfrescoSolrHighlighter(org.apache.solr.core.SolrCore solrCore)

Method Detail

locateContentHome

public static String locateContentHome(String solrHome)

init

public void init(org.apache.solr.core.PluginInfo info)

Specified by:

init in interface org.apache.solr.util.plugin.PluginInfoInitialized

initalize

@Deprecated
public void initalize(org.apache.solr.core.SolrConfig config)

Deprecated.

Specified by:

initalize in class org.apache.solr.highlight.SolrHighlighter

getPhraseHighlighter

protected org.apache.lucene.search.highlight.Highlighter getPhraseHighlighter(org.apache.lucene.search.Query query,
                                                                              String requestFieldname,
                                                                              String schemaFieldName,
                                                                              org.apache.solr.request.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 - If there is a low-level I/O error.

getHighlighter

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

Return a Highlighter appropriate for this field.

Parameters:

query - The current Query

fieldName - The name of the field

request - The current SolrQueryRequest

getMaxSnippets

protected int getMaxSnippets(String fieldName,
                             org.apache.solr.common.params.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,
                                             org.apache.solr.common.params.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,
                                                                    org.apache.solr.common.params.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(String fieldName,
                                                                org.apache.solr.common.params.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(String fieldName,
                                                                      org.apache.solr.common.params.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(String fieldName,
                                                                                      org.apache.solr.common.params.SolrParams params)

getFragmentsBuilder

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

doHighlighting

public org.apache.solr.common.util.NamedList<Object> doHighlighting(org.apache.solr.search.DocList docs,
                                                                    org.apache.lucene.search.Query query,
                                                                    org.apache.solr.request.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 org.apache.solr.highlight.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