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