Mercurial > hg > orthanc-databases
annotate Framework/Plugins/IDatabaseBackend.h @ 265:cd73e34d5411
improved log
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 20 Apr 2021 16:14:04 +0200 |
| parents | 34e2b93a7ac1 |
| children | 16aac0287485 cd9521e04249 |
| 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" |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
27 #include "../Common/DatabaseManager.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 | |
|
255
d663d9e44f8d
reintroduction of IDatabaseFactory into DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
237
diff
changeset
|
42 virtual IDatabaseFactory* CreateDatabaseFactory() = 0; |
|
226
a4918d57435c
DatabaseManager doesn't IDatabaseFactory anymore
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
43 |
|
a4918d57435c
DatabaseManager doesn't IDatabaseFactory anymore
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
225
diff
changeset
|
44 // This function is invoked once, even if multiple connections are open |
|
237
35598014f140
refactoring to remove GlobalProperties.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
226
diff
changeset
|
45 virtual void ConfigureDatabase(DatabaseManager& database) = 0; |
|
224
61c309e06797
added internal class DatabaseBackendAdapterV2::Adapter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
221
diff
changeset
|
46 |
| 202 | 47 virtual void SetOutputFactory(IDatabaseBackendOutput::IFactory* factory) = 0; |
| 48 | |
| 49 virtual IDatabaseBackendOutput* CreateOutput() = 0; | |
| 50 | |
|
260
793bbbe11287
IDatabaseBackend::HasRevisionsSupport()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
256
diff
changeset
|
51 virtual bool HasRevisionsSupport() const = 0; |
|
793bbbe11287
IDatabaseBackend::HasRevisionsSupport()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
256
diff
changeset
|
52 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
53 virtual void AddAttachment(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
54 int64_t id, |
|
261
34e2b93a7ac1
implementing interface for revisions in attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
260
diff
changeset
|
55 const OrthancPluginAttachment& attachment, |
|
34e2b93a7ac1
implementing interface for revisions in attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
260
diff
changeset
|
56 int64_t revision) = 0; |
| 202 | 57 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
58 virtual void AttachChild(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
59 int64_t parent, |
| 202 | 60 int64_t child) = 0; |
| 61 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
62 virtual void ClearChanges(DatabaseManager& manager) = 0; |
| 202 | 63 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
64 virtual void ClearExportedResources(DatabaseManager& manager) = 0; |
| 202 | 65 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
66 virtual int64_t CreateResource(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
67 const char* publicId, |
| 202 | 68 OrthancPluginResourceType type) = 0; |
| 69 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
70 virtual void DeleteAttachment(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
71 DatabaseManager& manager, |
| 202 | 72 int64_t id, |
| 73 int32_t attachment) = 0; | |
| 74 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
75 virtual void DeleteMetadata(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
76 int64_t id, |
| 202 | 77 int32_t metadataType) = 0; |
| 78 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
79 virtual void DeleteResource(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
80 DatabaseManager& manager, |
| 202 | 81 int64_t id) = 0; |
| 82 | |
| 83 virtual void GetAllInternalIds(std::list<int64_t>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
84 DatabaseManager& manager, |
| 202 | 85 OrthancPluginResourceType resourceType) = 0; |
| 86 | |
| 87 virtual void GetAllPublicIds(std::list<std::string>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
88 DatabaseManager& manager, |
| 202 | 89 OrthancPluginResourceType resourceType) = 0; |
| 90 | |
| 91 virtual void GetAllPublicIds(std::list<std::string>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
92 DatabaseManager& manager, |
| 202 | 93 OrthancPluginResourceType resourceType, |
| 94 uint64_t since, | |
| 95 uint64_t limit) = 0; | |
| 96 | |
| 97 /* Use GetOutput().AnswerChange() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
98 virtual void GetChanges(IDatabaseBackendOutput& output, |
| 202 | 99 bool& done /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
100 DatabaseManager& manager, |
| 202 | 101 int64_t since, |
| 102 uint32_t maxResults) = 0; | |
| 103 | |
| 104 virtual void GetChildrenInternalId(std::list<int64_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
105 DatabaseManager& manager, |
| 202 | 106 int64_t id) = 0; |
| 107 | |
| 108 virtual void GetChildrenPublicId(std::list<std::string>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
109 DatabaseManager& manager, |
| 202 | 110 int64_t id) = 0; |
| 111 | |
| 112 /* Use GetOutput().AnswerExportedResource() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
113 virtual void GetExportedResources(IDatabaseBackendOutput& output, |
| 202 | 114 bool& done /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
115 DatabaseManager& manager, |
| 202 | 116 int64_t since, |
| 117 uint32_t maxResults) = 0; | |
| 118 | |
| 119 /* Use GetOutput().AnswerChange() */ | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
120 virtual void GetLastChange(IDatabaseBackendOutput& output, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
121 DatabaseManager& manager) = 0; |
| 202 | 122 |
| 123 /* Use GetOutput().AnswerExportedResource() */ | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
124 virtual void GetLastExportedResource(IDatabaseBackendOutput& output, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
125 DatabaseManager& manager) = 0; |
| 202 | 126 |
| 127 /* Use GetOutput().AnswerDicomTag() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
128 virtual void GetMainDicomTags(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
129 DatabaseManager& manager, |
| 202 | 130 int64_t id) = 0; |
| 131 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
132 virtual std::string GetPublicId(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
133 int64_t resourceId) = 0; |
| 202 | 134 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
135 virtual uint64_t GetResourcesCount(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
136 OrthancPluginResourceType resourceType) = 0; |
| 202 | 137 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
138 virtual OrthancPluginResourceType GetResourceType(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
139 int64_t resourceId) = 0; |
| 202 | 140 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
141 virtual uint64_t GetTotalCompressedSize(DatabaseManager& manager) = 0; |
| 202 | 142 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
143 virtual uint64_t GetTotalUncompressedSize(DatabaseManager& manager) = 0; |
| 202 | 144 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
145 virtual bool IsExistingResource(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
146 int64_t internalId) = 0; |
| 202 | 147 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
148 virtual bool IsProtectedPatient(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
149 int64_t internalId) = 0; |
| 202 | 150 |
| 151 virtual void ListAvailableMetadata(std::list<int32_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
152 DatabaseManager& manager, |
| 202 | 153 int64_t id) = 0; |
| 154 | |
| 155 virtual void ListAvailableAttachments(std::list<int32_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
156 DatabaseManager& manager, |
| 202 | 157 int64_t id) = 0; |
| 158 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
159 virtual void LogChange(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
160 int32_t changeType, |
| 209 | 161 int64_t resourceId, |
| 162 OrthancPluginResourceType resourceType, | |
| 163 const char* date) = 0; | |
| 164 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
165 virtual void LogExportedResource(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
166 const OrthancPluginExportedResource& resource) = 0; |
| 202 | 167 |
| 168 /* Use GetOutput().AnswerAttachment() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
169 virtual bool LookupAttachment(IDatabaseBackendOutput& output, |
|
261
34e2b93a7ac1
implementing interface for revisions in attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
260
diff
changeset
|
170 int64_t& revision /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
171 DatabaseManager& manager, |
| 202 | 172 int64_t id, |
| 173 int32_t contentType) = 0; | |
| 174 | |
| 175 virtual bool LookupGlobalProperty(std::string& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
176 DatabaseManager& manager, |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
177 const char* serverIdentifier, |
| 202 | 178 int32_t property) = 0; |
| 179 | |
| 180 virtual void LookupIdentifier(std::list<int64_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
181 DatabaseManager& manager, |
| 202 | 182 OrthancPluginResourceType resourceType, |
| 183 uint16_t group, | |
| 184 uint16_t element, | |
| 185 OrthancPluginIdentifierConstraint constraint, | |
| 186 const char* value) = 0; | |
| 187 | |
| 188 virtual void LookupIdentifierRange(std::list<int64_t>& target /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
189 DatabaseManager& manager, |
| 202 | 190 OrthancPluginResourceType resourceType, |
| 191 uint16_t group, | |
| 192 uint16_t element, | |
| 193 const char* start, | |
| 194 const char* end) = 0; | |
| 195 | |
| 196 virtual bool LookupMetadata(std::string& target /*out*/, | |
|
256
e184dcadf163
handling of revisions in metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
255
diff
changeset
|
197 int64_t& revision /*out*/, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
198 DatabaseManager& manager, |
| 202 | 199 int64_t id, |
| 200 int32_t metadataType) = 0; | |
| 201 | |
| 202 virtual bool LookupParent(int64_t& parentId /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
203 DatabaseManager& manager, |
| 202 | 204 int64_t resourceId) = 0; |
| 205 | |
| 206 virtual bool LookupResource(int64_t& id /*out*/, | |
| 207 OrthancPluginResourceType& type /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
208 DatabaseManager& manager, |
| 202 | 209 const char* publicId) = 0; |
| 210 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
211 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
212 DatabaseManager& manager) = 0; |
| 202 | 213 |
| 214 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
215 DatabaseManager& manager, |
| 202 | 216 int64_t patientIdToAvoid) = 0; |
| 217 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
218 virtual void SetGlobalProperty(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
219 const char* serverIdentifier, |
|
221
73cc85f3d9c1
implementation of the "serverIdentifier" information for global properties
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
209
diff
changeset
|
220 int32_t property, |
|
237
35598014f140
refactoring to remove GlobalProperties.cpp
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
226
diff
changeset
|
221 const char* utf8) = 0; |
| 202 | 222 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
223 virtual void SetMainDicomTag(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
224 int64_t id, |
| 202 | 225 uint16_t group, |
| 226 uint16_t element, | |
| 227 const char* value) = 0; | |
| 228 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
229 virtual void SetIdentifierTag(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
230 int64_t id, |
| 202 | 231 uint16_t group, |
| 232 uint16_t element, | |
| 233 const char* value) = 0; | |
| 234 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
235 virtual void SetMetadata(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
236 int64_t id, |
| 202 | 237 int32_t metadataType, |
|
256
e184dcadf163
handling of revisions in metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
255
diff
changeset
|
238 const char* value, |
|
e184dcadf163
handling of revisions in metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
255
diff
changeset
|
239 int64_t revision) = 0; |
| 202 | 240 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
241 virtual void SetProtectedPatient(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
242 int64_t internalId, |
| 202 | 243 bool isProtected) = 0; |
| 244 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
245 virtual uint32_t GetDatabaseVersion(DatabaseManager& manager) = 0; |
| 202 | 246 |
| 247 /** | |
| 248 * Upgrade the database to the specified version of the database | |
| 249 * schema. The upgrade script is allowed to make calls to | |
| 250 * OrthancPluginReconstructMainDicomTags(). | |
| 251 **/ | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
252 virtual void UpgradeDatabase(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
253 uint32_t targetVersion, |
| 202 | 254 OrthancPluginStorageArea* storageArea) = 0; |
| 255 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
256 virtual void ClearMainDicomTags(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
257 int64_t internalId) = 0; |
| 202 | 258 |
| 259 virtual bool HasCreateInstance() const = 0; | |
| 260 | |
| 261 #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
|
262 virtual void LookupResources(IDatabaseBackendOutput& output, |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
263 DatabaseManager& manager, |
| 202 | 264 const std::vector<Orthanc::DatabaseConstraint>& lookup, |
| 265 OrthancPluginResourceType queryLevel, | |
| 266 uint32_t limit, | |
| 267 bool requestSomeInstance) = 0; | |
| 268 #endif | |
| 269 | |
| 270 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
| 271 virtual void CreateInstance(OrthancPluginCreateInstanceResult& result, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
272 DatabaseManager& manager, |
| 202 | 273 const char* hashPatient, |
| 274 const char* hashStudy, | |
| 275 const char* hashSeries, | |
| 276 const char* hashInstance) = 0; | |
| 277 #endif | |
| 278 | |
| 279 | |
| 280 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
| 281 virtual void SetResourcesContent( | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
282 DatabaseManager& manager, |
| 202 | 283 uint32_t countIdentifierTags, |
| 284 const OrthancPluginResourcesContentTags* identifierTags, | |
| 285 uint32_t countMainDicomTags, | |
| 286 const OrthancPluginResourcesContentTags* mainDicomTags, | |
| 287 uint32_t countMetadata, | |
| 288 const OrthancPluginResourcesContentMetadata* metadata) = 0; | |
| 289 #endif | |
| 290 | |
| 291 | |
| 292 virtual void GetChildrenMetadata(std::list<std::string>& target, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
293 DatabaseManager& manager, |
| 202 | 294 int64_t resourceId, |
| 295 int32_t metadata) = 0; | |
| 296 | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
297 virtual int64_t GetLastChangeIndex(DatabaseManager& manager) = 0; |
| 202 | 298 |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
299 virtual void TagMostRecentPatient(DatabaseManager& manager, |
|
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
300 int64_t patientId) = 0; |
| 202 | 301 |
| 302 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
| 303 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
| 304 // NB: "parentPublicId" must be cleared if the resource has no parent | |
| 305 virtual bool LookupResourceAndParent(int64_t& id, | |
| 306 OrthancPluginResourceType& type, | |
| 307 std::string& parentPublicId, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
308 DatabaseManager& manager, |
| 202 | 309 const char* publicId) = 0; |
| 310 # endif | |
| 311 #endif | |
| 312 | |
| 313 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
| 314 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
| 315 virtual void GetAllMetadata(std::map<int32_t, std::string>& result, | |
|
225
94c9908e6aca
removed DatabaseManager member out of class IndexBackend
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
224
diff
changeset
|
316 DatabaseManager& manager, |
| 202 | 317 int64_t id) = 0; |
| 318 # endif | |
| 319 #endif | |
| 320 }; | |
| 321 } |