Merge lp:~kevin-wright-1/u1db-qt/index-query-april-5-i into lp:u1db-qt

[Kevin Wright]

Created initial index functionality. Modified source for both Index and Query. Within the Index source, QVariantMaps are generated (based on the index expressions), using appropriate data, and put into a QList, which is used by Query::data as its return value. Some known issues: currently will match on any index expression criteria (rather than on all criteria), and will not recognize new databases / documents (but has no problems with existing ones).

Created initial index functionality. Modified source for both Index and Query. Within the Index source, QVariantMaps are generated (based on the index expressions), using appropriate data, and put into a QList, which is used by Query::data as its return value. Some known issues: currently will match on any index expression criteria (rather than on all criteria), and will not recognize new databases / documents (but has no problems with existing ones).

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:61
http://91.189.93.125:8080/job/u1db-qt-ci/14/
Executed test runs:
    SUCCESS: http://91.189.93.125:8080/job/u1db-qt-quantal-amd64-ci/14
    SUCCESS: http://91.189.93.125:8080/job/u1db-qt-raring-amd64-ci/14

Click here to trigger a rebuild:
http://91.189.93.125:8080/job/u1db-qt-ci/14/rebuild

review: Approve (continuous-integration)

[Cris Dywan (kalikiana)]

Please make separate commits for a) the index.cpp code b) the example c) qdoc changes. I see different qdoc changes all over the place, some of which look wrong.

I can't break up the MR on my end unfortunately, so I'm marking this whole as Needs Fixing.

review: Needs Fixing

Unmerged revisions

61. By Kevin Wright on 2013-04-05

Created initial index functionality. Modified source for both Index and Query. Within the Index source, QVariantMaps are generated (based on the index expressions), using appropriate data, and put into a QList, which is used by Query::data as its return value. Some known issues: currently will match on any index expression criteria (rather than on all criteria), and will not recognize new databases / documents (but has no problems with existing ones).

=== added file 'examples/u1db-qt-example-5.qml'
--- examples/u1db-qt-example-5.qml	1970-01-01 00:00:00 +0000
+++ examples/u1db-qt-example-5.qml	2013-04-05 14:01:48 +0000
@@ -0,0 +1,167 @@
+/*
+ * Copyright (C) 2013 Canonical, Ltd.
+ *
+ * Authors:
+ *  Kevin Wright <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import U1db 1.0 as U1db
+import Ubuntu.Components 0.1
+
+/*!
+
+This example and tutorial is designed to show a wide variety of U1Db-Qt functionality and usage. The example demonstrates:
+
+\list 1
+    \li Using Index and Query elements
+\endlist
+
+  */
+
+Item {
+
+        width: units.gu(45)
+        height: units.gu(80)
+
+        /*!
+
+            A Database is very simple to create. It only needs an id and a path where the file will be created. A Database is a model, which can be used by elements, such as the ListView further in this example.
+
+            U1db.Database {
+                id: aDatabase
+                path: "aDatabase4"
+            }
+
+        */
+
+        U1db.Database {
+            id: aDatabase
+            path: "aDatabase5"
+        }
+
+        /*!
+
+            A Document can be declared at runtime. It requires at the very least a unique 'docId', but that alone won't do anything special. The snipet below snippet demonstrates the basic requirements.
+
+            In addition to this, this example displays text from the database for a specific docId and id key in a text area called 'documentContent. To update the text area at startup with either the default value or a value from the database the onCompleted function is utilized, which is also demonstrated below.
+
+            U1db.Document {
+                id: aDocument
+                database: aDatabase
+                docId: 'helloworld'
+                create: true
+                defaults: { "helloworld":"Hello World" }
+
+                Component.onCompleted: {
+                    documentContent.text = aDocument.contents.helloworld
+                }
+
+            }
+
+        */
+
+
+       U1db.Document {
+            id: aDocument
+            database: aDatabase
+            docId: 'helloworld'
+            create: true
+            defaults:{"hello": { "world": [{ "message":"Hello World", "id": 1 }] } }
+
+        }
+       U1db.Document {
+            id: aDocument2
+            database: aDatabase
+            docId: 'helloworld2'
+            create: true
+            defaults:{"hello": { "world": [{ "message":"Hello World", "id": 2 }] } }
+
+        }
+
+       U1db.Index{
+           database: aDatabase
+           id: by_helloworld
+           name: "by-helloworld"
+           expression: ["hello.world.id","hello.world.message"]
+       }
+       U1db.Query{
+           id: helloListModel
+           index: by_helloworld
+           //query: "*"
+       }
+
+    MainView {
+
+        id: u1dbView
+        width: units.gu(45)
+        height: units.gu(80)
+        anchors.top: parent.top;
+
+        Tabs {
+            id: tabs
+            anchors.fill: parent
+
+            Tab {
+                objectName: "Tab1"
+
+                title: i18n.tr("Hello U1Db!")
+
+                page: Page {
+                    id: helloPage
+                   ListView {
+                        width: units.gu(45)
+                        height: units.gu(80)
+
+                        /*
+                        Here is the reference to the Database model mentioned earlier.
+                        */
+                        model: helloListModel
+
+                       /* A delegate will be created for each Document retrieved from the Database */
+                        delegate: Text {
+                            x: 66; y: 77
+                            text: {
+                                /*!
+                                    The object called 'contents' contains a string as demonstrated here. In this example 'hello' is our search string.
+
+                                    text: contents.hello
+                                */
+
+                                text: contents.id + " " + contents.message
+                            }
+                        }
+                    }
+                }
+
+
+                }
+
+            }
+
+
+
+
+        }
+
+
+
+
+
+
+
+    }
+
+

=== modified file 'index.cpp'
--- index.cpp	2013-04-03 15:36:45 +0000
+++ index.cpp	2013-04-05 14:01:48 +0000
@@ -32,7 +32,6 @@
 
 /*!
     \class Index
-    \inmodule U1db
 
     \brief The Index class defines an index to be stored in the database and
     queried using Query. Changes in documents affected by the index also update
@@ -89,6 +88,7 @@
         QObject::connect(m_database, &Database::docChanged, this, &Index::onDocChanged);
         Q_EMIT dataInvalidated();
     }
+
 }
 
 QString
@@ -126,10 +126,14 @@
 /*!
     Sets the expression used. Both an expression and a name must be specified
     for an index to be created.
+
+    Also starts the process of creating the Index result list, which can then be queried or populate the Query model as is.
+
  */
 void
 Index::setExpression(QStringList expression)
 {
+
     if (m_expression == expression)
         return;
 
@@ -140,7 +144,154 @@
     }
 
     m_expression = expression;
+
+    generateIndexResults();
+
     Q_EMIT expressionChanged(expression);
+    Q_EMIT dataIndexed();
+}
+
+/*!
+ * \brief Index::generateIndexResults
+ *
+ * Iterates through the documents stored in the database and creates the list of results based on the Index expressions.
+ */
+
+void Index::generateIndexResults()
+{
+
+    Database *db(getDatabase());
+
+    if(db){
+
+        QList<QString> documents = db->listDocs();
+
+        Q_FOREACH (QString docId, documents){
+
+            QVariant document = db->getDocUnchecked(docId);
+
+            QStringList fieldsList;
+
+            appendResultsFromMap(fieldsList, document.toMap(),"");
+
+        }
+
+    }
+
+}
+/*!
+ * \brief Index::getAllResults
+ * \return
+ */
+
+QList<QVariantMap> Index::getAllResults(){
+    return m_results;
+}
+
+/*!
+ * \brief Index::getResult
+ * \param index
+ * \return
+ */
+QVariantMap Index::getResult(int index){
+    return m_results[index];
+}
+
+/*!
+ * \brief Index::appendResultsFromMap
+ * \param fieldsList
+ * \param current_section
+ * \param current_field
+ * \return
+ *
+ *This method is desinged to recursively iterate through a document, or section of a document, which represents a QVariantMap. As it iterates through the entire document, the method keeps track of the current index expression, and populates a local QVariantMap should the current expression be found in the Index's list of expressions.
+ *
+ *If that QVariantMap contains more than one entry it is added to the global results, which can then be utilized by a Query. This needs to be modified to ensure all expressions are found, whereas at the moment if more than one expressions are defined and any of them are found then the map is added to the results list.
+ *
+ */
+QStringList Index::appendResultsFromMap(QStringList fieldsList, QVariantMap current_section, QString current_field)
+{
+
+    QMapIterator<QString, QVariant> i(current_section);
+
+    QString original_field = current_field;
+
+    QVariantMap results_map;
+
+    while (i.hasNext()) {
+
+        i.next();
+
+        if(fieldsList.count()>0){
+            current_field = original_field + "." + i.key();
+        }
+        else{
+            current_field = i.key();
+        }
+
+        fieldsList.append(current_field);
+
+        QVariant value = i.value();
+
+        if(value.userType()==8) // QVariantMap
+        {
+            fieldsList = appendResultsFromMap(fieldsList, value.toMap(),current_field);
+        }
+        else if(value.userType()==9) // QVariantList
+        {
+            fieldsList = getFieldsFromList(fieldsList, value.toList(),current_field);
+        }
+        else
+        {
+            if(m_expression.contains(current_field)==true){
+                results_map.insert(i.key(),value);
+            }
+
+        }
+    }
+
+    if(results_map.count()>0){
+       m_results.append(results_map);
+    }
+
+    return fieldsList;
+}
+/*!
+ * \brief Index::getFieldsFromList
+ * \param fieldsList
+ * \param current_section
+ * \param current_field
+ * \return
+ *
+ *This recursive method is used in conjuntion with Index::appendResultsFromMap, to aid in iterating through a document when an embedded list is found.
+ *
+ */
+
+
+QStringList Index::getFieldsFromList(QStringList fieldsList, QVariantList current_section, QString current_field)
+{
+
+    QListIterator<QVariant> i(current_section);
+
+    while (i.hasNext()) {
+
+        QVariant value = i.next();
+
+        if(value.userType()==8) // QVariantMap
+        {
+            fieldsList = appendResultsFromMap(fieldsList, value.toMap(),current_field);
+        }
+        else if(value.userType()==9) // QVariantList
+        {
+            fieldsList = getFieldsFromList(fieldsList, value.toList(),current_field);
+        }
+        else
+        {
+
+        }
+    }
+
+    return fieldsList;
 }
 
 QT_END_NAMESPACE_U1DB

=== modified file 'index.h'
--- index.h	2013-04-03 15:36:45 +0000
+++ index.h	2013-04-05 14:01:48 +0000
@@ -30,11 +30,7 @@
 
 class Q_DECL_EXPORT Index : public QObject {
     Q_OBJECT
-#ifdef Q_QDOC
-    Q_PROPERTY(Database* database READ getDatabase WRITE setDatabase NOTIFY databaseChanged)
-#else
     Q_PROPERTY(QT_PREPEND_NAMESPACE_U1DB(Database*) database READ getDatabase WRITE setDatabase NOTIFY databaseChanged)
-#endif
     Q_PROPERTY(QString name READ getName WRITE setName NOTIFY nameChanged)
     Q_PROPERTY(QStringList expression READ getExpression WRITE setExpression NOTIFY expressionChanged)
 public:
@@ -47,17 +43,25 @@
     void setName(const QString& name);
     QStringList getExpression();
     void setExpression(QStringList expression);
+    void generateIndexResults();
+    QStringList appendResultsFromMap(QStringList fieldsList, QVariantMap current_section, QString current_field);
+    QStringList getFieldsFromList(QStringList fieldsList, QVariantList current_section, QString current_field);
+    QVariantMap getResult(int index);
+    QList<QVariantMap> getAllResults();
+
 Q_SIGNALS:
     void databaseChanged(Database* database);
     void nameChanged(const QString& name);
     void expressionChanged(QVariant expression);
     // Either of the above has changed:
     void dataInvalidated();
+    void dataIndexed();
 private:
     Q_DISABLE_COPY(Index)
     Database* m_database;
     QString m_name;
     QStringList m_expression;
+    QList<QVariantMap> m_results;
 
     void onPathChanged(const QString& path);
     void onDocChanged(const QString& docId, QVariant content);

=== modified file 'query.cpp'
--- query.cpp	2013-04-03 15:36:45 +0000
+++ query.cpp	2013-04-05 14:01:48 +0000
@@ -33,7 +33,6 @@
 
 /*!
     \class Query
-    \inmodule U1db
 
     \brief The Query class generates a filtered list of documents based on either
     a query or a range, and using the given Index.
@@ -47,27 +46,27 @@
 }
 
 /*!
-    Used to implement QAbstractListModel
-    Implements the variables exposed to the Delegate in a model
-    QVariant contents
-    QString docId
-    int index (built-in)
+ * \brief Query::data
+ * \param index
+ * \param role
+ * \return
+ *Used to implement QAbstractListModel
+ *Implements the variables exposed to the Delegate in a model
  */
 QVariant
 Query::data(const QModelIndex & index, int role) const
 {
-    QString docId(m_hash.value(index.row()));
+    QVariantMap result(m_hash.value(index.row()));
     if (role == 0) // contents
     {
         Database* db(m_index->getDatabase());
         if (db)
         {
-            qDebug() << "Query::getData" << docId;
-            return db->getDocUnchecked(docId);
+            return result;
         }
     }
     if (role == 1) // docId
-        return docId;
+        //return docId;
     return QVariant();
 }
 
@@ -105,10 +104,14 @@
 Query::onDataInvalidated()
 {
     m_hash.clear();
-    Database* db(m_index->getDatabase());
-    if (db)
-        ;
-    // TODO
+
+    QListIterator<QVariantMap> i(m_index->getAllResults());
+
+    while (i.hasNext()) {
+        QVariantMap result = i.next();
+        m_hash.insert(m_hash.count(),result);
+    }
+
 }
 
 /*!
@@ -124,10 +127,13 @@
     if (m_index)
         QObject::disconnect(m_index, 0, this, 0);
     m_index = index;
-    if (m_index)
+    if (m_index){
         QObject::connect(m_index, &Index::dataInvalidated, this, &Query::onDataInvalidated);
+        QObject::connect(m_index, &Index::dataIndexed, this, &Query::onDataInvalidated);
+    }
     Q_EMIT indexChanged(index);
     onDataInvalidated();
+
 }
 
 QVariant

=== modified file 'query.h'
--- query.h	2013-04-03 15:36:45 +0000
+++ query.h	2013-04-05 14:01:48 +0000
@@ -29,11 +29,7 @@
 
 class Q_DECL_EXPORT Query : public QAbstractListModel {
     Q_OBJECT
-#ifdef Q_QDOC
-    Q_PROPERTY(Index* index READ getIndex WRITE setIndex NOTIFY indexChanged)
-#else
     Q_PROPERTY(QT_PREPEND_NAMESPACE_U1DB(Index*) index READ getIndex WRITE setIndex NOTIFY indexChanged)
-#endif
     Q_PROPERTY(QVariant query READ getQuery WRITE setQuery NOTIFY queryChanged)
     Q_PROPERTY(QVariant range READ getRange WRITE setRange NOTIFY rangeChanged)
 public:
@@ -58,7 +54,7 @@
 private:
     Q_DISABLE_COPY(Query)
     Index* m_index;
-    QHash<int, QString> m_hash;
+    QHash<int, QVariantMap> m_hash;
     QVariant m_query;
     QVariant m_range;