Mercurial > hg > orthanc-databases
annotate Framework/Plugins/IDatabaseBackend.h @ 224:61c309e06797
added internal class DatabaseBackendAdapterV2::Adapter
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Thu, 01 Apr 2021 16:09:59 +0200 |
parents | 73cc85f3d9c1 |
children | 94c9908e6aca |
rev | line source |
---|---|
202 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium | |
6 * | |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU Affero General Public License | |
9 * as published by the Free Software Foundation, either version 3 of | |
10 * the License, or (at your option) any later version. | |
11 * | |
12 * This program is distributed in the hope that it will be useful, but | |
13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 * Affero General Public License for more details. | |
16 * | |
17 * You should have received a copy of the GNU Affero General Public License | |
18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 **/ | |
20 | |
21 | |
22 | |
23 #pragma once | |
24 | |
25 #include "IDatabaseBackendOutput.h" | |
207
d9ef3f16e6a2
wrapping transactions in API v3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
203
diff
changeset
|
26 #include "../Common/DatabasesEnumerations.h" |
224
61c309e06797
added internal class DatabaseBackendAdapterV2::Adapter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
27 #include "../Common/IDatabaseFactory.h" |
202 | 28 |
29 #include <list> | |
30 | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
31 namespace OrthancDatabases |
202 | 32 { |
33 class IDatabaseBackend : public boost::noncopyable | |
34 { | |
35 public: | |
36 virtual ~IDatabaseBackend() | |
37 { | |
38 } | |
39 | |
40 virtual OrthancPluginContext* GetContext() = 0; | |
41 | |
224
61c309e06797
added internal class DatabaseBackendAdapterV2::Adapter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
42 virtual IDatabaseFactory* CreateDatabaseFactory() = 0; |
61c309e06797
added internal class DatabaseBackendAdapterV2::Adapter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
43 |
202 | 44 virtual void SetOutputFactory(IDatabaseBackendOutput::IFactory* factory) = 0; |
45 | |
46 virtual IDatabaseBackendOutput* CreateOutput() = 0; | |
47 | |
48 virtual void Open() = 0; | |
49 | |
50 virtual void Close() = 0; | |
51 | |
52 virtual void AddAttachment(int64_t id, | |
53 const OrthancPluginAttachment& attachment) = 0; | |
54 | |
55 virtual void AttachChild(int64_t parent, | |
56 int64_t child) = 0; | |
57 | |
58 virtual void ClearChanges() = 0; | |
59 | |
60 virtual void ClearExportedResources() = 0; | |
61 | |
62 virtual int64_t CreateResource(const char* publicId, | |
63 OrthancPluginResourceType type) = 0; | |
64 | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
65 virtual void DeleteAttachment(IDatabaseBackendOutput& output, |
202 | 66 int64_t id, |
67 int32_t attachment) = 0; | |
68 | |
69 virtual void DeleteMetadata(int64_t id, | |
70 int32_t metadataType) = 0; | |
71 | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
72 virtual void DeleteResource(IDatabaseBackendOutput& output, |
202 | 73 int64_t id) = 0; |
74 | |
75 virtual void GetAllInternalIds(std::list<int64_t>& target, | |
76 OrthancPluginResourceType resourceType) = 0; | |
77 | |
78 virtual void GetAllPublicIds(std::list<std::string>& target, | |
79 OrthancPluginResourceType resourceType) = 0; | |
80 | |
81 virtual void GetAllPublicIds(std::list<std::string>& target, | |
82 OrthancPluginResourceType resourceType, | |
83 uint64_t since, | |
84 uint64_t limit) = 0; | |
85 | |
86 /* Use GetOutput().AnswerChange() */ | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
87 virtual void GetChanges(IDatabaseBackendOutput& output, |
202 | 88 bool& done /*out*/, |
89 int64_t since, | |
90 uint32_t maxResults) = 0; | |
91 | |
92 virtual void GetChildrenInternalId(std::list<int64_t>& target /*out*/, | |
93 int64_t id) = 0; | |
94 | |
95 virtual void GetChildrenPublicId(std::list<std::string>& target /*out*/, | |
96 int64_t id) = 0; | |
97 | |
98 /* Use GetOutput().AnswerExportedResource() */ | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
99 virtual void GetExportedResources(IDatabaseBackendOutput& output, |
202 | 100 bool& done /*out*/, |
101 int64_t since, | |
102 uint32_t maxResults) = 0; | |
103 | |
104 /* Use GetOutput().AnswerChange() */ | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
105 virtual void GetLastChange(IDatabaseBackendOutput& output) = 0; |
202 | 106 |
107 /* Use GetOutput().AnswerExportedResource() */ | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
108 virtual void GetLastExportedResource(IDatabaseBackendOutput& output) = 0; |
202 | 109 |
110 /* Use GetOutput().AnswerDicomTag() */ | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
111 virtual void GetMainDicomTags(IDatabaseBackendOutput& output, |
202 | 112 int64_t id) = 0; |
113 | |
114 virtual std::string GetPublicId(int64_t resourceId) = 0; | |
115 | |
209 | 116 virtual uint64_t GetResourcesCount(OrthancPluginResourceType resourceType) = 0; |
202 | 117 |
118 virtual OrthancPluginResourceType GetResourceType(int64_t resourceId) = 0; | |
119 | |
120 virtual uint64_t GetTotalCompressedSize() = 0; | |
121 | |
122 virtual uint64_t GetTotalUncompressedSize() = 0; | |
123 | |
124 virtual bool IsExistingResource(int64_t internalId) = 0; | |
125 | |
126 virtual bool IsProtectedPatient(int64_t internalId) = 0; | |
127 | |
128 virtual void ListAvailableMetadata(std::list<int32_t>& target /*out*/, | |
129 int64_t id) = 0; | |
130 | |
131 virtual void ListAvailableAttachments(std::list<int32_t>& target /*out*/, | |
132 int64_t id) = 0; | |
133 | |
209 | 134 virtual void LogChange(int32_t changeType, |
135 int64_t resourceId, | |
136 OrthancPluginResourceType resourceType, | |
137 const char* date) = 0; | |
138 | |
202 | 139 virtual void LogExportedResource(const OrthancPluginExportedResource& resource) = 0; |
140 | |
141 /* Use GetOutput().AnswerAttachment() */ | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
142 virtual bool LookupAttachment(IDatabaseBackendOutput& output, |
202 | 143 int64_t id, |
144 int32_t contentType) = 0; | |
145 | |
146 virtual bool LookupGlobalProperty(std::string& target /*out*/, | |
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
147 const char* serverIdentifier, |
202 | 148 int32_t property) = 0; |
149 | |
150 virtual void LookupIdentifier(std::list<int64_t>& target /*out*/, | |
151 OrthancPluginResourceType resourceType, | |
152 uint16_t group, | |
153 uint16_t element, | |
154 OrthancPluginIdentifierConstraint constraint, | |
155 const char* value) = 0; | |
156 | |
157 virtual void LookupIdentifierRange(std::list<int64_t>& target /*out*/, | |
158 OrthancPluginResourceType resourceType, | |
159 uint16_t group, | |
160 uint16_t element, | |
161 const char* start, | |
162 const char* end) = 0; | |
163 | |
164 virtual bool LookupMetadata(std::string& target /*out*/, | |
165 int64_t id, | |
166 int32_t metadataType) = 0; | |
167 | |
168 virtual bool LookupParent(int64_t& parentId /*out*/, | |
169 int64_t resourceId) = 0; | |
170 | |
171 virtual bool LookupResource(int64_t& id /*out*/, | |
172 OrthancPluginResourceType& type /*out*/, | |
173 const char* publicId) = 0; | |
174 | |
175 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/) = 0; | |
176 | |
177 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/, | |
178 int64_t patientIdToAvoid) = 0; | |
179 | |
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
180 virtual void SetGlobalProperty(const char* serverIdentifier, |
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
181 int32_t property, |
202 | 182 const char* value) = 0; |
183 | |
184 virtual void SetMainDicomTag(int64_t id, | |
185 uint16_t group, | |
186 uint16_t element, | |
187 const char* value) = 0; | |
188 | |
189 virtual void SetIdentifierTag(int64_t id, | |
190 uint16_t group, | |
191 uint16_t element, | |
192 const char* value) = 0; | |
193 | |
194 virtual void SetMetadata(int64_t id, | |
195 int32_t metadataType, | |
196 const char* value) = 0; | |
197 | |
198 virtual void SetProtectedPatient(int64_t internalId, | |
199 bool isProtected) = 0; | |
200 | |
207
d9ef3f16e6a2
wrapping transactions in API v3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
203
diff
changeset
|
201 virtual void StartTransaction(TransactionType type) = 0; |
202 | 202 |
203 virtual void RollbackTransaction() = 0; | |
204 | |
205 virtual void CommitTransaction() = 0; | |
206 | |
207 virtual uint32_t GetDatabaseVersion() = 0; | |
208 | |
209 /** | |
210 * Upgrade the database to the specified version of the database | |
211 * schema. The upgrade script is allowed to make calls to | |
212 * OrthancPluginReconstructMainDicomTags(). | |
213 **/ | |
214 virtual void UpgradeDatabase(uint32_t targetVersion, | |
215 OrthancPluginStorageArea* storageArea) = 0; | |
216 | |
217 virtual void ClearMainDicomTags(int64_t internalId) = 0; | |
218 | |
219 virtual bool HasCreateInstance() const = 0; | |
220 | |
221 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
222 virtual void LookupResources(IDatabaseBackendOutput& output, |
202 | 223 const std::vector<Orthanc::DatabaseConstraint>& lookup, |
224 OrthancPluginResourceType queryLevel, | |
225 uint32_t limit, | |
226 bool requestSomeInstance) = 0; | |
227 #endif | |
228 | |
229 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
230 virtual void CreateInstance(OrthancPluginCreateInstanceResult& result, | |
231 const char* hashPatient, | |
232 const char* hashStudy, | |
233 const char* hashSeries, | |
234 const char* hashInstance) = 0; | |
235 #endif | |
236 | |
237 | |
238 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
239 virtual void SetResourcesContent( | |
240 uint32_t countIdentifierTags, | |
241 const OrthancPluginResourcesContentTags* identifierTags, | |
242 uint32_t countMainDicomTags, | |
243 const OrthancPluginResourcesContentTags* mainDicomTags, | |
244 uint32_t countMetadata, | |
245 const OrthancPluginResourcesContentMetadata* metadata) = 0; | |
246 #endif | |
247 | |
248 | |
249 virtual void GetChildrenMetadata(std::list<std::string>& target, | |
250 int64_t resourceId, | |
251 int32_t metadata) = 0; | |
252 | |
253 virtual int64_t GetLastChangeIndex() = 0; | |
254 | |
255 virtual void TagMostRecentPatient(int64_t patientId) = 0; | |
256 | |
257 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
258 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
259 // NB: "parentPublicId" must be cleared if the resource has no parent | |
260 virtual bool LookupResourceAndParent(int64_t& id, | |
261 OrthancPluginResourceType& type, | |
262 std::string& parentPublicId, | |
263 const char* publicId) = 0; | |
264 # endif | |
265 #endif | |
266 | |
267 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
268 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
269 virtual void GetAllMetadata(std::map<int32_t, std::string>& result, | |
270 int64_t id) = 0; | |
271 # endif | |
272 #endif | |
273 }; | |
274 } |