org.apache.solr.highlight
Class SolrHighlighter
java.lang.Object
org.apache.solr.highlight.SolrHighlighter
- Direct Known Subclasses:
- DefaultSolrHighlighter, PostingsSolrHighlighter
public abstract class SolrHighlighter
- extends Object
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
DEFAULT_PHRASE_LIMIT
public static int DEFAULT_PHRASE_LIMIT
log
public static org.slf4j.Logger log
SolrHighlighter
public SolrHighlighter()
initalize
@Deprecated
public abstract void initalize(SolrConfig config)
- Deprecated.
isHighlightingEnabled
public boolean isHighlightingEnabled(SolrParams params)
- Check whether Highlighting is enabled for this request.
- Parameters:
params
- The params controlling Highlighting
- Returns:
true
if highlighting enabled, false
if not.
getHighlightFields
public String[] getHighlightFields(Query query,
SolrQueryRequest request,
String[] defaultFields)
- Return a String array of the fields to be highlighted.
Falls back to the programatic defaults, or the default search field if the list of fields
is not specified in either the handler configuration or the request.
- Parameters:
query
- The current Queryrequest
- The current SolrQueryRequestdefaultFields
- Programmatic default highlight fields, used if nothing is specified in the handler config or the request.
emptyArray
protected boolean emptyArray(String[] arr)
doHighlighting
public abstract NamedList<Object> doHighlighting(DocList docs,
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.
- Parameters:
docs
- query resultsquery
- the queryreq
- the current requestdefaultFields
- default list of fields to summarize
- Returns:
- NamedList containing a NamedList for each document, which in
turns contains sets (field, summary) pairs.
- Throws:
IOException
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.