SOLR-2021: Add SolrEncoder plugin to Highlighter

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@981936 13f79535-47bb-0310-9956-ffa450edef68

solr/CHANGES.txt

@@ -220,6 +220,8 @@ New Features
   to dates.  
   (Gijs Kunze, hossman)
 
+* SOLR-2021: Add SolrEncoder plugin to Highlighter. (koji)
+
 Optimizations
 ----------------------
 

solr/example/solr/conf/solrconfig.xml

@@ -978,6 +978,7 @@
      <str name="echoHandler">true</str>
     </lst>
   </requestHandler>
+  
   <searchComponent class="solr.HighlightComponent" name="highlight">
     <highlighting>
       <!-- Configure the standard fragmenter -->
@@ -1008,6 +1009,9 @@
         </lst>
       </formatter>
 
+      <!-- Configure the standard encoder -->
+      <encoder name="html" class="org.apache.solr.highlight.HtmlEncoder" default="true"/>
+
       <!-- Configure the standard fragListBuilder -->
       <fragListBuilder name="simple" class="org.apache.solr.highlight.SimpleFragListBuilder" default="true"/>
 

solr/src/common/org/apache/solr/common/params/HighlightParams.java

@@ -29,6 +29,7 @@ public interface HighlightParams {
   public static final String INCREMENT   = HIGHLIGHT+".increment";
   public static final String MAX_CHARS   = HIGHLIGHT+".maxAnalyzedChars";
   public static final String FORMATTER   = HIGHLIGHT+".formatter";
+  public static final String ENCODER     = HIGHLIGHT+".encoder";
   public static final String FRAGMENTER  = HIGHLIGHT+".fragmenter";
   public static final String FRAG_LIST_BUILDER = HIGHLIGHT+".fragListBuilder";
   public static final String FRAGMENTS_BUILDER = HIGHLIGHT+".fragmentsBuilder";

solr/src/java/org/apache/solr/highlight/DefaultSolrHighlighter.java

@@ -80,6 +80,7 @@ public class DefaultSolrHighlighter extends SolrHighlighter implements PluginInf
 
   public void init(PluginInfo info) {
     formatters.clear();
+    encoders.clear();
     fragmenters.clear();
     fragListBuilders.clear();
     fragmentsBuilders.clear();
@@ -96,6 +97,12 @@ public class DefaultSolrHighlighter extends SolrHighlighter implements PluginInf
     formatters.put("", fmt);
     formatters.put(null, fmt);
 
+    // Load the formatters
+    SolrEncoder enc = solrCore.initPlugins(info.getChildren("encoder"), encoders,SolrEncoder.class,null);
+    if (enc == null) enc = new DefaultEncoder();
+    encoders.put("", enc);
+    encoders.put(null, enc);
+
     // Load the FragListBuilders
     SolrFragListBuilder fragListBuilder = solrCore.initPlugins(info.getChildren("fragListBuilder"),
         fragListBuilders, SolrFragListBuilder.class, null );
@@ -126,6 +133,10 @@ public class DefaultSolrHighlighter extends SolrHighlighter implements PluginInf
     formatters.put("", fmt);
     formatters.put(null, fmt);    
 
+    SolrEncoder enc = new DefaultEncoder();
+    encoders.put("", enc);
+    encoders.put(null, enc);    
+
     SolrFragListBuilder fragListBuilder = new SimpleFragListBuilder();
     fragListBuilders.put( "", fragListBuilder );
     fragListBuilders.put( null, fragListBuilder );
@@ -147,7 +158,10 @@ public class DefaultSolrHighlighter extends SolrHighlighter implements PluginInf
     SolrParams params = request.getParams();
     Highlighter highlighter = null;
     
-    highlighter = new Highlighter(getFormatter(fieldName, params), getSpanQueryScorer(query, fieldName, tokenStream, request));
+    highlighter = new Highlighter(
+        getFormatter(fieldName, params),
+        getEncoder(fieldName, params),
+        getSpanQueryScorer(query, fieldName, tokenStream, request));
     
     highlighter.setTextFragmenter(getFragmenter(fieldName, params));
 
@@ -164,6 +178,7 @@ public class DefaultSolrHighlighter extends SolrHighlighter implements PluginInf
     SolrParams params = request.getParams(); 
     Highlighter highlighter = new Highlighter(
            getFormatter(fieldName, params), 
+           getEncoder(fieldName, params),
            getQueryScorer(query, fieldName, request));
      highlighter.setTextFragmenter(getFragmenter(fieldName, params));
        return highlighter;
@@ -249,6 +264,24 @@ public class DefaultSolrHighlighter extends SolrHighlighter implements PluginInf
     return formatter.getFormatter( fieldName, params );
   }
 
+  /**
+   * Return an {@link org.apache.lucene.search.highlight.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 ({@link org.apache.lucene.search.highlight.DefaultEncoder}).
+   * 
+   * @param fieldName The name of the field
+   * @param params The params controlling Highlighting
+   * @return An appropriate {@link org.apache.lucene.search.highlight.Encoder}.
+   */
+  protected Encoder getEncoder(String fieldName, SolrParams params){
+    String str = params.getFieldParam( fieldName, HighlightParams.ENCODER );
+    SolrEncoder encoder = encoders.get( str );
+    if( encoder == null ) {
+      throw new SolrException( SolrException.ErrorCode.BAD_REQUEST, "Unknown encoder: "+str );
+    }
+    return encoder.getEncoder( fieldName, params );
+  }
+  
   /**
    * Return a {@link org.apache.lucene.search.highlight.Fragmenter} appropriate for this field. If a fragmenter
    * has not been configured for this field, fall back to the configured

solr/src/java/org/apache/solr/highlight/SolrHighlighter.java

@@ -43,6 +43,10 @@ public abstract class SolrHighlighter
   protected final Map<String,SolrFormatter> formatters =
     new HashMap<String, SolrFormatter>();
 
+  // Thread safe registry
+  protected final Map<String,SolrEncoder> encoders =
+    new HashMap<String, SolrEncoder>();
+
   // Thread safe registry
   protected final Map<String,SolrFragmenter> fragmenters =
     new HashMap<String, SolrFragmenter>() ;