From 504afdb6c793b4b2e7ce29f5fc068a5e3b79caa5 Mon Sep 17 00:00:00 2001
From: abhidemon <abhishek.singh@unbxd.com>
Date: Mon, 10 Jul 2017 13:07:35 +0530
Subject: [PATCH] feat: Separate SuggestModes for WordBreak and WordJoin

We should be able to specify suggestModes for WordBreakSolrspellChecker, and also separately for

WordBreak and WordJoin. The feature will let `WordJoin` and `WordBreak` override the suggestMode if

they have been specified OR use their parents, if not set.
---
 .../spelling/WordBreakSolrSpellChecker.java   | 49 +++++++++++++++++--
 1 file changed, 45 insertions(+), 4 deletions(-)

diff --git a/solr/core/src/java/org/apache/solr/spelling/WordBreakSolrSpellChecker.java b/solr/core/src/java/org/apache/solr/spelling/WordBreakSolrSpellChecker.java
index f96233fd551d..ec3cadf323b8 100644
--- a/solr/core/src/java/org/apache/solr/spelling/WordBreakSolrSpellChecker.java
+++ b/solr/core/src/java/org/apache/solr/spelling/WordBreakSolrSpellChecker.java
@@ -18,6 +18,7 @@
 
 import java.io.IOException;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
@@ -27,6 +28,7 @@
 import org.apache.lucene.index.IndexReader;
 import org.apache.lucene.index.Term;
 import org.apache.lucene.search.spell.CombineSuggestion;
+import org.apache.lucene.search.spell.SuggestMode;
 import org.apache.lucene.search.spell.SuggestWord;
 import org.apache.lucene.search.spell.WordBreakSpellChecker;
 import org.apache.lucene.search.spell.WordBreakSpellChecker.BreakSuggestionSortMethod;
@@ -89,7 +91,19 @@ public class WordBreakSolrSpellChecker extends SolrSpellChecker {
    * See {@link WordBreakSpellChecker#setMinSuggestionFrequency}
    */
   public static final String PARAM_MIN_SUGGESTION_FREQUENCY = "minSuggestionFreq";
-  
+  /**
+   * SuggestMode for WordBreakSolrSpellChecker : If set, will override the SpellCheckComponent's SuggestMode
+   */
+  public static final String PARAM_SUGGEST_MODE = "suggestMode";
+  /**
+   * SuggestMode specific to Breaking words : If set, will override all other SuggestModes while breaking words.
+   */
+  public static final String PARAM_WB_SUGGEST_MODE = "wordBreakSuggestMode";
+  /**
+   * SuggestMode specific to Joining Words : If set, will override all other SuggestModes while joining words
+   */
+  public static final String PARAM_WJ_SUGGEST_MODE = "joinWordsSuggestMode";
+
   /**
    * <p>
    *  Specify a value on the "breakSugestionTieBreaker" parameter.
@@ -113,15 +127,37 @@ public enum BreakSuggestionTieBreaker {
   private WordBreakSpellChecker wbsp = null;
   private boolean combineWords = false;
   private boolean breakWords = false;
+  private SuggestMode wordBreakSuggestMode = null;
+  private SuggestMode combineWordsSuggestMode = null;
+
   private BreakSuggestionSortMethod sortMethod = BreakSuggestionSortMethod.NUM_CHANGES_THEN_MAX_FREQUENCY;
   private static final Pattern spacePattern = Pattern.compile("\\s+");
 
+  private SuggestMode getSuggestModeFromParam(String paramName, NamedList config, SuggestMode defaultSugMode){
+    if (config.get(paramName)!=null){
+      try{
+        return SuggestMode.valueOf(strParam(config, paramName));
+      } catch (IllegalArgumentException iae){
+        String errMsg = "Error initialising " + this.getClass().getName()
+                + ". Invalid `suggestMode` : '" + strParam(config, paramName)
+                + "' . Permitted Values: " + Arrays.asList(SuggestMode.values());
+        throw new IllegalArgumentException(errMsg);
+      }
+    }
+    return defaultSugMode;
+  }
+
   @Override
   public String init(@SuppressWarnings("unchecked") NamedList config,
       SolrCore core) {
     String name = super.init(config, core);
     combineWords = boolParam(config, PARAM_COMBINE_WORDS);
     breakWords = boolParam(config, PARAM_BREAK_WORDS);
+    // The default SuggestMode of the spellcheck component will be overridden by `suggestMode` of the WordBreakSolrSpellChekcer (if not null).
+    // Which can be overridden by the suggestModes for WordBreak and WordJoin Respectively.
+    SuggestMode suggestMode = getSuggestModeFromParam(PARAM_SUGGEST_MODE, config, null);
+    combineWordsSuggestMode = getSuggestModeFromParam(PARAM_WJ_SUGGEST_MODE, config, suggestMode);
+    wordBreakSuggestMode    = getSuggestModeFromParam(PARAM_WB_SUGGEST_MODE, config, suggestMode);
     wbsp = new WordBreakSpellChecker();
     String bstb = strParam(config, PARAM_BREAK_SUGGESTION_TIE_BREAKER);
     if (bstb != null) {
@@ -226,9 +262,12 @@ public SpellingResult getSuggestions(SpellingOptions options)
       Term thisTerm = new Term(field, tokenArr[i].toString());
       termArr.add(thisTerm);
       tokenArrWithSeparators.add(tokenArr[i]);
+      if ( wordBreakSuggestMode == null ){
+        wordBreakSuggestMode = options.suggestMode;
+      }
       if (breakWords) {
         SuggestWord[][] breakSuggestions = wbsp.suggestWordBreaks(thisTerm,
-            numSuggestions, ir, options.suggestMode, sortMethod);
+            numSuggestions, ir, wordBreakSuggestMode, sortMethod);
         if(breakSuggestions.length==0) {
           noBreakSuggestionList.add(new ResultEntry(tokenArr[i], null, 0));
         }
@@ -254,10 +293,12 @@ public SpellingResult getSuggestions(SpellingOptions options)
       }
     }
     breakSuggestionList.addAll(noBreakSuggestionList);
-    
+    if (combineWordsSuggestMode == null){
+      combineWordsSuggestMode = options.suggestMode;
+    }
     List<ResultEntry> combineSuggestionList = Collections.emptyList();
     CombineSuggestion[] combineSuggestions = wbsp.suggestWordCombinations(
-        termArr.toArray(new Term[termArr.size()]), numSuggestions, ir, options.suggestMode);
+        termArr.toArray(new Term[termArr.size()]), numSuggestions, ir, combineWordsSuggestMode);
     if (combineWords) {
       combineSuggestionList = new ArrayList<>(
           combineSuggestions.length);