CSqlDatabaseDocumentDelegateLegacyComp.h

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ImtCore-Commercial
#pragma once
 
 
// ACF includes
#include <ifile/IDeviceBasedPersistence.h>
 
// ImtCore includes
#include <imtbase/IRevisionController.h>
#include <imtdb/IMetaInfoTableDelegate.h>
#include <imtdb/CSqlDatabaseObjectDelegateCompBase.h>
 
 
namespace imtdb
{
 
 
class CSqlDatabaseDocumentDelegateLegacyComp:
                     public imtdb::CSqlDatabaseObjectDelegateCompBase,
                     virtual public imtbase::IRevisionController
{
public:
       typedef imtdb::CSqlDatabaseObjectDelegateCompBase BaseClass;
 
       I_BEGIN_COMPONENT(CSqlDatabaseDocumentDelegateLegacyComp)
              I_REGISTER_INTERFACE(imtbase::IRevisionController);
              I_ASSIGN_MULTI_0(m_documentFactoriesCompPtr, "DocumentFactories", "Factory list used for creation of the new document instance according to the given type-ID", true);
              I_ASSIGN_MULTI_0(m_documentPersistenceListCompPtr, "DocumentPersistenceList", "List of device-based persistence components for each type of the document", true);
              I_ASSIGN(m_metaInfoTableDelegateCompPtr, "MetaInfoTableDelegate", "Delegate for the table containing meta-informations for the document type", false, "MetaInfoTableDelegate");
              I_ASSIGN(m_documentContentColumnIdAttrPtr, "DocumentContentColumnId", "ID of the column in the table containing document content", true, "Document");
              I_ASSIGN(m_metaInfoTableNameAttrPtr, "MetaInfoTableName", "Name of the meta-info table", true, "");
              I_ASSIGN(m_revisionsTableNameAttrPtr, "RevisionsTableName", "Name of the table contained document revisions", true, "");
       I_END_COMPONENT
 
       // reimplemented (imtdb::ISqlDatabaseObjectDelegate)
       virtual QByteArray GetSelectionQuery(
                            const QByteArray& objectId = QByteArray(),
                            int offset = 0,
                            int count = -1,
                            const iprm::IParamsSet* paramsPtr = nullptr) const override;
       virtual istd::IChangeableUniquePtr CreateObjectFromRecord(
                            const QSqlRecord& record,
                            const iprm::IParamsSet* paramsPtr = nullptr) const override;
       virtual NewObjectQuery CreateNewObjectQuery(
                            const QByteArray& typeId,
                            const QByteArray& proposedObjectId,
                            const QString& objectName,
                            const QString& objectDescription,
                            const istd::IChangeable* valuePtr,
                            const imtbase::IOperationContext* operationContextPtr) const override;
       virtual QByteArray CreateDeleteObjectsQuery(
                            const imtbase::IObjectCollection& collection,
                            const imtbase::ICollectionInfo::Ids& objectIds,
                            const imtbase::IOperationContext* operationContextPtr) const override;
       virtual QByteArray CreateDeleteObjectSetQuery(
                            const imtbase::IObjectCollection& collection,
                            const iprm::IParamsSet* paramsPtr = nullptr,
                            const imtbase::IOperationContext* operationContextPtr = nullptr) const override;
       virtual QByteArray CreateUpdateObjectQuery(
                            const imtbase::IObjectCollection& collection,
                            const QByteArray& objectId,
                            const istd::IChangeable& object,
                            const imtbase::IOperationContext* operationContextPtr,
                            bool useExternDelegate = true) const override;
       virtual QByteArray CreateRenameObjectQuery(
                            const imtbase::IObjectCollection& collection,
                            const QByteArray& objectId,
                            const QString& newObjectName,
                            const imtbase::IOperationContext* operationContextPtr) const override;
       virtual QByteArray CreateDescriptionObjectQuery(
                            const imtbase::IObjectCollection& collection,
                            const QByteArray& objectId,
                            const QString& description,
                            const imtbase::IOperationContext* operationContextPtr) const override;
 
       // reimplemented (imtbase::IRevisionController)
       virtual RevisionInfoList GetRevisionInfoList(
                            const imtbase::IObjectCollection& collection,
                            const QByteArray& objectId) const override;
       virtual int BackupRevision(
                            const imtbase::IObjectCollection& collection,
                            const imtbase::ICollectionInfo::Id& objectId,
                            const QString& userComment = QString()) const override;
       virtual bool RestoreRevision(
                            imtbase::IObjectCollection& collection,
                            const imtbase::ICollectionInfo::Id& objectId,
                            int revision) const override;
       virtual bool ExportRevision(
                            const imtbase::IObjectCollection& collection,
                            const imtbase::ICollectionInfo::Id& objectId,
                            int revision,
                            const QString& filePath) const override;
       virtual bool DeleteRevision(
                            imtbase::IObjectCollection& collection,
                            const imtbase::ICollectionInfo::Id& objectId,
                            int revision) const override;
 
protected:
       virtual istd::IChangeableUniquePtr CreateObject(const QByteArray& typeId) const;
       virtual bool WriteDataToMemory(const QByteArray& typeId, const istd::IChangeable& object, QByteArray& data) const;
       virtual bool ReadDataFromMemory(const QByteArray& typeId, const QByteArray& data, istd::IChangeable& object) const;
 
       // reimplemented (imtdb::CSqlDatabaseObjectDelegateCompBase)
       virtual QString GetBaseSelectionQuery() const override;
       virtual bool CreateObjectFilterQuery(const iprm::IParamsSet& filterParams, QString& filterQuery) const override;
       virtual bool CreateObjectInfoFromRecord(
                            const QByteArray& typeId,
                            const QSqlRecord& record,
                            idoc::MetaInfoPtr& objectMetaInfoPtr,
                            idoc::MetaInfoPtr& collectionItemMetaInfoPtr) const;
       virtual idoc::MetaInfoPtr CreateObjectMetaInfo(const QByteArray& typeId) const override;
       virtual bool SetObjectMetaInfoFromRecord(const QSqlRecord& record, idoc::IDocumentMetaInfo& metaInfo) const override;
 
protected:
       virtual QByteArray CreateOperationDescriptionQuery(const QByteArray& objectId, const imtbase::IOperationContext* operationContextPtr) const;
       const ifile::IDeviceBasedPersistence* FindDocumentPersistence(const QByteArray& typeId) const;
       virtual QByteArray CreateObjectHistoryQuery(
              int offset = 0,
              int count = -1,
              const iprm::IParamsSet* paramsPtr = nullptr) const
       {
              Q_UNUSED(offset);
              Q_UNUSED(count);
              Q_UNUSED(paramsPtr);
 
              return QByteArray();
       }
 
protected:
       I_MULTIFACT(istd::IChangeable, m_documentFactoriesCompPtr);
       I_MULTIREF(ifile::IDeviceBasedPersistence, m_documentPersistenceListCompPtr);
       I_REF(IMetaInfoTableDelegate, m_metaInfoTableDelegateCompPtr);
       I_ATTR(QByteArray, m_documentContentColumnIdAttrPtr);
       I_ATTR(QByteArray, m_metaInfoTableNameAttrPtr);
       I_ATTR(QByteArray, m_revisionsTableNameAttrPtr);
};
 
 
} // namespace imtdb