Merge lp:~gary-wzl77/scope-aggregator/default_query_string_And_only_in_search into lp:~scope-aggregator/scope-aggregator/vivid-trunk-setaside

[Gary.Wang]

Support only_in_search and default_query_string in scope json object

Support only_in_search and default_query_string in scope json object

[Kyle Nitzsche (knitzsche)]

Hi Gary.

Small format/style request 1):
Please add a space after the "&&" in this line:
if (query_string.empty() &&scope->only_in_search() == true)

Style request 2):
Please use four spaces instead of tabs in this project. For example indentation looks wrong on line 110 below.

Most new features need to be documented in the README.md. Do you think this does?

Please refresh the branch here and I will approve.

Thanks,
Kyle

review: Needs Fixing

[lp:~gary-wzl77/scope-aggregator/default_query_string_And_only_in_search]

140. By Gary.Wang on 2015-07-15

1.Update README.md with new properties(only_in_search and default_query_string)
2.Fixed indentation issue

141. By Gary.Wang on 2015-07-15

Pull master branch and merge to avoid conflicts

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-07-14 23:22:36 +0000
+++ CMakeLists.txt	2015-07-15 03:54:56 +0000
@@ -1,4 +1,4 @@
-set(VERSION "1.5.20")
+set(VERSION "1.5.20.1")
 
 # Supress qDebug() output
 ADD_DEFINITIONS( -DQT_NO_DEBUG_OUTPUT )

=== modified file 'README.md'
--- README.md	2015-06-16 22:37:40 +0000
+++ README.md	2015-07-15 03:54:56 +0000
@@ -673,7 +673,7 @@
 
 The `id` is used to refer to the common template when using `result_category_id_to_common_template`.
 
-### template` (required)
+### `template` (required)
 
 Value: json
 
@@ -705,3 +705,57 @@
             [...]
         }
 
+
+#### `default_query_string` key (optional)
+
+Value: string: a query string passed to child scope
+
+The key is useful for developer to display results with specific query string by default instead of results fetched with empty query string.
+
+
+#### `only_in_search` key (optional)
+
+Value: string: "true" or "false", default value: "false"
+
+Displays only results of specified scope on search, not in surface.
+
+Note:If aggregator has multiple departments, in order to display results in current departments, you need to declare the scope with different deparment and local_id separately.
+
+        {
+            "departments":
+            {   
+                "do_not_use_departments": "false",
+                 "declarations":[
+                     {   
+                        "id": "dept-movies",
+                        "root": "true",
+                        "_title": "Movies"
+                     },  
+                     {   
+                        "id": "dept-music",
+                        "root": "False",
+                        "_title": "Music"
+                     }  
+                 ]   
+           },  
+           [...]
+           "order":
+           [
+                {
+                    "scope":
+                    {
+                         "id": "your_scope_id",
+                         "local_id": "your_scope_id_1",
+                         "only_in_search":"true",
+                         "department": "dept-movies"
+                    },
+                    [...]
+                    "scope":
+                    {
+                         "id": "your_scope_id",
+                         "local_id": "your_scope_id_2",
+                         "only_in_search":"true",
+                         "department": "dept-music"
+                    }
+                }
+           ]

=== modified file 'include/aggchildscope.h'
--- include/aggchildscope.h	2015-07-07 02:46:30 +0000
+++ include/aggchildscope.h	2015-07-15 03:54:56 +0000
@@ -364,6 +364,9 @@
     bool source_finder();
     void set_source_finder(bool);
 
+    bool only_in_search();
+    void set_only_in_search(bool);
+
 private:
 
     std::shared_ptr<us::ScopeMetadata> scope_metadata_;
@@ -386,6 +389,7 @@
     std::string dept_id = "";
     std::string subsearch_dept_id = "";
     bool using_category = false;
+    bool only_in_search_ = false;
     bool using_child_category_max_results_ = false;
     int child_category_max_results_ = 6;
     int result_idx_ = 0;

=== modified file 'include/query.h'
--- include/query.h	2015-07-09 21:45:42 +0000
+++ include/query.h	2015-07-15 03:54:56 +0000
@@ -107,6 +107,7 @@
         int child_category_max_results = 6;//optional in json else use this default when child_category used
         std::string child_department = "";//optional in json
         std::string department = "";//optional in json
+        bool only_in_search = false;//optional in json
         //the rest are NOT json keys
         bool using_child_category_max_results = false;//NOT A JSON KEY
         bool overriding_surface_template = false;//NOT A JSON KEY

=== modified file 'src/aggchildscope.cpp'
--- src/aggchildscope.cpp	2015-07-07 02:46:30 +0000
+++ src/aggchildscope.cpp	2015-07-15 03:54:56 +0000
@@ -318,6 +318,16 @@
     source_finder_ = b;
 }
 
+bool AggChildScope::only_in_search()
+{
+    return only_in_search_;
+}
+
+void AggChildScope::set_only_in_search(bool b)
+{
+    only_in_search_ = b;
+}
+
 bool AggChildScope::source_finder()
 {
     return source_finder_;

=== modified file 'src/query.cpp'
--- src/query.cpp	2015-07-14 23:19:35 +0000
+++ src/query.cpp	2015-07-15 03:54:56 +0000
@@ -232,6 +232,11 @@
             continue;
         }
 
+        if (query_string.empty() && scope->only_in_search() == true)
+        {
+            continue;
+        }
+
         idx++;
         scopes_m_int_localId[idx] = local_id; // add id to map used later to get dept_id
         qDebug() << "==== scopes scopes_m_int_localId[idx] init: " << qstr(scopes_m_int_localId[idx]);
@@ -1115,6 +1120,7 @@
         {
             for (auto ch : current_child_scopes)
             {
+
                 if (ch.id == localId_id_m[scopes_m_int_localId[i]])
                 {
                     qDebug() << "=== subsearch non KEYWORD scope local_ id " << qstr(scope->local_id());
@@ -1136,6 +1142,7 @@
                         adj_qry = localId_defaultQryStr[scopes_m_int_localId[i]];
                     else
                         adj_qry = "";
+
                     subsearch
                     (
                         ch,
@@ -1146,7 +1153,6 @@
                     );
                     break;
                 }
-
             }
         }
     }

=== modified file 'src/utils.cpp'
--- src/utils.cpp	2015-07-09 21:45:42 +0000
+++ src/utils.cpp	2015-07-15 03:54:56 +0000
@@ -535,6 +535,21 @@
                     cs->result_category_id_to_common_template[res_cat_id] = common_template;
                 }
             }
+
+            if (scope_o.contains("default_query_string"))
+            {
+                QString default_query_string = scope_o["default_query_string"].toString();
+                localId_defaultQryStr[cs->local_id] = default_query_string.toStdString();
+            }
+
+            if (scope_o.contains("only_in_search") && scope_o["only_in_search"] == "true")
+            {
+                cs->only_in_search = true;
+                cs->overriding_search_template = true;
+            } else {
+                cs->only_in_search = false;
+            }
+            
             child_scopes.emplace_back(cs);
             child_scopes_m[cs->local_id] = cs;
             type_ids_m[cs->local_id].emplace_back(cs->local_id);
@@ -732,6 +747,8 @@
         else
             ch.set_override_search_template(false);
 
+        ch.set_only_in_search(child->only_in_search);
+
         ch.set_source_finder(child->source_finder);
         qWarning () << QString("%1: ADDING DECLARED child scope: %2, local_id: %3").arg(qstr(scope_id), qstr(ch.id()), qstr(ch.local_id()));
         scopes_m[ch.local_id()] = std::make_shared<AggChildScope>(ch);