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