org.apache.solr.highlight
Class PostingsSolrHighlighter

java.lang.Object
  extended by org.apache.solr.highlight.SolrHighlighter
      extended by org.apache.solr.highlight.PostingsSolrHighlighter
All Implemented Interfaces:
PluginInfoInitialized

public class PostingsSolrHighlighter
extends SolrHighlighter
implements PluginInfoInitialized

Highlighter impl that uses PostingsHighlighter

Example configuration:

   <requestHandler name="standard" class="solr.StandardRequestHandler">
     <lst name="defaults">
       <int name="hl.snippets">1</int>
       <str name="hl.tag.pre">&lt;em&gt;</str>
       <str name="hl.tag.post">&lt;/em&gt;</str>
       <str name="hl.tag.ellipsis">... </str>
       <bool name="hl.defaultSummary">true</bool>
       <str name="hl.encoder">simple</str>
       <float name="hl.score.k1">1.2</float>
       <float name="hl.score.b">0.75</float>
       <float name="hl.score.pivot">87</float>
       <str name="hl.bs.language"></str>
       <str name="hl.bs.country"></str>
       <str name="hl.bs.variant"></str>
       <str name="hl.bs.type">SENTENCE</str>
       <int name="hl.maxAnalyzedChars">10000</int>
       <str name="hl.multiValuedSeparatorChar"> </str>
       <bool name="hl.highlightMultiTerm">false</bool>
     </lst>
   </requestHandler>
 
...
   <searchComponent class="solr.HighlightComponent" name="highlight">
     <highlighting class="org.apache.solr.highlight.PostingsSolrHighlighter"/>
   </searchComponent>
 

Notes:

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary
 
Fields inherited from class org.apache.solr.highlight.SolrHighlighter
DEFAULT_PHRASE_LIMIT, log
 
Constructor Summary
PostingsSolrHighlighter()
           
 
Method Summary
 NamedList<Object> doHighlighting(DocList docs, 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  NamedList<Object> encodeSnippets(String[] keys, String[] fieldNames, Map<String,String[]> snippets)
          Encodes the resulting snippets into a namedlist
protected  String[] getUniqueKeys(SolrIndexSearcher searcher, int[] docIDs)
          Retrieves the unique keys for the topdocs to key the results
 void init(PluginInfo info)
           
 void initalize(SolrConfig config)
           
protected  BreakIterator parseBreakIterator(String type, Locale locale)
          parse a break iterator type for the specified locale
protected  Locale parseLocale(String language, String country, String variant)
          parse a locale from a language+country+variant spec
protected  int[] toDocIDs(DocList docs)
          Converts solr's DocList to the int[] docIDs
 
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

PostingsSolrHighlighter

public PostingsSolrHighlighter()
Method Detail

initalize

public void initalize(SolrConfig config)
Specified by:
initalize in class SolrHighlighter

init

public void init(PluginInfo info)
Specified by:
init in interface PluginInfoInitialized

doHighlighting

public NamedList<Object> doHighlighting(DocList docs,
                                        Query query,
                                        SolrQueryRequest req,
                                        String[] defaultFields)
                                 throws IOException
Description copied from class: SolrHighlighter
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

encodeSnippets

protected NamedList<Object> encodeSnippets(String[] keys,
                                           String[] fieldNames,
                                           Map<String,String[]> snippets)
Encodes the resulting snippets into a namedlist

Parameters:
keys - the document unique keys
fieldNames - field names to highlight in the order
snippets - map from field name to snippet array for the docs
Returns:
encoded namedlist of summaries

toDocIDs

protected int[] toDocIDs(DocList docs)
Converts solr's DocList to the int[] docIDs


getUniqueKeys

protected String[] getUniqueKeys(SolrIndexSearcher searcher,
                                 int[] docIDs)
                          throws IOException
Retrieves the unique keys for the topdocs to key the results

Throws:
IOException

parseBreakIterator

protected BreakIterator parseBreakIterator(String type,
                                           Locale locale)
parse a break iterator type for the specified locale


parseLocale

protected Locale parseLocale(String language,
                             String country,
                             String variant)
parse a locale from a language+country+variant spec



Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.