Changeset 6687

Timestamp:

10/20/15 11:27:53 (9 years ago)

Author:

Twan Goosen

Message:

highlight in search results

Location:

vlo/branches/vlo-3.3/vlo-web-app/src/main

Files:

• java/eu/clarin/cmdi/vlo/wicket/HighlightSearchTermBehavior.java (modified) (5 diffs)
• java/eu/clarin/cmdi/vlo/wicket/HighlightSearchTermScriptFactory.java (added)
• java/eu/clarin/cmdi/vlo/wicket/panels/search/SearchResultsPanel.java (modified) (4 diffs)
• less/eu/clarin/cmdi/vlo/wicket/pages/inc/vlo-search.less (modified) (1 diff)

vlo/branches/vlo-3.3/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/HighlightSearchTermBehavior.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.wicket;
 
-import com.google.common.collect.ImmutableSet;
 import eu.clarin.cmdi.vlo.JavaScriptResources;
-import java.util.Collection;
 import org.apache.wicket.Component;
 import org.apache.wicket.behavior.Behavior;
@@ -27 +25 @@
 import org.apache.wicket.request.Request;
 import org.apache.wicket.util.string.StringValue;
+import org.apache.wicket.util.string.Strings;
 
 /**
@@ -37 +36 @@
 public class HighlightSearchTermBehavior extends Behavior {
 
-    private static final String HIGHLIGHT_FUNCTION = "$('#%s').highlight(%s, {className:'%s'})";
-    private static final Collection<String> DEFAULT_EXCLUDE_WORDS = ImmutableSet.of("and", "or", "not", "to");
+    private final HighlightSearchTermScriptFactory scriptFactory = new HighlightSearchTermScriptFactory();
 
     @Override
@@ -45 +43 @@
         response.render(JavaScriptHeaderItem.forReference(JavaScriptResources.getHighlightJS()));
 
-        final StringValue words = getWordList(component);
-        if (!words.isEmpty()) {
+        final String words = getWordList(component);
+        if (!Strings.isEmpty(words)) {
+            String selector = getComponentSelector(component.getMarkupId());
             // after load, highlight 
-            response.render(OnDomReadyHeaderItem.forScript(String.format(HIGHLIGHT_FUNCTION,
-                    component.getMarkupId(), makeWordListArray(words.toString()),
-                    getSearchWordClass()
-            )));
+            response.render(OnDomReadyHeaderItem.forScript(scriptFactory.createScript(selector, words)));
         }
     }
 
-    /**
-     *
-     * @param wordList string of whitespace separated words
-     * @return a string representing a sanitised javascript array of words
-     */
-    private CharSequence makeWordListArray(String wordList) {
-        final StringBuilder sb = new StringBuilder("[");
-        final String[] words = wordList.split("\\s");
-        for (int i = 0; i < words.length; i++) {
-            final String word = sanitise(words[i]); //remove white space and quotes at beginning or end
-            // is on exclude list?
-            if (!getExcludeWords().contains(word.toLowerCase())) {
-                // wrap in quotes
-                sb.append("'").append(word).append("'");
-                if (i + 1 < words.length) {
-                    // prepare to append next
-                    sb.append(",");
-                }
-            }
-        }
-        return sb.append("]");
+    protected String getComponentSelector(String componentId) {
+        return "#" + componentId;
     }
 
-    private String sanitise(String word) {
-        return word.replaceAll("^[\\s'\"]+|[\\s'\"]+$", "");
-    }
-
-    /**
-     * 
-     * @return CSS class to mark matches with
-     */
-    protected String getSearchWordClass() {
-        return "searchword";
-    }
-
-    protected StringValue getWordList(Component component) {
+    protected String getWordList(Component component) {
         Request request = component.getPage().getRequestCycle().getRequest();
-        return request.getQueryParameters().getParameterValue(getQueryParam());
+        return request.getQueryParameters().getParameterValue(getQueryParam()).toString();
     }
 
@@ -99 +64 @@
     }
 
-    /**
-     *
-     * @return Words not to highlight
-     */
-    protected Collection<String> getExcludeWords() {
-        return DEFAULT_EXCLUDE_WORDS;
-    }
-
 }

vlo/branches/vlo-3.3/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels/search/SearchResultsPanel.java

@@ -18 +18 @@
 
 import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
+import eu.clarin.cmdi.vlo.wicket.HighlightSearchTermBehavior;
+import eu.clarin.cmdi.vlo.wicket.HighlightSearchTermScriptFactory;
 import eu.clarin.cmdi.vlo.wicket.model.SearchContextModel;
 import eu.clarin.cmdi.vlo.wicket.model.SearchResultExpansionStateModel;
@@ -26 +28 @@
 import java.util.Set;
 import org.apache.solr.common.SolrDocument;
+import org.apache.wicket.Component;
+import org.apache.wicket.ajax.AbstractDefaultAjaxBehavior;
 import org.apache.wicket.ajax.AjaxRequestTarget;
 import org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior;
@@ -41 +45 @@
 import org.apache.wicket.model.Model;
 import org.apache.wicket.model.PropertyModel;
+import org.apache.wicket.util.string.StringValue;
 
 /**
@@ -93 +98 @@
         //For Ajax updating of search results
         setOutputMarkupId(true);
+        
+        add(new HighlightSearchTermBehavior(){
+
+            @Override
+            protected String getComponentSelector(String componentId) {
+                return ".searchresultitem"; //"h3, .searchresultdescription"
+            }
+
+            @Override
+            protected String getWordList(Component component) {
+                return selectionModel.getObject().getQuery();
+            }
+            
+        });
     }
     

vlo/branches/vlo-3.3/vlo-web-app/src/main/less/eu/clarin/cmdi/vlo/wicket/pages/inc/vlo-search.less

@@ -143 +143 @@
 #searchresultitems .searchresultdescription a {
     text-decoration: underline;
+}
+
+.searchresultitem .searchword {
+    font-weight: bold;
 }