public abstract class SolrHighlighter
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
protected java.util.Map<java.lang.String,SolrBoundaryScanner> |
boundaryScanners |
protected java.util.Map<java.lang.String,SolrEncoder> |
encoders |
protected java.util.Map<java.lang.String,SolrFormatter> |
formatters |
protected java.util.Map<java.lang.String,SolrFragListBuilder> |
fragListBuilders |
protected java.util.Map<java.lang.String,SolrFragmenter> |
fragmenters |
protected java.util.Map<java.lang.String,SolrFragmentsBuilder> |
fragmentsBuilders |
static org.slf4j.Logger |
log |
Constructor and Description |
---|
SolrHighlighter() |
Modifier and Type | Method and Description |
---|---|
abstract 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.
|
protected boolean |
emptyArray(java.lang.String[] arr) |
java.lang.String[] |
getHighlightFields(org.apache.lucene.search.Query query,
SolrQueryRequest request,
java.lang.String[] defaultFields)
Return a String array of the fields to be highlighted.
|
abstract void |
initalize(SolrConfig config)
Deprecated.
|
boolean |
isHighlightingEnabled(SolrParams params)
Check whether Highlighting is enabled for this request.
|
public static org.slf4j.Logger log
protected final java.util.Map<java.lang.String,SolrFormatter> formatters
protected final java.util.Map<java.lang.String,SolrEncoder> encoders
protected final java.util.Map<java.lang.String,SolrFragmenter> fragmenters
protected final java.util.Map<java.lang.String,SolrFragListBuilder> fragListBuilders
protected final java.util.Map<java.lang.String,SolrFragmentsBuilder> fragmentsBuilders
protected final java.util.Map<java.lang.String,SolrBoundaryScanner> boundaryScanners
@Deprecated public abstract void initalize(SolrConfig config)
public boolean isHighlightingEnabled(SolrParams params)
params
- The params controlling Highlightingtrue
if highlighting enabled, false
if not.public java.lang.String[] getHighlightFields(org.apache.lucene.search.Query query, SolrQueryRequest request, java.lang.String[] defaultFields)
query
- The current Queryrequest
- The current SolrQueryRequestdefaultFields
- Programmatic default highlight fields, used if nothing is specified in the handler config or the request.protected boolean emptyArray(java.lang.String[] arr)
public abstract NamedList<java.lang.Object> doHighlighting(DocList docs, org.apache.lucene.search.Query query, SolrQueryRequest req, java.lang.String[] defaultFields) throws java.io.IOException
docs
- query resultsquery
- the queryreq
- the current requestdefaultFields
- default list of fields to summarizejava.io.IOException