Rename EventTreeModel -> PeriodDayEventModel + doc the model architecture

4 files changed, 46 insertions, 27 deletions

diff --git a/framework/src/CMakeLists.txt b/framework/src/CMakeLists.txt
index a4392b33..a3c489b4 100644
--- a/framework/src/CMakeLists.txt
+++ b/framework/src/CMakeLists.txt
@@ -17,7 +17,7 @@ add_library(kubeframework SHARED
     settings/settings.cpp
     domain/maillistmodel.cpp
     domain/folderlistmodel.cpp
-    domain/eventtreemodel.cpp
+    domain/perioddayeventmodel.cpp
     domain/composercontroller.cpp
     domain/modeltest.cpp
     domain/retriever.cpp
diff --git a/framework/src/domain/eventtreemodel.cpp b/framework/src/domain/perioddayeventmodel.cpp
index 4e25cffe..0b374d5c 100644
--- a/framework/src/domain/eventtreemodel.cpp
+++ b/framework/src/domain/perioddayeventmodel.cpp
@@ -19,7 +19,7 @@
     02110-1301, USA.
 */
 
-#include "eventtreemodel.h"
+#include "perioddayeventmodel.h"
 
 #include <sink/log.h>
 #include <sink/query.h>
@@ -29,7 +29,7 @@
 #include <QJsonObject>
 #include <QMetaEnum>
 
-EventTreeModel::EventTreeModel(QObject *parent) : QAbstractItemModel(parent), partitionedEvents(7)
+PeriodDayEventModel::PeriodDayEventModel(QObject *parent) : QAbstractItemModel(parent), partitionedEvents(7)
 {
     Sink::Query query;
     query.setFlags(Sink::Query::LiveQuery);
@@ -40,17 +40,17 @@ EventTreeModel::EventTreeModel(QObject *parent) : QAbstractItemModel(parent), pa
 
     eventModel = Sink::Store::loadModel<Event>(query);
 
-    QObject::connect(eventModel.data(), &QAbstractItemModel::dataChanged, this, &EventTreeModel::partitionData);
-    QObject::connect(eventModel.data(), &QAbstractItemModel::layoutChanged, this, &EventTreeModel::partitionData);
-    QObject::connect(eventModel.data(), &QAbstractItemModel::modelReset, this, &EventTreeModel::partitionData);
-    QObject::connect(eventModel.data(), &QAbstractItemModel::rowsInserted, this, &EventTreeModel::partitionData);
-    QObject::connect(eventModel.data(), &QAbstractItemModel::rowsMoved, this, &EventTreeModel::partitionData);
-    QObject::connect(eventModel.data(), &QAbstractItemModel::rowsRemoved, this, &EventTreeModel::partitionData);
+    QObject::connect(eventModel.data(), &QAbstractItemModel::dataChanged, this, &PeriodDayEventModel::partitionData);
+    QObject::connect(eventModel.data(), &QAbstractItemModel::layoutChanged, this, &PeriodDayEventModel::partitionData);
+    QObject::connect(eventModel.data(), &QAbstractItemModel::modelReset, this, &PeriodDayEventModel::partitionData);
+    QObject::connect(eventModel.data(), &QAbstractItemModel::rowsInserted, this, &PeriodDayEventModel::partitionData);
+    QObject::connect(eventModel.data(), &QAbstractItemModel::rowsMoved, this, &PeriodDayEventModel::partitionData);
+    QObject::connect(eventModel.data(), &QAbstractItemModel::rowsRemoved, this, &PeriodDayEventModel::partitionData);
 
     partitionData();
 }
 
-void EventTreeModel::partitionData()
+void PeriodDayEventModel::partitionData()
 {
     SinkLog() << "Partitioning event data";
 
@@ -78,7 +78,7 @@ void EventTreeModel::partitionData()
     endResetModel();
 }
 
-int EventTreeModel::bucketOf(QDate const &candidate) const
+int PeriodDayEventModel::bucketOf(QDate const &candidate) const
 {
     int bucket = mViewStart.daysTo(candidate);
     if(bucket >= mViewLength || bucket < 0) {
@@ -88,7 +88,7 @@ int EventTreeModel::bucketOf(QDate const &candidate) const
     return bucket;
 }
 
-QModelIndex EventTreeModel::index(int row, int column, const QModelIndex &parent) const
+QModelIndex PeriodDayEventModel::index(int row, int column, const QModelIndex &parent) const
 {
     if (!hasIndex(row, column, parent)) {
         return {};
@@ -115,7 +115,7 @@ QModelIndex EventTreeModel::index(int row, int column, const QModelIndex &parent
     return createIndex(row, column, day);
 }
 
-QModelIndex EventTreeModel::parent(const QModelIndex &index) const
+QModelIndex PeriodDayEventModel::parent(const QModelIndex &index) const
 {
     if (!index.isValid()) {
         return {};
@@ -130,7 +130,7 @@ QModelIndex EventTreeModel::parent(const QModelIndex &index) const
     return this->index(day, 0);
 }
 
-int EventTreeModel::rowCount(const QModelIndex &parent) const
+int PeriodDayEventModel::rowCount(const QModelIndex &parent) const
 {
     if (!parent.isValid()) {
         return mViewLength;
@@ -141,7 +141,7 @@ int EventTreeModel::rowCount(const QModelIndex &parent) const
     return partitionedEvents[day].size();
 }
 
-int EventTreeModel::columnCount(const QModelIndex &parent) const
+int PeriodDayEventModel::columnCount(const QModelIndex &parent) const
 {
     if (!parent.isValid()) {
         return 1;
@@ -150,7 +150,7 @@ int EventTreeModel::columnCount(const QModelIndex &parent) const
     return eventModel->columnCount();
 }
 
-QVariant EventTreeModel::data(const QModelIndex &id, int role) const
+QVariant PeriodDayEventModel::data(const QModelIndex &id, int role) const
 {
     if (id.internalId() == DAY_ID) {
         auto day = id.row();
@@ -211,7 +211,7 @@ QVariant EventTreeModel::data(const QModelIndex &id, int role) const
     }
 }
 
-QHash<int, QByteArray> EventTreeModel::roleNames() const
+QHash<int, QByteArray> PeriodDayEventModel::roleNames() const
 {
     QHash<int, QByteArray> roles;
 
@@ -224,12 +224,12 @@ QHash<int, QByteArray> EventTreeModel::roleNames() const
     return roles;
 }
 
-QDate EventTreeModel::viewStart() const
+QDate PeriodDayEventModel::viewStart() const
 {
     return mViewStart;
 }
 
-void EventTreeModel::setViewStart(QDate start)
+void PeriodDayEventModel::setViewStart(QDate start)
 {
     if (!start.isValid()) {
         SinkWarning() << "Passed an invalid starting date in setViewStart, ignoring...";
@@ -240,17 +240,17 @@ void EventTreeModel::setViewStart(QDate start)
     partitionData();
 }
 
-void EventTreeModel::setViewStart(QVariant start)
+void PeriodDayEventModel::setViewStart(QVariant start)
 {
     setViewStart(start.toDate());
 }
 
-int EventTreeModel::viewLength() const
+int PeriodDayEventModel::viewLength() const
 {
     return mViewLength;
 }
 
-void EventTreeModel::setViewLength(int length)
+void PeriodDayEventModel::setViewLength(int length)
 {
     mViewLength = std::move(length);
     partitionData();
diff --git a/framework/src/domain/eventtreemodel.h b/framework/src/domain/perioddayeventmodel.h
index 516410ee..cd26fe46 100644
--- a/framework/src/domain/eventtreemodel.h
+++ b/framework/src/domain/perioddayeventmodel.h
@@ -30,6 +30,25 @@
 
 #include <limits>
 
+// Facility used to get a restricted view into a Sink model comprised of
+// events, partitioned according to the day the events take place.
+//
+// Model Format
+// ============
+//
+// Day 0
+//  |--- Event 0 starting at `viewStart + 0d`
+//  |--- Event 1 starting at `viewStart + 0d`
+//  '--- Event 2 starting at `viewStart + 0d`
+// Day 1
+//  '--- Event 0 starting at `viewStart + 1d`
+// Day 2
+// Day 3
+//  |--- Event 0 starting at `viewStart + 3d`
+//  '--- Event 1 starting at `viewStart + 3d`
+// Day 4
+//   ⋮
+//
 // Implementation notes
 // ====================
 //
@@ -57,7 +76,7 @@
 //    |                '--- List of event pointers for that day
 //    '--- Partition / day
 //
-class EventTreeModel : public QAbstractItemModel
+class PeriodDayEventModel : public QAbstractItemModel
 {
     Q_OBJECT
 
@@ -76,8 +95,8 @@ public:
         Duration,
     };
     Q_ENUM(Roles);
-    EventTreeModel(QObject *parent = nullptr);
-    ~EventTreeModel() = default;
+    PeriodDayEventModel(QObject *parent = nullptr);
+    ~PeriodDayEventModel() = default;
 
     QModelIndex index(int row, int column, const QModelIndex &parent = {}) const override;
     QModelIndex parent(const QModelIndex &index) const override;
diff --git a/framework/src/frameworkplugin.cpp b/framework/src/frameworkplugin.cpp
index 289f502b..2eb53237 100644
--- a/framework/src/frameworkplugin.cpp
+++ b/framework/src/frameworkplugin.cpp
@@ -22,7 +22,7 @@
 
 #include "domain/maillistmodel.h"
 #include "domain/folderlistmodel.h"
-#include "domain/eventtreemodel.h"
+#include "domain/perioddayeventmodel.h"
 #include "domain/composercontroller.h"
 #include "domain/mime/messageparser.h"
 #include "domain/retriever.h"
@@ -121,7 +121,7 @@ void FrameworkPlugin::registerTypes (const char *uri)
 {
     qmlRegisterType<FolderListModel>(uri, 1, 0, "FolderListModel");
     qmlRegisterType<MailListModel>(uri, 1, 0, "MailListModel");
-    qmlRegisterType<EventTreeModel>(uri, 1, 0, "EventTreeModel");
+    qmlRegisterType<PeriodDayEventModel>(uri, 1, 0, "PeriodDayEventModel");
     qmlRegisterType<ComposerController>(uri, 1, 0, "ComposerController");
     qmlRegisterType<Kube::ControllerAction>(uri, 1, 0, "ControllerAction");
     qmlRegisterType<MessageParser>(uri, 1, 0, "MessageParser");