From f56e945d7615043bcf5605e9e7dd5b4a4861f83b Mon Sep 17 00:00:00 2001
From: Christian Mollekopf <chrigi_1@fastmail.fm>
Date: Thu, 14 Jan 2016 17:52:01 +0100
Subject: A more convenient and expressive query API

---
 common/query.h | 120 +++++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 99 insertions(+), 21 deletions(-)

(limited to 'common')

diff --git a/common/query.h b/common/query.h
index 0d0f382..1df32da 100644
--- a/common/query.h
+++ b/common/query.h
@@ -22,42 +22,120 @@
 #include <QByteArrayList>
 #include <QHash>
 #include <QSet>
+#include "applicationdomaintype.h"
 
 namespace Akonadi2 {
 
 /**
- * A query that matches a set of objects
- * 
- * The query will have to be updated regularly similary to the domain objects.
- * It probably also makes sense to have a domain specific part of the query,
- * such as what properties we're interested in (necessary information for on-demand
- * loading of data).
- *
- * The query defines:
- * * what resources to search
- * * filters on various properties (parent collection, startDate range, ....)
- * * properties we need (for on-demand querying)
- * 
- * syncOnDemand: Execute a source sync before executing the query
- * processAll: Ensure all local messages are processed before querying to guarantee an up-to date dataset.
+ * A query that matches a set of entities.
  */
 class Query
 {
 public:
-    Query() : syncOnDemand(true), processAll(false), liveQuery(false) {}
-    //Could also be a propertyFilter
+    enum Flag {
+        /** Leave the query running an contiously update the result set. */
+        LiveQuery
+    };
+    Q_DECLARE_FLAGS(Flags, Flag)
+
+    static Query PropertyFilter(const QByteArray &key, const QVariant &value)
+    {
+        Query query;
+        query.propertyFilter.insert(key, value);
+        return query;
+    }
+
+    static Query PropertyFilter(const QByteArray &key, const ApplicationDomain::Entity &entity)
+    {
+        return PropertyFilter(key, QVariant::fromValue(entity.identifier()));
+    }
+
+    static Query ResourceFilter(const QByteArray &identifier)
+    {
+        Query query;
+        query.resources.append(identifier);
+        return query;
+    }
+
+    static Query ResourceFilter(const QByteArrayList &identifier)
+    {
+        Query query;
+        query.resources = identifier;
+        return query;
+    }
+
+    static Query ResourceFilter(const ApplicationDomain::AkonadiResource &entity)
+    {
+        return ResourceFilter(entity.identifier());
+    }
+
+    static Query IdentityFilter(const QByteArray &identifier)
+    {
+        Query query;
+        query.ids << identifier;
+        return query;
+    }
+
+    static Query IdentityFilter(const QByteArrayList &identifier)
+    {
+        Query query;
+        query.ids = identifier;
+        return query;
+    }
+
+    static Query IdentityFilter(const ApplicationDomain::Entity &entity)
+    {
+        return IdentityFilter(entity.identifier());
+    }
+
+    static Query RequestedProperties(const QByteArrayList &properties)
+    {
+        Query query;
+        query.requestedProperties = properties;
+        return query;
+    }
+
+    static Query RequestTree(const QByteArray &parentProperty)
+    {
+        Query query;
+        query.parentProperty = parentProperty;
+        return query;
+    }
+
+    Query(Flags flags = Flags())
+    {}
+
+    Query& operator+=(const Query& rhs)
+    {
+        resources += rhs.resources;
+        ids += rhs.ids;
+        for (auto it = rhs.propertyFilter.constBegin(); it != rhs.propertyFilter.constEnd(); it++) {
+            propertyFilter.insert(it.key(), it.value());
+        }
+        requestedProperties += rhs.requestedProperties;
+        parentProperty = rhs.parentProperty;
+        liveQuery = rhs.liveQuery;
+        syncOnDemand = rhs.syncOnDemand;
+        processAll = rhs.processAll;
+        return *this;
+    }
+
+    friend Query operator+(Query lhs, const Query& rhs)
+    {
+        lhs += rhs;
+        return lhs;
+    }
+
     QByteArrayList resources;
-    //Could also be a propertyFilter
     QByteArrayList ids;
-    //Filters to apply
     QHash<QByteArray, QVariant> propertyFilter;
-    //Properties to retrieve
     QByteArrayList requestedProperties;
     QByteArray parentProperty;
+    bool liveQuery;
     bool syncOnDemand;
     bool processAll;
-    //If live query is false, this query will not continuously be updated
-    bool liveQuery;
 };
 
 }
+
+Q_DECLARE_OPERATORS_FOR_FLAGS(Akonadi2::Query::Flags)
-- 
cgit v1.2.3