annotate Framework/Plugins/IDatabaseBackendOutput.h @ 577:991b9b285e1a attach-custom-data tip

fix custom-data handling
author Alain Mazy <am@orthanc.team>
date Wed, 02 Oct 2024 09:40:20 +0200
parents f18e46d7dbf8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
507
54d518dcd74a updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 459
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
54d518dcd74a updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 459
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
459
ecd0b719cff5 update year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 389
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 *
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * This program is free software: you can redistribute it and/or
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * modify it under the terms of the GNU Affero General Public License
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * as published by the Free Software Foundation, either version 3 of
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * the License, or (at your option) any later version.
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 *
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * This program is distributed in the hope that it will be useful, but
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * Affero General Public License for more details.
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 *
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * You should have received a copy of the GNU Affero General Public License
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
547
b8e6e7a19424 un-sharing DatabaseConstraint and ISqlLookupFormatter with Orthanc core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 507
diff changeset
26 #include "DatabaseConstraint.h"
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
203
2089d4071408 moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 202
diff changeset
28 namespace OrthancDatabases
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 {
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 class IDatabaseBackendOutput : public boost::noncopyable
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 {
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 public:
232
4e15eace9b90 reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 206
diff changeset
33 /**
4e15eace9b90 reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 206
diff changeset
34 * Contrarily to its parent "IDatabaseBackendOutput" class, the
4e15eace9b90 reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 206
diff changeset
35 * "IFactory" subclass *can* be invoked from multiple threads if
4e15eace9b90 reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 206
diff changeset
36 * used through "DatabaseBackendAdapterV3". Make sure to implement
4e15eace9b90 reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 206
diff changeset
37 * proper locking if need be.
4e15eace9b90 reorganization in DatabaseBackendAdapterV3
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 206
diff changeset
38 **/
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 class IFactory : public boost::noncopyable
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 public:
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 virtual ~IFactory()
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 }
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 virtual IDatabaseBackendOutput* CreateOutput() = 0;
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 };
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 virtual ~IDatabaseBackendOutput()
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 {
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 }
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 virtual void SignalDeletedAttachment(const std::string& uuid,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 int32_t contentType,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 uint64_t uncompressedSize,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 const std::string& uncompressedHash,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 int32_t compressionType,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 uint64_t compressedSize,
366
cd9521e04249 DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents: 232
diff changeset
59 const std::string& compressedHash,
cd9521e04249 DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents: 232
diff changeset
60 const std::string& customData) = 0;
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 virtual void SignalDeletedResource(const std::string& publicId,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 OrthancPluginResourceType resourceType) = 0;
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 virtual void SignalRemainingAncestor(const std::string& ancestorId,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 OrthancPluginResourceType ancestorType) = 0;
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 virtual void AnswerAttachment(const std::string& uuid,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 int32_t contentType,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 uint64_t uncompressedSize,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 const std::string& uncompressedHash,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 int32_t compressionType,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 uint64_t compressedSize,
366
cd9521e04249 DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents: 232
diff changeset
74 const std::string& compressedHash,
cd9521e04249 DatabaseBackendAdapterV4: added support for customData + revision when not already done
Alain Mazy <am@osimis.io>
parents: 232
diff changeset
75 const std::string& customData) = 0;
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77 virtual void AnswerChange(int64_t seq,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 int32_t changeType,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 OrthancPluginResourceType resourceType,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 const std::string& publicId,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 const std::string& date) = 0;
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 virtual void AnswerDicomTag(uint16_t group,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 uint16_t element,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 const std::string& value) = 0;
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 virtual void AnswerExportedResource(int64_t seq,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 OrthancPluginResourceType resourceType,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 const std::string& publicId,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 const std::string& modality,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 const std::string& date,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 const std::string& patientId,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 const std::string& studyInstanceUid,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 const std::string& seriesInstanceUid,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 const std::string& sopInstanceUid) = 0;
206
6dcf57074dd4 starting OrthancPluginDatabaseBackendV3 wrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 203
diff changeset
96
202
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98 virtual void AnswerMatchingResource(const std::string& resourceId) = 0;
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 #endif
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 virtual void AnswerMatchingResource(const std::string& resourceId,
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 const std::string& someInstanceId) = 0;
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 #endif
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 };
2def2df94f94 reorganization
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 }