Improving help search

src/main/java/help/HelpEntry.java

@@ -365,11 +365,11 @@ public class HelpEntry implements GenericTree {
         return s;
     }
 
-    public void searchInKeywords(String [] words, HelpEntry father, Vector<AtomicInteger> scores) {
+    public void searchInKeywords(String [] words, HelpEntry father, Vector<ScoredHelpEntry> scores) {
         int score = hasSimilarWords(words);
         if (score > 0) {
-            father.addKid(this);
-            scores.add(new AtomicInteger(KEYWORD_SEARCH_IMPORTANCE * score));
+            //father.addKid(this);
+            scores.add(new ScoredHelpEntry(KEYWORD_SEARCH_IMPORTANCE * score, this));
             //TraceManager.addDev("Found in keyword:" + toString() + " score=" + score);
         }
 
@@ -380,11 +380,11 @@ public class HelpEntry implements GenericTree {
         }
     }
 
-    public void searchInContent(String [] words, HelpEntry father, Vector<AtomicInteger> scores) {
+    public void searchInContent(String [] words, HelpEntry father, Vector<ScoredHelpEntry> scores) {
         int score = hasInContent(words);
         if (score > 0) {
-            father.addKid(this);
-            scores.add(new AtomicInteger(score));
+            //father.addKid(this);
+            scores.add(new ScoredHelpEntry(KEYWORD_SEARCH_IMPORTANCE * score, this));
             //TraceManager.addDev("Found in content:" + toString() + " score=" + score);
         }
 

src/main/java/help/ScoredHelpEntry.java

+/* Copyright or (C) or Copr. GET / ENST, Telecom-Paris, Ludovic Apvrille
+ * 
+ * ludovic.apvrille AT enst.fr
+ * 
+ * This software is a computer program whose purpose is to allow the
+ * edition of TURTLE analysis, design and deployment diagrams, to
+ * allow the generation of RT-LOTOS or Java code from this diagram,
+ * and at last to allow the analysis of formal validation traces
+ * obtained from external tools, e.g. RTL from LAAS-CNRS and CADP
+ * from INRIA Rhone-Alpes.
+ * 
+ * This software is governed by the CeCILL  license under French law and
+ * abiding by the rules of distribution of free software.  You can  use,
+ * modify and/ or redistribute the software under the terms of the CeCILL
+ * license as circulated by CEA, CNRS and INRIA at the following URL
+ * "http://www.cecill.info".
+ * 
+ * As a counterpart to the access to the source code and  rights to copy,
+ * modify and redistribute granted by the license, users are provided only
+ * with a limited warranty  and the software's author,  the holder of the
+ * economic rights,  and the successive licensors  have only  limited
+ * liability.
+ * 
+ * In this respect, the user's attention is drawn to the risks associated
+ * with loading,  using,  modifying and/or developing or reproducing the
+ * software by the user in light of its specific status of free software,
+ * that may mean  that it is complicated to manipulate,  and  that  also
+ * therefore means  that it is reserved for developers  and  experienced
+ * professionals having in-depth computer knowledge. Users are therefore
+ * encouraged to load and test the software's suitability as regards their
+ * requirements in conditions enabling the security of their systems and/or
+ * data to be ensured and,  more generally, to use and operate it in the
+ * same conditions as regards security.
+ * 
+ * The fact that you are presently reading this means that you have had
+ * knowledge of the CeCILL license and that you accept its terms.
+ */
+
+
+package help;
+
+import myutil.Conversion;
+import myutil.GenericTree;
+import myutil.TraceManager;
+
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+import java.net.URL;
+import java.net.URLConnection;
+import java.nio.charset.StandardCharsets;
+import java.util.Vector;
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.stream.Collectors;
+
+
+/**
+ * Class ScoredHelpEntry
+ * Creation: 18/11/2019
+ * Version 2.0 18/11/2019
+ *
+ * @author Ludovic APVRILLE
+ */
+public class ScoredHelpEntry implements Comparable<ScoredHelpEntry> {
+
+   public int score;
+   public HelpEntry he;
+
+    public ScoredHelpEntry(int score, HelpEntry he) {
+        this.score = score;
+        this.he = he;
+    }
+
+    public int compareTo(ScoredHelpEntry compareEntry) {
+        // descending order
+        return this.score - compareEntry.score;
+    }
+
+
+
+}

src/main/java/help/SearchResultHelpEntry.java

@@ -39,19 +39,12 @@
 
 package help;
 
-import myutil.GenericTree;
 import myutil.TraceManager;
 
-import java.io.BufferedReader;
-import java.io.InputStreamReader;
-import java.net.URL;
-import java.net.URLConnection;
-import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Vector;
 import java.util.concurrent.atomic.AtomicInteger;
-import java.util.stream.Collectors;
 
 
 /**
@@ -64,13 +57,13 @@ import java.util.stream.Collectors;
 public class SearchResultHelpEntry extends HelpEntry {
     public static String SEARCH_HEADER = "<h1>Search result</h1>\n<br>\n";
 
-    private Vector<AtomicInteger> scores;
+    public Vector<ScoredHelpEntry> scores;
 
     public SearchResultHelpEntry() {
 
     }
 
-    public void setScores(Vector<AtomicInteger> _scores) {
+    public void setScores(Vector<ScoredHelpEntry> _scores) {
         scores = _scores;
     }
 
@@ -82,8 +75,8 @@ public class SearchResultHelpEntry extends HelpEntry {
         int index1 = ret.indexOf("<body>");
         if (index1 > -1) {
             index1 += 6;
-            ret = ret.substring(0, index1) + "\n" + SEARCH_HEADER + getNbOfKids() + " result(s) found:<br>\n" +
-                    kids + ret.substring(index1+1, ret.length());
+            ret = ret.substring(0, index1) + "\n" + SEARCH_HEADER + scores.size() + " result(s) found:<br>\n" +
+                    kids + ret.substring(index1 + 1, ret.length());
         }
 
         //TraceManager.addDev("Resulting HTML of search:" + ret);
@@ -96,17 +89,14 @@ public class SearchResultHelpEntry extends HelpEntry {
         String s = "";
         int maxScore = getMaxScore();
 
-
-        if (entries != null) {
-            int cpt = 0;
-            for (HelpEntry he : entries) {
+        if (scores != null) {
+            for (ScoredHelpEntry entry: scores) {
                 s += "<li> ";
-                int score = (int)(scores.get(cpt).intValue() * 100.0/maxScore);
-                s += "<a href=\"file://" + he.getPathToHTMLFile() + "\"/>" +  he.getMasterKeyword
-                        () + "</a>  " +  "(" + score + "%)  " +
-                he.getKeywords();
+                int score = (int) (entry.score * 100.0 / maxScore);
+                s += "<a href=\"file://" + entry.he.getPathToHTMLFile() + "\"/>" + entry.he.getMasterKeyword
+                        () + "</a>  " + "(" + score + "%)  " +
+                        entry.he.getKeywords();
                 s += " </li>\n<br>\n";
-                cpt ++;
             }
         }
 
@@ -118,10 +108,9 @@ public class SearchResultHelpEntry extends HelpEntry {
         if (scores == null) {
             return maxScore;
         }
-        for(AtomicInteger i: scores) {
-            int val = i.intValue();
-            if (val > maxScore) {
-                maxScore = val;
+        for (ScoredHelpEntry score: scores) {
+            if (score.score > maxScore) {
+                maxScore = score.score;
             }
         }
         return maxScore;
@@ -129,50 +118,39 @@ public class SearchResultHelpEntry extends HelpEntry {
 
     public void mergeResults() {
         // Find duplicate sons, and compute final scores for sons
-        Vector<HelpEntry> tmp = new Vector<>();
-        Vector<AtomicInteger> tmpScores = new Vector<>();
+        //Vector<HelpEntry> tmp = new Vector<>();
+        HashMap<HelpEntry, ScoredHelpEntry> mergeMap = new HashMap<>();
+        Vector<ScoredHelpEntry> tmpScores = new Vector<>();
         int cpt = 0;
 
-        if (entries != null) {
-            for (HelpEntry he : entries) {
-                int indexOriginal = tmp.indexOf(he);
-                if (indexOriginal > -1) {
-                    AtomicInteger right = tmpScores.get(indexOriginal);
-                    right.addAndGet(scores.get(cpt).intValue());
+        if (scores != null) {
+            for (ScoredHelpEntry score: scores) {
+                ScoredHelpEntry sc = mergeMap.get(score.he);
+                if (sc == null) {
+                    mergeMap.put(score.he, score);
                 } else {
-                    tmp.add(he);
-                    tmpScores.add(new AtomicInteger(scores.get(cpt).intValue()));
+                    // An entry already exists: accumulate score
+                    sc.score += score.score;
                 }
-                cpt++;
+
             }
         }
-        scores = tmpScores;
-        entries = tmp;
+
+        // Compute a mergedList
+        scores = new Vector<>(mergeMap.values());
     }
 
     public void sortResults() {
-        HashMap<AtomicInteger, HelpEntry> mapScore = new HashMap<>();
-
-        for(int i=0; i<scores.size(); i++) {
-            mapScore.put(scores.get(i), entries.get(i));
-        }
-        Vector<Integer> vect = new Vector<>();
-        HashMap<Integer, AtomicInteger> mapInt = new HashMap<>();
-        for(int i=0; i<scores.size(); i++) {
-            Integer newInt = new Integer(scores.get(i).intValue());
-            vect.add(newInt);
-            mapInt.put(newInt, scores.get(i));
-        }
+        Collections.sort(scores, Collections.reverseOrder());
+    }
 
-        Collections.sort(vect, Collections.reverseOrder());
-        Vector<HelpEntry> tmp = new Vector<>();
-        Vector<AtomicInteger> tmpScores = new Vector<>();
-        for(int i=0; i<vect.size(); i++) {
-            AtomicInteger ai = mapInt.get(vect.get(i));
-            tmpScores.add(ai);
-            tmp.add(mapScore.get(ai));
+    public String toString() {
+        StringBuffer sb = new StringBuffer("");
+        for(ScoredHelpEntry he: scores) {
+            sb.append(he.score + ": " + he.he.getPathToHTMLFile() + "\n");
         }
-        scores = tmpScores;
-        entries = tmp;
+        return sb.toString();
     }
+
+
 }

src/main/java/ui/window/JFrameHelp.java

@@ -44,6 +44,7 @@ package ui.window;
 
 import help.HelpEntry;
 import help.HelpManager;
+import help.ScoredHelpEntry;
 import help.SearchResultHelpEntry;
 import myutil.TraceManager;
 import ui.MainGUI;
@@ -261,15 +262,22 @@ public	class JFrameHelp extends JFrame implements ActionListener {
         srhe.fillInfos("searchresult search help list index");
 
 
-        Vector<AtomicInteger> scores = new Vector<>();
+        Vector<ScoredHelpEntry> scores = new Vector<>();
 
         hm.searchInKeywords(test.split(" "), srhe, scores);
         hm.searchInContent(test.split(" "), srhe, scores);
         srhe.setScores(scores);
 
+        TraceManager.addDev("search help: " + srhe.toString());
+
         srhe.mergeResults();
+
+        TraceManager.addDev("search help after merge: " + srhe.toString());
+
         srhe.sortResults();
 
+        TraceManager.addDev("search help after sort: " + srhe.toString());
+
 
         TraceManager.addDev("Setting new help entry with search results ");
         setHelpEntry(srhe);