Changeset 6686

Timestamp:

10/20/15 09:13:20 (9 years ago)

Author:

Twan Goosen

Message:

Search term highlighting with the highlight JQuery plugin. Added some additional pre-processing of the query terms.

Location:

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

Files:

• java/eu/clarin/cmdi/vlo/JavaScriptResources.java (modified) (1 diff)
• java/eu/clarin/cmdi/vlo/wicket/HighlightSearchTermBehavior.java (modified) (4 diffs)
• java/eu/clarin/cmdi/vlo/wicket/pages/RecordPage.html (modified) (1 diff)
• java/eu/clarin/cmdi/vlo/wicket/pages/RecordPage.java (modified) (2 diffs)
• js/eu/clarin/cmdi/vlo/wicket/pages/jquery.highlight.js (added)
• js/eu/clarin/cmdi/vlo/wicket/pages/searchhi.js (deleted)

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

@@ -38 +38 @@
     private final static CssResourceReference JQUERY_UI_CSS = new CssResourceReference(VloBasePage.class, "jquery-ui-1.11.4.custom/jquery-ui.min.css");
     private final static JavaScriptResourceReference JQUERY_WATERMARK = new JavaScriptResourceReference(VloBasePage.class, "jquery.watermark-3.1.4/jquery.watermark.min.js");
-    private final static JavaScriptResourceReference HIGHLIGHT = new JavaScriptResourceReference(RecordPage.class, "searchhi.js");
+    private final static JavaScriptResourceReference HIGHLIGHT = new JavaScriptResourceReference(RecordPage.class, "jquery.highlight.js");
 
     public static JavaScriptResourceReference getVloFrontJS() {

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;
@@ -23 +25 @@
 import org.apache.wicket.markup.head.JavaScriptHeaderItem;
 import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
+import org.apache.wicket.request.Request;
+import org.apache.wicket.util.string.StringValue;
 
 /**
@@ -33 +37 @@
 public class HighlightSearchTermBehavior extends Behavior {
 
-    private static final String HIGHLIGHT_FUNCTION = "searchhi.init()";
+    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");
 
     @Override
@@ -39 +44 @@
         // include highlight script
         response.render(JavaScriptHeaderItem.forReference(JavaScriptResources.getHighlightJS()));
-        // after load, highlight 
-        response.render(OnDomReadyHeaderItem.forScript(HIGHLIGHT_FUNCTION));
+
+        final StringValue words = getWordList(component);
+        if (!words.isEmpty()) {
+            // after load, highlight 
+            response.render(OnDomReadyHeaderItem.forScript(String.format(HIGHLIGHT_FUNCTION,
+                    component.getMarkupId(), makeWordListArray(words.toString()),
+                    getSearchWordClass()
+            )));
+        }
+    }
+
+    /**
+     *
+     * @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("]");
+    }
+
+    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) {
+        Request request = component.getPage().getRequestCycle().getRequest();
+        return request.getQueryParameters().getParameterValue(getQueryParam());
+    }
+
+    protected String getQueryParam() {
+        return "q";
+    }
+
+    /**
+     *
+     * @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/pages/RecordPage.html

@@ -51 +51 @@
                 <div id="recorddetails">
                     <a wicket:id="landingPageLink" target="_blank" id="recordlandingpage">Show this record in its original context</a>
-                    <wicket:container wicket:id="documentProperties">[PROPERTIES TABLE]</wicket:container>
+                    <div id="recordProperties" wicket:id="documentProperties">[PROPERTIES TABLE]</div>
                 </div>
 

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

@@ -130 +130 @@
 
         addComponents();
-        add(new HighlightSearchTermBehavior());
     }
 
@@ -138 +137 @@
 
         final WebMarkupContainer topNavigation = new WebMarkupContainer("topnavigation");
-        topNavigation.setOutputMarkupId(true);
-        add(topNavigation);
-
-        topNavigation.add(new BreadCrumbPanel("breadcrumbs", selectionModel));
-        topNavigation.add(createPermalink("permalink", topNavigation));
+        add(topNavigation
+                .add(new BreadCrumbPanel("breadcrumbs", selectionModel))
+                .add(createPermalink("permalink", topNavigation))
+                .setOutputMarkupId(true)
+        );
 
         // General information section
         add(new SolrFieldLabel("name", getModel(), FacetConstants.FIELD_NAME, getString("recordpage.unnamedrecord")));
         add(createLandingPageLink("landingPageLink"));
-        add(new FieldsTablePanel("documentProperties", new DocumentFieldsProvider(getModel(), basicPropertiesFilter, fieldOrder)));
+        
+        final FieldsTablePanel fieldsTable = new FieldsTablePanel("documentProperties", new DocumentFieldsProvider(getModel(), basicPropertiesFilter, fieldOrder));
+        fieldsTable.add(new HighlightSearchTermBehavior());
+        add(fieldsTable);
 
         // Resources section