Mercurial > hg > orthanc-databases
annotate Framework/Plugins/IDatabaseBackend.h @ 209:13a3863df7fa
cont
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 19 Mar 2021 17:01:38 +0100 |
| parents | d9ef3f16e6a2 |
| children | 73cc85f3d9c1 |
| 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" |
| 202 | 27 |
| 28 #include <list> | |
| 29 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
30 namespace OrthancDatabases |
| 202 | 31 { |
| 32 class IDatabaseBackend : public boost::noncopyable | |
| 33 { | |
| 34 public: | |
| 35 virtual ~IDatabaseBackend() | |
| 36 { | |
| 37 } | |
| 38 | |
| 39 virtual OrthancPluginContext* GetContext() = 0; | |
| 40 | |
| 41 virtual void SetOutputFactory(IDatabaseBackendOutput::IFactory* factory) = 0; | |
| 42 | |
| 43 virtual IDatabaseBackendOutput* CreateOutput() = 0; | |
| 44 | |
| 45 virtual void Open() = 0; | |
| 46 | |
| 47 virtual void Close() = 0; | |
| 48 | |
| 49 virtual void AddAttachment(int64_t id, | |
| 50 const OrthancPluginAttachment& attachment) = 0; | |
| 51 | |
| 52 virtual void AttachChild(int64_t parent, | |
| 53 int64_t child) = 0; | |
| 54 | |
| 55 virtual void ClearChanges() = 0; | |
| 56 | |
| 57 virtual void ClearExportedResources() = 0; | |
| 58 | |
| 59 virtual int64_t CreateResource(const char* publicId, | |
| 60 OrthancPluginResourceType type) = 0; | |
| 61 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
62 virtual void DeleteAttachment(IDatabaseBackendOutput& output, |
| 202 | 63 int64_t id, |
| 64 int32_t attachment) = 0; | |
| 65 | |
| 66 virtual void DeleteMetadata(int64_t id, | |
| 67 int32_t metadataType) = 0; | |
| 68 | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
69 virtual void DeleteResource(IDatabaseBackendOutput& output, |
| 202 | 70 int64_t id) = 0; |
| 71 | |
| 72 virtual void GetAllInternalIds(std::list<int64_t>& target, | |
| 73 OrthancPluginResourceType resourceType) = 0; | |
| 74 | |
| 75 virtual void GetAllPublicIds(std::list<std::string>& target, | |
| 76 OrthancPluginResourceType resourceType) = 0; | |
| 77 | |
| 78 virtual void GetAllPublicIds(std::list<std::string>& target, | |
| 79 OrthancPluginResourceType resourceType, | |
| 80 uint64_t since, | |
| 81 uint64_t limit) = 0; | |
| 82 | |
| 83 /* Use GetOutput().AnswerChange() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
84 virtual void GetChanges(IDatabaseBackendOutput& output, |
| 202 | 85 bool& done /*out*/, |
| 86 int64_t since, | |
| 87 uint32_t maxResults) = 0; | |
| 88 | |
| 89 virtual void GetChildrenInternalId(std::list<int64_t>& target /*out*/, | |
| 90 int64_t id) = 0; | |
| 91 | |
| 92 virtual void GetChildrenPublicId(std::list<std::string>& target /*out*/, | |
| 93 int64_t id) = 0; | |
| 94 | |
| 95 /* Use GetOutput().AnswerExportedResource() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
96 virtual void GetExportedResources(IDatabaseBackendOutput& output, |
| 202 | 97 bool& done /*out*/, |
| 98 int64_t since, | |
| 99 uint32_t maxResults) = 0; | |
| 100 | |
| 101 /* Use GetOutput().AnswerChange() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
102 virtual void GetLastChange(IDatabaseBackendOutput& output) = 0; |
| 202 | 103 |
| 104 /* Use GetOutput().AnswerExportedResource() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
105 virtual void GetLastExportedResource(IDatabaseBackendOutput& output) = 0; |
| 202 | 106 |
| 107 /* Use GetOutput().AnswerDicomTag() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
108 virtual void GetMainDicomTags(IDatabaseBackendOutput& output, |
| 202 | 109 int64_t id) = 0; |
| 110 | |
| 111 virtual std::string GetPublicId(int64_t resourceId) = 0; | |
| 112 | |
| 209 | 113 virtual uint64_t GetResourcesCount(OrthancPluginResourceType resourceType) = 0; |
| 202 | 114 |
| 115 virtual OrthancPluginResourceType GetResourceType(int64_t resourceId) = 0; | |
| 116 | |
| 117 virtual uint64_t GetTotalCompressedSize() = 0; | |
| 118 | |
| 119 virtual uint64_t GetTotalUncompressedSize() = 0; | |
| 120 | |
| 121 virtual bool IsExistingResource(int64_t internalId) = 0; | |
| 122 | |
| 123 virtual bool IsProtectedPatient(int64_t internalId) = 0; | |
| 124 | |
| 125 virtual void ListAvailableMetadata(std::list<int32_t>& target /*out*/, | |
| 126 int64_t id) = 0; | |
| 127 | |
| 128 virtual void ListAvailableAttachments(std::list<int32_t>& target /*out*/, | |
| 129 int64_t id) = 0; | |
| 130 | |
| 209 | 131 virtual void LogChange(int32_t changeType, |
| 132 int64_t resourceId, | |
| 133 OrthancPluginResourceType resourceType, | |
| 134 const char* date) = 0; | |
| 135 | |
| 202 | 136 virtual void LogExportedResource(const OrthancPluginExportedResource& resource) = 0; |
| 137 | |
| 138 /* Use GetOutput().AnswerAttachment() */ | |
|
203
2089d4071408
moving classes out of OrthancPlugins namespace, to OrthancDatabases
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
202
diff
changeset
|
139 virtual bool LookupAttachment(IDatabaseBackendOutput& output, |
| 202 | 140 int64_t id, |
| 141 int32_t contentType) = 0; | |
| 142 | |
| 143 virtual bool LookupGlobalProperty(std::string& target /*out*/, | |
| 144 int32_t property) = 0; | |
| 145 | |
| 146 virtual void LookupIdentifier(std::list<int64_t>& target /*out*/, | |
| 147 OrthancPluginResourceType resourceType, | |
| 148 uint16_t group, | |
| 149 uint16_t element, | |
| 150 OrthancPluginIdentifierConstraint constraint, | |
| 151 const char* value) = 0; | |
| 152 | |
| 153 virtual void LookupIdentifierRange(std::list<int64_t>& target /*out*/, | |
| 154 OrthancPluginResourceType resourceType, | |
| 155 uint16_t group, | |
| 156 uint16_t element, | |
| 157 const char* start, | |
| 158 const char* end) = 0; | |
| 159 | |
| 160 virtual bool LookupMetadata(std::string& target /*out*/, | |
| 161 int64_t id, | |
| 162 int32_t metadataType) = 0; | |
| 163 | |
| 164 virtual bool LookupParent(int64_t& parentId /*out*/, | |
| 165 int64_t resourceId) = 0; | |
| 166 | |
| 167 virtual bool LookupResource(int64_t& id /*out*/, | |
| 168 OrthancPluginResourceType& type /*out*/, | |
| 169 const char* publicId) = 0; | |
| 170 | |
| 171 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/) = 0; | |
| 172 | |
| 173 virtual bool SelectPatientToRecycle(int64_t& internalId /*out*/, | |
| 174 int64_t patientIdToAvoid) = 0; | |
| 175 | |
| 176 virtual void SetGlobalProperty(int32_t property, | |
| 177 const char* value) = 0; | |
| 178 | |
| 179 virtual void SetMainDicomTag(int64_t id, | |
| 180 uint16_t group, | |
| 181 uint16_t element, | |
| 182 const char* value) = 0; | |
| 183 | |
| 184 virtual void SetIdentifierTag(int64_t id, | |
| 185 uint16_t group, | |
| 186 uint16_t element, | |
| 187 const char* value) = 0; | |
| 188 | |
| 189 virtual void SetMetadata(int64_t id, | |
| 190 int32_t metadataType, | |
| 191 const char* value) = 0; | |
| 192 | |
| 193 virtual void SetProtectedPatient(int64_t internalId, | |
| 194 bool isProtected) = 0; | |
| 195 | |
|
207
d9ef3f16e6a2
wrapping transactions in API v3
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
203
diff
changeset
|
196 virtual void StartTransaction(TransactionType type) = 0; |
| 202 | 197 |
| 198 virtual void RollbackTransaction() = 0; | |
| 199 | |
| 200 virtual void CommitTransaction() = 0; | |
| 201 | |
| 202 virtual uint32_t GetDatabaseVersion() = 0; | |
| 203 | |
| 204 /** | |
| 205 * Upgrade the database to the specified version of the database | |
| 206 * schema. The upgrade script is allowed to make calls to | |
| 207 * OrthancPluginReconstructMainDicomTags(). | |
| 208 **/ | |
| 209 virtual void UpgradeDatabase(uint32_t targetVersion, | |
| 210 OrthancPluginStorageArea* storageArea) = 0; | |
| 211 | |
| 212 virtual void ClearMainDicomTags(int64_t internalId) = 0; | |
| 213 | |
| 214 virtual bool HasCreateInstance() const = 0; | |
| 215 | |
| 216 #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
|
217 virtual void LookupResources(IDatabaseBackendOutput& output, |
| 202 | 218 const std::vector<Orthanc::DatabaseConstraint>& lookup, |
| 219 OrthancPluginResourceType queryLevel, | |
| 220 uint32_t limit, | |
| 221 bool requestSomeInstance) = 0; | |
| 222 #endif | |
| 223 | |
| 224 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
| 225 virtual void CreateInstance(OrthancPluginCreateInstanceResult& result, | |
| 226 const char* hashPatient, | |
| 227 const char* hashStudy, | |
| 228 const char* hashSeries, | |
| 229 const char* hashInstance) = 0; | |
| 230 #endif | |
| 231 | |
| 232 | |
| 233 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1 | |
| 234 virtual void SetResourcesContent( | |
| 235 uint32_t countIdentifierTags, | |
| 236 const OrthancPluginResourcesContentTags* identifierTags, | |
| 237 uint32_t countMainDicomTags, | |
| 238 const OrthancPluginResourcesContentTags* mainDicomTags, | |
| 239 uint32_t countMetadata, | |
| 240 const OrthancPluginResourcesContentMetadata* metadata) = 0; | |
| 241 #endif | |
| 242 | |
| 243 | |
| 244 virtual void GetChildrenMetadata(std::list<std::string>& target, | |
| 245 int64_t resourceId, | |
| 246 int32_t metadata) = 0; | |
| 247 | |
| 248 virtual int64_t GetLastChangeIndex() = 0; | |
| 249 | |
| 250 virtual void TagMostRecentPatient(int64_t patientId) = 0; | |
| 251 | |
| 252 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
| 253 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
| 254 // NB: "parentPublicId" must be cleared if the resource has no parent | |
| 255 virtual bool LookupResourceAndParent(int64_t& id, | |
| 256 OrthancPluginResourceType& type, | |
| 257 std::string& parentPublicId, | |
| 258 const char* publicId) = 0; | |
| 259 # endif | |
| 260 #endif | |
| 261 | |
| 262 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1 | |
| 263 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 4) | |
| 264 virtual void GetAllMetadata(std::map<int32_t, std::string>& result, | |
| 265 int64_t id) = 0; | |
| 266 # endif | |
| 267 #endif | |
| 268 }; | |
| 269 } |