datastore.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2015 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_DB_DATASTORE_H
#define SWIFT_MISC_DB_DATASTORE_H
 
#include <QJsonObject>
#include <QJsonValue>
#include <QObject>
#include <QString>
#include <QVersionNumber>
 
#include "config/buildconfig.h"
#include "misc/propertyindex.h"
#include "misc/swiftmiscexport.h"
#include "misc/timestampbased.h"
 
namespace swift::misc
{
    class CIcon;
    namespace db
    {
        enum DbKeyState
        {
            Undefined = 0,
            Valid = 1 << 0,
            Invalid = 1 << 1,
            All = Valid | Invalid
        };
 
        Q_DECLARE_FLAGS(DbKeyStateFilter, DbKeyState)
 
        
        class SWIFT_MISC_EXPORT IDatastoreObject : public ITimestampBased
        {
            // since we use different keys all the compares, set, get are in the derived class
            // in general we can say, it was a bad decision to use different key types
            // IndexDbIntegerKey = CPropertyIndexRef::GlobalIndexIDatastore for future usage
 
        public:
            const QString &getVersion() const { return m_version; }
 
            QVersionNumber getQVersion() const;
 
            bool hasVersion() const { return !m_version.isEmpty(); }
 
            void setVersion(const QString &version) { m_version = version; }
 
        protected:
            void setTimestampVersionFromDatabaseJson(const QJsonObject &json, const QString &prefix = QString());
 
            QString m_version; 
        };
 
        class SWIFT_MISC_EXPORT IDatastoreObjectWithIntegerKey : public IDatastoreObject
        {
        public:
            enum ColumnIndex
            {
                IndexDbIntegerKey = CPropertyIndexRef::GlobalIndexIDatastoreInteger,
                IndexDbKeyAsString,
                IndexIsLoadedFromDb,
                IndexDatabaseIcon,
                IndexVersion,
                IndexEndMarker 
            };
 
            int getDbKey() const { return m_dbKey; }
 
            QString getDbKeyAsString() const;
 
            QJsonValue getDbKeyAsJsonValue() const;
 
            QString getDbKeyAsStringInParentheses(const QString &prefix = {}) const;
 
            void setDbKey(int key) { m_dbKey = key; }
 
            void setDbKey(const QString &key);
 
            bool hasValidDbKey() const { return m_dbKey >= 0; }
 
            bool isDbEqual(const IDatastoreObjectWithIntegerKey &other) const
            {
                return other.isLoadedFromDb() && this->isLoadedFromDb() && other.getDbKey() == this->getDbKey();
            }
 
            bool isLoadedFromDb() const;
 
            bool matchesDbKeyState(db::DbKeyStateFilter filter) const;
 
            const CIcon &toDatabaseIcon() const;
 
            static int invalidDbKey() { return -1; }
 
            static int stringToDbKey(const QString &candidate);
 
            static const CPropertyIndex &keyIndex()
            {
                static const CPropertyIndex k(IndexDbIntegerKey);
                return k;
            }
 
        protected:
            IDatastoreObjectWithIntegerKey() {}
 
            IDatastoreObjectWithIntegerKey(int key) : m_dbKey(key) {}
 
            void setKeyVersionTimestampFromDatabaseJson(const QJsonObject &json, const QString &prefix = QString());
 
            static bool existsKey(const QJsonObject &json, const QString &prefix = QString());
 
            QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
            void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
            int comparePropertyByIndex(CPropertyIndexRef index,
                                       const IDatastoreObjectWithIntegerKey &compareValue) const;
 
            static bool canHandleIndex(swift::misc::CPropertyIndexRef index);
 
            int m_dbKey = -1; 
        };
 
        class SWIFT_MISC_EXPORT IDatastoreObjectWithStringKey : public IDatastoreObject
        {
        public:
            enum ColumnIndex
            {
                IndexDbStringKey = CPropertyIndexRef::GlobalIndexIDatastoreString,
                IndexDbKeyAsString,
                IndexIsLoadedFromDb,
                IndexDatabaseIcon,
                IndexVersion,
                IndexEndMarker 
            };
 
            const QString &getDbKey() const { return m_dbKey; }
 
            QString getDbKeyAsString() const { return getDbKey(); }
 
            QJsonValue getDbKeyAsJsonValue() const;
 
            QString getDbKeyAsStringInParentheses(const QString &prefix = {}) const;
 
            void setDbKey(const QString &key) { m_dbKey = key.trimmed().toUpper(); }
 
            bool hasValidDbKey() const { return !m_dbKey.isEmpty(); }
 
            bool isDbEqual(const IDatastoreObjectWithStringKey &other) const
            {
                return other.isLoadedFromDb() && this->isLoadedFromDb() && other.getDbKey() == this->getDbKey();
            }
 
            bool isLoadedFromDb() const { return m_loadedFromDb; }
 
            void setLoadedFromDb(bool loaded) { m_loadedFromDb = loaded; }
 
            bool matchesDbKeyState(db::DbKeyStateFilter filter) const;
 
            const CIcon &toDatabaseIcon() const;
 
            static QString invalidDbKey() { return {}; }
 
            static const CPropertyIndex &keyIndex()
            {
                static const CPropertyIndex k(IndexDbStringKey);
                return k;
            }
 
        protected:
            IDatastoreObjectWithStringKey() {}
 
            IDatastoreObjectWithStringKey(const QString &key) : m_dbKey(key) {}
 
            void setKeyVersionTimestampFromDatabaseJson(const QJsonObject &json, const QString &prefix = QString());
 
            static bool existsKey(const QJsonObject &json, const QString &prefix = QString());
 
            QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
            void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
            int comparePropertyByIndex(swift::misc::CPropertyIndexRef index,
                                       const IDatastoreObjectWithStringKey &compareValue) const;
 
            static bool canHandleIndex(swift::misc::CPropertyIndexRef index);
 
            QString m_dbKey; 
            bool m_loadedFromDb =
                false; 
        };
    } // namespace db
} // namespace swift::misc
 
Q_DECLARE_METATYPE(swift::misc::db::DbKeyState)
Q_DECLARE_METATYPE(swift::misc::db::DbKeyStateFilter)
Q_DECLARE_OPERATORS_FOR_FLAGS(swift::misc::db::DbKeyStateFilter)
 
#endif // SWIFT_MISC_DB_DATASTORE_H