Changeset 8267

Timestamp:

03/05/10 13:19:55 (5 months ago)

Author:

ssterling

Message:

For Solr Search, always show the user the values they actually input. Changed the way that input is being filtered for special characters and words. Removed broken field weighting.

Addresses Job Order 16472

Location:

head/ambra/webapp/src/main/java/org/topazproject/ambra/search2

Files:

• SearchParameters.java (modified) (1 diff)
• service/SolrSearchService.java (modified) (7 diffs)

head/ambra/webapp/src/main/java/org/topazproject/ambra/search2/SearchParameters.java

@@ -313 +313 @@
   public void setPageSize(int pageSize) {
     this.pageSize = pageSize;
+  }
+
+  /**
+   * Creates a deep copy of this SearchParameters object.
+   *
+   * @return a deep copy of this SearchParameters object.
+   */
+  public SearchParameters copy() {
+    SearchParameters sp = new SearchParameters();
+    sp.setQuery(this.getQuery());
+    sp.setTextSearchAll(this.getTextSearchAll());
+    sp.setTextSearchAtLeastOne(this.getTextSearchAtLeastOne());
+    sp.setTextSearchExactPhrase(this.getTextSearchExactPhrase());
+    sp.setTextSearchWithout(this.getTextSearchWithout());
+    sp.setTextSearchOption(this.getTextSearchOption());
+    sp.setCreator(this.getCreator().clone());
+    sp.setAuthorNameOp(this.getAuthorNameOp());
+    sp.setSubjectCatOpt(this.getSubjectCatOpt());
+    sp.setDateTypeSelect(this.getDateTypeSelect());
+    if (this.getStartDate() == null)
+      sp.setStartDate(null);
+    else
+      sp.setStartDate((Date)this.getStartDate().clone());
+    if (this.getEndDate() == null)
+      sp.setEndDate(null);
+    else
+      sp.setEndDate((Date)this.getEndDate().clone());
+    sp.setLimitToCategory(this.getLimitToCategory().clone());
+    sp.setJournalOpt(this.getJournalOpt());
+    sp.setLimitToJournal(this.getLimitToJournal().clone());
+    sp.setStartPage(this.getStartPage());
+    sp.setPageSize(this.getPageSize());
+    return sp;
   }
 

head/ambra/webapp/src/main/java/org/topazproject/ambra/search2/service/SolrSearchService.java

@@ -69 +69 @@
    */
   public SearchResultSinglePage simpleSearch(String queryString, String eissn, int startPage, int pageSize) throws ApplicationException {
-    queryString = queryString.replaceAll("AND", "").replaceAll("OR", "");
+    queryString = cleanString(queryString);
     log.debug("Simple Search performed on the String: " + queryString
         + " startPage: " + startPage
@@ -83 +83 @@
 
   public SearchResultSinglePage advancedSearch(SearchParameters searchParameters) throws ApplicationException {
-    searchParameters = cleanStrings(searchParameters);
-    log.debug("Advanced Search performed on the SearchParameters: " + searchParameters);
-
-    SolrQuery query = createQuery(null, searchParameters.getStartPage(), searchParameters.getPageSize());
+    SearchParameters sp = cleanStrings(searchParameters);
+    log.debug("Advanced Search performed on the SearchParameters: " + sp);
+
+    SolrQuery query = createQuery(null, sp.getStartPage(), sp.getPageSize());
 
     // Set highlighting fields.  Defaults to field list in "highlightFieldsDefault" variable.
-    if ("abstract".equals(searchParameters.getTextSearchExactPhrase())) {
+    if ("abstract".equals(sp.getTextSearchExactPhrase())) {
       query.set("hl.fl", "abstract");
-    } else if ("refs".equals(searchParameters.getTextSearchOption())) {
+    } else if ("refs".equals(sp.getTextSearchOption())) {
       query.set("hl.fl", "citation");
-    } else if ("title".equals(searchParameters.getTextSearchOption())) {
+    } else if ("title".equals(sp.getTextSearchOption())) {
       query.set("hl.fl", "title");
     }
@@ -100 +100 @@
 
     // Form field description: "Author Name:"
-    if (searchParameters.getCreator().length > 0 && StringUtils.isNotBlank(searchParameters.getCreator()[0])) {
+    if (sp.getCreator().length > 0 && StringUtils.isNotBlank(sp.getCreator()[0])) {
       q.append(" ( ");
-      for (int i = 0; i < searchParameters.getCreator().length; i++) {
-        String creatorName = searchParameters.getCreator()[i];
+      for (int i = 0; i < sp.getCreator().length; i++) {
+        String creatorName = sp.getCreator()[i];
         if (StringUtils.isNotBlank(creatorName)) {
           q.append(" author:\"").append(creatorName).append("\"");
         }
-        if (i < searchParameters.getCreator().length - 1
-            && StringUtils.isNotBlank(searchParameters.getCreator()[i + 1])) {
-          if ("all".equals(searchParameters.getAuthorNameOp())) {
+        if (i < sp.getCreator().length - 1
+            && StringUtils.isNotBlank(sp.getCreator()[i + 1])) {
+          if ("all".equals(sp.getAuthorNameOp())) {
             q.append(" AND ");
           } else {
@@ -120 +120 @@
 
     // Form field description: "for at least one of the words:"
-    if (searchParameters.getTextSearchAtLeastOne().trim().length() > 0) {
+    if (sp.getTextSearchAtLeastOne().trim().length() > 0) {
       q.append(" AND ").append(
-          addFields(" OR ", searchParameters.getTextSearchOption(), searchParameters.getTextSearchAtLeastOne().trim())
+          addFields(" OR ", sp.getTextSearchOption(), sp.getTextSearchAtLeastOne().trim())
       );
     }
 
     // Form field description: "for all the words:"
-    if (searchParameters.getTextSearchAll().trim().length() > 0) {
+    if (sp.getTextSearchAll().trim().length() > 0) {
       q.append(" AND ").append(
-          addFields(" AND ", searchParameters.getTextSearchOption(), searchParameters.getTextSearchAll().trim())
+          addFields(" AND ", sp.getTextSearchOption(), sp.getTextSearchAll().trim())
       );
     }
 
     // Form field description: "for the exact phrase:"
-    if (searchParameters.getTextSearchExactPhrase().trim().length() > 0) {
+    if (sp.getTextSearchExactPhrase().trim().length() > 0) {
       q.append(" AND ");
-      if ("abstract".equals(searchParameters.getTextSearchOption())) {
-        q.append("abstract:\"").append(searchParameters.getTextSearchExactPhrase().trim()).append("\"");
-      } else if ("refs".equals(searchParameters.getTextSearchOption())) {
-        q.append("citation:\"").append(searchParameters.getTextSearchExactPhrase().trim()).append("\"");
-      } else if ("title".equals(searchParameters.getTextSearchOption())) {
-        q.append("title:\"").append(searchParameters.getTextSearchExactPhrase().trim()).append("\"");
-      } else {
-        q.append("\"").append(searchParameters.getTextSearchExactPhrase().trim()).append("\"");
+      if ("abstract".equals(sp.getTextSearchOption())) {
+        q.append("abstract:\"").append(sp.getTextSearchExactPhrase().trim()).append("\"");
+      } else if ("refs".equals(sp.getTextSearchOption())) {
+        q.append("citation:\"").append(sp.getTextSearchExactPhrase().trim()).append("\"");
+      } else if ("title".equals(sp.getTextSearchOption())) {
+        q.append("title:\"").append(sp.getTextSearchExactPhrase().trim()).append("\"");
+      } else {
+        q.append("\"").append(sp.getTextSearchExactPhrase().trim()).append("\"");
       }
       q.append(" ");
@@ -149 +149 @@
 
     // Form field description: "without the words:"
-    if (searchParameters.getTextSearchWithout().trim().length() > 0) {
+    if (sp.getTextSearchWithout().trim().length() > 0) {
       q.append(" AND ").append(
-          addFieldsWithoutTheWords(" AND ", searchParameters.getTextSearchOption(),
-              searchParameters.getTextSearchWithout().trim())
+          addFieldsWithoutTheWords(" AND ", sp.getTextSearchOption(),
+              sp.getTextSearchWithout().trim())
       );
     }
 
     // Form field description: "Dates".  Query Filter.
-    if (searchParameters.getDateTypeSelect().trim().length() > 0) {
-      query.addFilterQuery(createFilterDateRange(searchParameters.getStartDate(), searchParameters.getEndDate()));
+    if (sp.getDateTypeSelect().trim().length() > 0) {
+      query.addFilterQuery(createFilterDateRange(sp.getStartDate(), sp.getEndDate()));
     }
 
     // Form field description: "Journals".  Query Filter.
-    if ("some".equals(searchParameters.getJournalOpt()) && searchParameters.getLimitToJournal().length > 0) {
-      query.addFilterQuery(createFilterLimitToJournals(searchParameters.getLimitToJournal()));
+    if ("some".equals(sp.getJournalOpt()) && sp.getLimitToJournal().length > 0) {
+      query.addFilterQuery(createFilterLimitToJournals(sp.getLimitToJournal()));
     }
 
     // Form field description: "Subject Categories".  Query Filter.
-    if ("some".equals(searchParameters.getSubjectCatOpt()) && searchParameters.getLimitToCategory().length > 0) {
-      query.addFilterQuery(createFilterLimitToCategories(searchParameters.getLimitToCategory()));
+    if ("some".equals(sp.getSubjectCatOpt()) && sp.getLimitToCategory().length > 0) {
+      query.addFilterQuery(createFilterLimitToCategories(sp.getLimitToCategory()));
     }
 
@@ -238 +238 @@
     SolrQuery query = new SolrQuery(queryString);
     query.setTimeAllowed(queryTimeout);
-    query.set("fl", "title^2.0", "abstract^1.5", "body^1.0"); // Score weighting.
     query.setIncludeScore(true); // The relevance (of each results element) to the search terms.
     query.setHighlight(true);
@@ -485 +484 @@
    * Remove dangerous and unwanted values from the Strings in selected fields in the SearchParameters parameter.
    *
-   * @param sp A SearchParameters object the needs to have some of its fields "cleaned"
+   * @param searchParameters A SearchParameters object the needs to have some of its fields "cleaned"
    * @return The SearchParameters parameter with some of its fields "cleaned"
    */
-  private SearchParameters cleanStrings(SearchParameters sp) {
-    sp.setQuery(sp.getQuery().replaceAll(" AND", "").replaceAll(" OR", "").replaceAll("AND ", "").replaceAll("OR ", "").toLowerCase());
-    if (sp.getCreator().length > 0) {
-      String [] tempCreator = new String[sp.getCreator().length];
+  private SearchParameters cleanStrings(SearchParameters searchParameters) {
+    SearchParameters sp = searchParameters.copy();
+    sp.setQuery(cleanString(searchParameters.getQuery()));
+    if (searchParameters.getCreator().length > 0) {
+      String [] tempCreator = new String[searchParameters.getCreator().length];
       int counter = 0;
-      for (String author : sp.getCreator()) {
-        tempCreator[counter++] = author.replaceAll(" AND", "").replaceAll(" OR", "").replaceAll("AND ", "").replaceAll("OR ", "").toLowerCase();
+      for (String author : searchParameters.getCreator()) {
+        tempCreator[counter++] = cleanString(author);
       }
       sp.setCreator(tempCreator);
     }
-    sp.setTextSearchAll(sp.getTextSearchAll().replaceAll(" AND", "").replaceAll(" OR", "").replaceAll("AND ", "").replaceAll("OR ", "").toLowerCase());
-    sp.setTextSearchAtLeastOne(sp.getTextSearchAtLeastOne().replaceAll(" AND", "").replaceAll(" OR", "").replaceAll("AND ", "").replaceAll("OR ", "").toLowerCase());
-    sp.setTextSearchExactPhrase(sp.getTextSearchExactPhrase().replaceAll(" AND", "").replaceAll(" OR", "").replaceAll("AND ", "").replaceAll("OR ", "").toLowerCase());
-    sp.setTextSearchWithout(sp.getTextSearchWithout().replaceAll(" AND", "").replaceAll(" OR", "").replaceAll("AND ", "").replaceAll("OR ", "").toLowerCase());
+    sp.setTextSearchAll(cleanString(searchParameters.getTextSearchAll()));
+    sp.setTextSearchAtLeastOne(cleanString(searchParameters.getTextSearchAtLeastOne()));
+    sp.setTextSearchExactPhrase(cleanString(searchParameters.getTextSearchExactPhrase()));
+    sp.setTextSearchWithout(cleanString(searchParameters.getTextSearchWithout()));
     return sp;
   }
+
+  /**
+   * TODO: add [ and ] but only if they are PAIRED!  Used for ranges.
+   *
+   * TODO: Check that ^ is followed by a NUMBER (integer or float).  Used for "boosting" terms in sort
+   *
+   * TODO: allow AND and OR and NOT, but that requires that our algorythm be able to construct complex boolean que
+   *
+   * @param toBeCleaned
+   * @return
+   */
+  private String cleanString(String toBeCleaned) {
+    return toBeCleaned
+        .replaceAll("[^\\w\\s\\?\\*]", "")
+        .replaceAll("_", " ")
+        .replaceAll("-", " ")
+        .replaceAll(" AND", "").replaceAll("AND ", "")
+        .replaceAll(" OR", "").replaceAll("OR ", "")
+        .replaceAll(" NOT", "").replaceAll("NOT ", "");
+  }
 }