diff Framework/Plugins/OrthancCppDatabasePlugin.h @ 202:2def2df94f94

reorganization
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 18 Mar 2021 17:00:38 +0100
parents 42990b2dd51b
children 2089d4071408
line wrap: on
line diff
--- a/Framework/Plugins/OrthancCppDatabasePlugin.h	Thu Mar 18 16:51:51 2021 +0100
+++ b/Framework/Plugins/OrthancCppDatabasePlugin.h	Thu Mar 18 17:00:38 2021 +0100
@@ -37,7 +37,7 @@
 #endif
 
 
-#include "../../Resources/Orthanc/Databases/DatabaseConstraint.h"
+#include "IDatabaseBackend.h"
 
 #include <OrthancException.h>
 
@@ -65,326 +65,7 @@
 #include <string>
 
 namespace OrthancPlugins
-{
-  /**
-   * @ingroup Callbacks
-   **/
-
-  class IDatabaseBackendOutput : public boost::noncopyable
-  {
-  public:
-    class IFactory : public boost::noncopyable
-    {
-    public:
-      virtual ~IFactory()
-      {
-      }
-
-      virtual IDatabaseBackendOutput* CreateOutput() = 0;
-    };
-    
-    virtual ~IDatabaseBackendOutput()
-    {
-    }
-
-    virtual void SignalDeletedAttachment(const std::string& uuid,
-                                         int32_t            contentType,
-                                         uint64_t           uncompressedSize,
-                                         const std::string& uncompressedHash,
-                                         int32_t            compressionType,
-                                         uint64_t           compressedSize,
-                                         const std::string& compressedHash) = 0;
-
-    virtual void SignalDeletedResource(const std::string& publicId,
-                                       OrthancPluginResourceType resourceType) = 0;
-
-    virtual void SignalRemainingAncestor(const std::string& ancestorId,
-                                         OrthancPluginResourceType ancestorType) = 0;
-    
-    virtual void AnswerAttachment(const std::string& uuid,
-                                  int32_t            contentType,
-                                  uint64_t           uncompressedSize,
-                                  const std::string& uncompressedHash,
-                                  int32_t            compressionType,
-                                  uint64_t           compressedSize,
-                                  const std::string& compressedHash) = 0;
-
-    virtual void AnswerChange(int64_t                    seq,
-                              int32_t                    changeType,
-                              OrthancPluginResourceType  resourceType,
-                              const std::string&         publicId,
-                              const std::string&         date) = 0;
-
-    virtual void AnswerDicomTag(uint16_t group,
-                                uint16_t element,
-                                const std::string& value) = 0;
-
-    virtual void AnswerExportedResource(int64_t                    seq,
-                                        OrthancPluginResourceType  resourceType,
-                                        const std::string&         publicId,
-                                        const std::string&         modality,
-                                        const std::string&         date,
-                                        const std::string&         patientId,
-                                        const std::string&         studyInstanceUid,
-                                        const std::string&         seriesInstanceUid,
-                                        const std::string&         sopInstanceUid) = 0;
-#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
-    virtual void AnswerMatchingResource(const std::string& resourceId) = 0;
-#endif
-    
-#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
-    virtual void AnswerMatchingResource(const std::string& resourceId,
-                                        const std::string& someInstanceId) = 0;
-#endif
-  };
-  
-
-  /**
-   * @ingroup Callbacks
-   **/
-  class IDatabaseBackend : public boost::noncopyable
-  {
-  public:
-    virtual ~IDatabaseBackend()
-    {
-    }
-
-    virtual OrthancPluginContext* GetContext() = 0;
-
-    virtual void SetOutputFactory(IDatabaseBackendOutput::IFactory* factory) = 0;
-                        
-    virtual IDatabaseBackendOutput* CreateOutput() = 0;
-
-    virtual void Open() = 0;
-
-    virtual void Close() = 0;
-
-    virtual void AddAttachment(int64_t id,
-                               const OrthancPluginAttachment& attachment) = 0;
-
-    virtual void AttachChild(int64_t parent,
-                             int64_t child) = 0;
-
-    virtual void ClearChanges() = 0;
-
-    virtual void ClearExportedResources() = 0;
-
-    virtual int64_t CreateResource(const char* publicId,
-                                   OrthancPluginResourceType type) = 0;
-
-    virtual void DeleteAttachment(OrthancPlugins::IDatabaseBackendOutput& output,
-                                  int64_t id,
-                                  int32_t attachment) = 0;
-
-    virtual void DeleteMetadata(int64_t id,
-                                int32_t metadataType) = 0;
-
-    virtual void DeleteResource(OrthancPlugins::IDatabaseBackendOutput& output,
-                                int64_t id) = 0;
-
-    virtual void GetAllInternalIds(std::list<int64_t>& target,
-                                   OrthancPluginResourceType resourceType) = 0;
-
-    virtual void GetAllPublicIds(std::list<std::string>& target,
-                                 OrthancPluginResourceType resourceType) = 0;
-
-    virtual void GetAllPublicIds(std::list<std::string>& target,
-                                 OrthancPluginResourceType resourceType,
-                                 uint64_t since,
-                                 uint64_t limit) = 0;
-
-    /* Use GetOutput().AnswerChange() */
-    virtual void GetChanges(OrthancPlugins::IDatabaseBackendOutput& output,
-                            bool& done /*out*/,
-                            int64_t since,
-                            uint32_t maxResults) = 0;
-
-    virtual void GetChildrenInternalId(std::list<int64_t>& target /*out*/,
-                                       int64_t id) = 0;
-
-    virtual void GetChildrenPublicId(std::list<std::string>& target /*out*/,
-                                     int64_t id) = 0;
-
-    /* Use GetOutput().AnswerExportedResource() */
-    virtual void GetExportedResources(OrthancPlugins::IDatabaseBackendOutput& output,
-                                      bool& done /*out*/,
-                                      int64_t since,
-                                      uint32_t maxResults) = 0;
-
-    /* Use GetOutput().AnswerChange() */
-    virtual void GetLastChange(OrthancPlugins::IDatabaseBackendOutput& output) = 0;
-
-    /* Use GetOutput().AnswerExportedResource() */
-    virtual void GetLastExportedResource(OrthancPlugins::IDatabaseBackendOutput& output) = 0;
-
-    /* Use GetOutput().AnswerDicomTag() */
-    virtual void GetMainDicomTags(OrthancPlugins::IDatabaseBackendOutput& output,
-                                  int64_t id) = 0;
-
-    virtual std::string GetPublicId(int64_t resourceId) = 0;
-
-    virtual uint64_t GetResourceCount(OrthancPluginResourceType resourceType) = 0;
-
-    virtual OrthancPluginResourceType GetResourceType(int64_t resourceId) = 0;
-
-    virtual uint64_t GetTotalCompressedSize() = 0;
-    
-    virtual uint64_t GetTotalUncompressedSize() = 0;
-
-    virtual bool IsExistingResource(int64_t internalId) = 0;
-
-    virtual bool IsProtectedPatient(int64_t internalId) = 0;
-
-    virtual void ListAvailableMetadata(std::list<int32_t>& target /*out*/,
-                                       int64_t id) = 0;
-
-    virtual void ListAvailableAttachments(std::list<int32_t>& target /*out*/,
-                                          int64_t id) = 0;
-
-    virtual void LogChange(const OrthancPluginChange& change) = 0;
-
-    virtual void LogExportedResource(const OrthancPluginExportedResource& resource) = 0;
-    
-    /* Use GetOutput().AnswerAttachment() */
-    virtual bool LookupAttachment(OrthancPlugins::IDatabaseBackendOutput& output,
-                                  int64_t id,
-                                  int32_t contentType) = 0;
-
-    virtual bool LookupGlobalProperty(std::string& target /*out*/,
-                                      int32_t property) = 0;
-
-    virtual void LookupIdentifier(std::list<int64_t>& target /*out*/,
-                                  OrthancPluginResourceType resourceType,
-                                  uint16_t group,
-                                  uint16_t element,
-                                  OrthancPluginIdentifierConstraint constraint,
-                                  const char* value) = 0;
-
-    virtual void LookupIdentifierRange(std::list<int64_t>& target /*out*/,
-                                       OrthancPluginResourceType resourceType,
-                                       uint16_t group,
-                                       uint16_t element,
-                                       const char* start,
-                                       const char* end) = 0;
-
-    virtual bool LookupMetadata(std::string& target /*out*/,
-                                int64_t id,
-                                int32_t metadataType) = 0;
-
-    virtual bool LookupParent(int64_t& parentId /*out*/,
-                              int64_t resourceId) = 0;
-
-    virtual bool LookupResource(int64_t& id /*out*/,
-                                OrthancPluginResourceType& type /*out*/,
-                                const char* publicId) = 0;
-
-    virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/) = 0;
-
-    virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/,
-                                        int64_t patientIdToAvoid) = 0;
-
-    virtual void SetGlobalProperty(int32_t property,
-                                   const char* value) = 0;
-
-    virtual void SetMainDicomTag(int64_t id,
-                                 uint16_t group,
-                                 uint16_t element,
-                                 const char* value) = 0;
-
-    virtual void SetIdentifierTag(int64_t id,
-                                  uint16_t group,
-                                  uint16_t element,
-                                  const char* value) = 0;
-
-    virtual void SetMetadata(int64_t id,
-                             int32_t metadataType,
-                             const char* value) = 0;
-
-    virtual void SetProtectedPatient(int64_t internalId, 
-                                     bool isProtected) = 0;
-
-    virtual void StartTransaction() = 0;
-
-    virtual void RollbackTransaction() = 0;
-
-    virtual void CommitTransaction() = 0;
-
-    virtual uint32_t GetDatabaseVersion() = 0;
-
-    /**
-     * Upgrade the database to the specified version of the database
-     * schema.  The upgrade script is allowed to make calls to
-     * OrthancPluginReconstructMainDicomTags().
-     **/
-    virtual void UpgradeDatabase(uint32_t  targetVersion,
-                                 OrthancPluginStorageArea* storageArea) = 0;
-
-    virtual void ClearMainDicomTags(int64_t internalId) = 0;
-
-    virtual bool HasCreateInstance() const
-    {
-      return false;
-    }
-
-#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
-    virtual void LookupResources(OrthancPlugins::IDatabaseBackendOutput& output,
-                                 const std::vector<Orthanc::DatabaseConstraint>& lookup,
-                                 OrthancPluginResourceType queryLevel,
-                                 uint32_t limit,
-                                 bool requestSomeInstance) = 0;
-#endif
-
-#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
-    virtual void CreateInstance(OrthancPluginCreateInstanceResult& result,
-                                const char* hashPatient,
-                                const char* hashStudy,
-                                const char* hashSeries,
-                                const char* hashInstance)
-    {
-      throw std::runtime_error("Not implemented");
-    }
-#endif
-
-
-#if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
-    virtual void SetResourcesContent(
-      uint32_t countIdentifierTags,
-      const OrthancPluginResourcesContentTags* identifierTags,
-      uint32_t countMainDicomTags,
-      const OrthancPluginResourcesContentTags* mainDicomTags,
-      uint32_t countMetadata,
-      const OrthancPluginResourcesContentMetadata* metadata) = 0;
-#endif
-
-    
-    virtual void GetChildrenMetadata(std::list<std::string>& target,
-                                     int64_t resourceId,
-                                     int32_t metadata) = 0;
-
-    virtual int64_t GetLastChangeIndex() = 0;
-
-    virtual void TagMostRecentPatient(int64_t patientId) = 0;
-
-#if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)      // Macro introduced in 1.3.1
-#  if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4)
-    // NB: "parentPublicId" must be cleared if the resource has no parent
-    virtual bool LookupResourceAndParent(int64_t& id,
-                                         OrthancPluginResourceType& type,
-                                         std::string& parentPublicId,
-                                         const char* publicId) = 0;
-#  endif
-#endif
-
-#if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)      // Macro introduced in 1.3.1
-#  if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4)
-    virtual void GetAllMetadata(std::map<int32_t, std::string>& result,
-                                int64_t id) = 0;
-#  endif
-#endif
-  };
-
-
-
+{ 
   class DatabaseBackendOutputV2 : public IDatabaseBackendOutput
   {
   public: