refs #649, added flags amd configuration class for caching strategies of DB data

(use cache? TTL? ...)

src/blackmisc/db/dbflags.cpp

@@ -0,0 +1,52 @@
+/* Copyright (C) 2015
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+#include "blackmisc/db/dbflags.h"
+#include "blackmisc/verify.h"
+
+#include <QStringList>
+#include <QtGlobal>
+
+namespace BlackMisc
+{
+    namespace Db
+    {
+        QString CDbFlags::flagToString(CDbFlags::DataRetrievalModeFlag flag)
+        {
+            switch (flag)
+            {
+            case Unspecified: return "Unspecified";
+            case DbDirect: return "Direct DB access";
+            case Shared: return "Shared data";
+            case Cached: return "Cached data";
+            default:
+                BLACK_VERIFY_X(false, Q_FUNC_INFO, "wrong flags");
+                return "wrong flags";
+            }
+        }
+
+        QString CDbFlags::flagToString(BlackMisc::Db::CDbFlags::DataRetrievalMode flag)
+        {
+            QStringList list;
+            if (flag.testFlag(Unspecified)) list << "Unspecified";
+            if (flag.testFlag(DbDirect)) list << "Direct DB access";
+            if (flag.testFlag(Shared)) list << "Shared data";
+            if (flag.testFlag(Cached)) list << "Cached data";
+            return list.join(',');
+        }
+
+        void CDbFlags::registerMetadata()
+        {
+            // this is no value class and I register enums here,
+            // that's why I do not use the Mixins
+            qRegisterMetaType<CDbFlags::DataRetrievalModeFlag>();
+            qRegisterMetaType<CDbFlags::DataRetrievalMode>();
+        }
+    } // namespace
+} // namespace

src/blackmisc/db/dbflags.h

@@ -0,0 +1,58 @@
+/* Copyright (C) 2015
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+//! \file
+
+#ifndef BLACKMISC_DB_DBFLAGS_H
+#define BLACKMISC_DB_DBFLAGS_H
+
+#include "blackmisc/blackmiscexport.h"
+
+#include <QFlags>
+#include <QMetaType>
+#include <QString>
+
+namespace BlackMisc
+{
+    namespace Db
+    {
+        /*!
+         * What and state of reading from web services
+         */
+        class BLACKMISC_EXPORT CDbFlags
+        {
+        public:
+            //! Which data to read, requires corresponding readers
+            enum DataRetrievalModeFlag
+            {
+                Unspecified            = 0,                  //!< Unspecified
+                DbDirect               = 1 << 0,             //!< directly from DB
+                Shared                 = 1 << 1,             //!< shared directory
+                Cached                 = 1 << 2,             //!< from cache
+                DbCached               = DbDirect | Cached,  //!< from DB, but cache when possible
+                SharedCached           = Shared | Cached     //!< from shared files, but cache when possible
+            };
+            Q_DECLARE_FLAGS(DataRetrievalMode, DataRetrievalModeFlag)
+
+            //! Convert to string
+            static QString flagToString(DataRetrievalModeFlag flag);
+
+            //! Convert to string
+            static QString flagToString(BlackMisc::Db::CDbFlags::DataRetrievalMode flag);
+
+            //! Register metadata
+            static void registerMetadata();
+        };
+    } // namespace
+} // namespace
+
+Q_DECLARE_METATYPE(BlackMisc::Db::CDbFlags::DataRetrievalModeFlag)
+Q_DECLARE_METATYPE(BlackMisc::Db::CDbFlags::DataRetrievalMode)
+
+#endif // guard