Changeset 30050 for gs3-extensions/solr/trunk/src/src/java/org/greenstone

Timestamp:

2015-07-21T05:35:34+12:00 (9 years ago)

Author:

Georgiy Litvinov

Message:

Solr repo modifications for Solr side highlighing and snippets

Location:

gs3-extensions/solr/trunk/src/src/java/org/greenstone/gsdl3

Files:

• service/GS2SolrSearch.java (modified) (4 diffs)
• util/SolrQueryResult.java (modified) (3 diffs)
• util/SolrQueryWrapper.java (modified) (9 diffs)

gs3-extensions/solr/trunk/src/src/java/org/greenstone/gsdl3/service/GS2SolrSearch.java

@@ -65 +65 @@
                 paramDefaults.put(SORT_ORDER_PARAM, SORT_ORDER_DESCENDING);
         does_faceting = true;
+        does_highlight_snippets = true;
+        does_full_field_highlighting = true;
         // Used to store the solr cores that match the required 'level' 
         // of search (e.g. either document-level=>didx, or 
@@ -341 +343 @@
         try
         {
+            //if it is a Highlighting Query - execute it
+            this.solr_src.setHighlightField(indexField);
+            if(hldocOID != null)
+            {
+                String rslt = this.solr_src.runHighlightingQuery(query,hldocOID);
+                return rslt;
+            }
             SharedSoleneQueryResult sqr = this.solr_src.runQuery(query);
 
@@ -352 +361 @@
         return null;
     }
-
+    
+    
     /** get the total number of docs that match */
     protected long numDocsMatched(Object query_result)
@@ -445 +455 @@
 
         return newFacetList;
+    }
+    @Override
+    protected Map<String, Map<String, List<String>>> getHighlightSnippets(Object query_result)
+    {
+        if (!(query_result instanceof SolrQueryResult))
+        {
+            return null;
+        }
+
+        SolrQueryResult result = (SolrQueryResult) query_result;
+        
+        return result.getHighlightResults();
     }
 

gs3-extensions/solr/trunk/src/src/java/org/greenstone/gsdl3/util/SolrQueryResult.java

@@ -28 +28 @@
 
 import java.util.List;
+import java.util.Map;
 
 import org.apache.solr.client.solrj.response.FacetField;
@@ -41 +42 @@
 {
     protected List<FacetField> _facetResults = null;
+    protected Map<String,Map<String,List<String>>> _highlightResults = null;
     SolrQueryResult()
     {
         super();
     }
-    
     public void setFacetResults(List<FacetField> facetResults)
     {
@@ -55 +56 @@
         return _facetResults;
     }
+    //Save highlighting snippets
+    public void setHighlightResults(Map<String,Map<String,List<String>>> highlightResults){
+        _highlightResults = highlightResults;
+    }
+    //Extract highlighting snippets
+    public Map<String,Map<String,List<String>>> getHighlightResults(){
+        return _highlightResults;
+    }
+    
 }

gs3-extensions/solr/trunk/src/src/java/org/greenstone/gsdl3/util/SolrQueryWrapper.java

@@ -33 +33 @@
 import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.HashSet;
-
 import java.util.regex.Pattern;
 import java.util.regex.Matcher;
@@ -46 +46 @@
 import org.apache.solr.client.solrj.response.QueryResponse;
 import org.apache.solr.client.solrj.response.TermsResponse;
-
 import org.apache.solr.core.CoreContainer;
 import org.apache.solr.core.SolrCore;
-
 import org.apache.solr.common.SolrDocument;
 import org.apache.solr.common.SolrDocumentList;
@@ -55 +53 @@
 import org.greenstone.LuceneWrapper4.SharedSoleneQuery;
 import org.greenstone.LuceneWrapper4.SharedSoleneQueryResult;
-
 import org.apache.lucene.search.Query; // Query, TermQuery, BooleanQuery, BooleanClause and more
 import org.apache.lucene.index.IndexReader;
@@ -81 +78 @@
     SolrServer solr_core = null;
 
+    protected String highlight_field = null;
+    
     String collection_core_name_prefix = null;
 
@@ -109 +108 @@
     }
   }
-
+  public void setHighlightField(String hl_field)
+  {
+    this.highlight_field = hl_field;
+  }
   public void setSortOrder(String order)
   {
@@ -360 +362 @@
         solrQuery.setFields("docOID", "score"); //solrParams.set("fl", "docOID score totaltermfreq(field,'queryterm')"); 
         
+        //Turn on highlighting
+        solrQuery.setHighlight(true);
+        //Return 3 snippets for each document
+        solrQuery.setParam("hl.snippets", "3");
+        solrQuery.setParam("hl.fl", highlight_field);
+        solrQuery.setHighlightSimplePre("<span class=\"snippetText\">");
+        
+        //Set text which appears after highlighted term
+        solrQuery.setHighlightSimplePost("</span>");
+        
         //solrQuery.setTerms(true); // turn on the termsComponent       
         //solrQuery.set("terms.fl", "ZZ"); // which field to get the terms from. ModifiableSolrParams method
@@ -392 +404 @@
             QueryResponse solrResponse = solr_core.query(solrQuery); //solr_core.query(solrParams);
             SolrDocumentList hits = solrResponse.getResults();
+            Map<String, Map<String, List<String>>> hlResponse = solrResponse.getHighlighting();
+            solr_query_result.setHighlightResults(hlResponse);
             //TermsResponse termResponse = solrResponse.getTermsResponse(); // null unless termvectors=true in schema.xml
 
@@ -410 +424 @@
                 solr_query_result.setStartResults(start_results);
                 solr_query_result.setEndResults(start_results + hits.size());
-
-                
+                    
                 // get the first field we're searching in, this will be the fallback field
                 int sepIndex = query_string.indexOf(":");
@@ -505 +518 @@
         return solr_query_result;
     }
+// Highlighting query. Returns full highlighted text for document
+    public String runHighlightingQuery(String query,String hldocOID)
+    {
+                    
+        SolrQueryResult solr_query_result = new SolrQueryResult();
+        solr_query_result.clear();
+
+        
+        /* Create Query*/
+        
+        SolrQuery solrQuery = new SolrQuery(query);
+        
+        /* Set Query Parameters*/
+        
+        //Turn on highlighting
+        solrQuery.setHighlight(true);
+        //Extract default field from query
+        
+        //Set field for highlighting
+        solrQuery.setParam("hl.fl", highlight_field);
+        
+        //Get whole highlighted field
+        solrQuery.setHighlightFragsize(0);
+        
+        //Return only required document by docOID
+        solrQuery.setFilterQueries("docOID:"+ hldocOID);
+        
+        //Set text which appears before highlighted term
+        //solrQuery.setHighlightSimplePre("<annotation type=\"query_term\">");
+        solrQuery.setHighlightSimplePre("<span class=\"termHighlight\">");
+        //Set text which appears after highlighted term
+        //solrQuery.setHighlightSimplePost("</annotation>");
+        solrQuery.setHighlightSimplePost("</span>");
+        //Prepare results
+        String text = null;
+        // do the query
+        try
+        {
+            QueryResponse solrResponse = solr_core.query(solrQuery); //solr_core.query(solrParams);
+            //Get highliting results
+            Map<String,Map<String,List<String>>> highlightingResults = solrResponse.getHighlighting();
+            //Get highlited document text
+            text = highlightingResults.get(hldocOID).get(highlight_field).get(0);
+            
+                                                
+        }
+        catch (SolrServerException server_exception)
+        {
+            server_exception.printStackTrace();
+            
+        }
+        return text;
+    }
 
     //Greenstone universe operates with a base of 1 for "start_results"