Mercurial > hg > orthanc

comparison OrthancServer/Database/IDatabaseWrapper.h @ 3093:2e1808b6146a db-changes

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
reorganization of folders
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 05 Jan 2019 16:09:21 +0100
parents OrthancServer/IDatabaseWrapper.h@476cba12c2b0
children 61da3c9b4121
comparison
equal deleted inserted replaced
3092:fc57988dbfd8 3093:2e1808b6146a
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-2019 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 General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #include "../../Core/DicomFormat/DicomMap.h"
37 #include "../../Core/FileStorage/FileInfo.h"
38 #include "../../Core/FileStorage/IStorageArea.h"
39 #include "../../Core/SQLite/ITransaction.h"
40
41 #include "../ExportedResource.h"
42 #include "../IDatabaseListener.h"
43 #include "../Search/DatabaseConstraint.h"
44 #include "../Search/DatabaseLookup.h"
45
46 #include <list>
47 #include <boost/noncopyable.hpp>
48
49 namespace Orthanc
50 {
51 class ResourcesContent;
52
53
54 class IDatabaseWrapper : public boost::noncopyable
55 {
56 public:
57 class ITransaction : public boost::noncopyable
58 {
59 public:
60 virtual ~ITransaction()
61 {
62 }
63
64 virtual void Begin() = 0;
65
66 virtual void Rollback() = 0;
67
68 virtual void Commit(int64_t fileSizeDelta) = 0;
69 };
70
71
72 struct CreateInstanceResult
73 {
74 bool isNewPatient_;
75 bool isNewStudy_;
76 bool isNewSeries_;
77 int64_t patientId_;
78 int64_t studyId_;
79 int64_t seriesId_;
80 };
81
82 virtual ~IDatabaseWrapper()
83 {
84 }
85
86 virtual void Open() = 0;
87
88 virtual void Close() = 0;
89
90 virtual void AddAttachment(int64_t id,
91 const FileInfo& attachment) = 0;
92
93 virtual void ClearChanges() = 0;
94
95 virtual void ClearExportedResources() = 0;
96
97 virtual void DeleteAttachment(int64_t id,
98 FileContentType attachment) = 0;
99
100 virtual void DeleteMetadata(int64_t id,
101 MetadataType type) = 0;
102
103 virtual void DeleteResource(int64_t id) = 0;
104
105 virtual void FlushToDisk() = 0;
106
107 virtual bool HasFlushToDisk() const = 0;
108
109 virtual void GetAllMetadata(std::map<MetadataType, std::string>& target,
110 int64_t id) = 0;
111
112 virtual void GetAllPublicIds(std::list<std::string>& target,
113 ResourceType resourceType) = 0;
114
115 virtual void GetAllPublicIds(std::list<std::string>& target,
116 ResourceType resourceType,
117 size_t since,
118 size_t limit) = 0;
119
120 virtual void GetChanges(std::list<ServerIndexChange>& target /*out*/,
121 bool& done /*out*/,
122 int64_t since,
123 uint32_t maxResults) = 0;
124
125 virtual void GetChildrenInternalId(std::list<int64_t>& target,
126 int64_t id) = 0;
127
128 virtual void GetChildrenPublicId(std::list<std::string>& target,
129 int64_t id) = 0;
130
131 virtual void GetExportedResources(std::list<ExportedResource>& target /*out*/,
132 bool& done /*out*/,
133 int64_t since,
134 uint32_t maxResults) = 0;
135
136 virtual void GetLastChange(std::list<ServerIndexChange>& target /*out*/) = 0;
137
138 virtual void GetLastExportedResource(std::list<ExportedResource>& target /*out*/) = 0;
139
140 virtual void GetMainDicomTags(DicomMap& map,
141 int64_t id) = 0;
142
143 virtual std::string GetPublicId(int64_t resourceId) = 0;
144
145 virtual uint64_t GetResourceCount(ResourceType resourceType) = 0;
146
147 virtual ResourceType GetResourceType(int64_t resourceId) = 0;
148
149 virtual uint64_t GetTotalCompressedSize() = 0;
150
151 virtual uint64_t GetTotalUncompressedSize() = 0;
152
153 virtual bool IsExistingResource(int64_t internalId) = 0;
154
155 virtual bool IsProtectedPatient(int64_t internalId) = 0;
156
157 virtual void ListAvailableMetadata(std::list<MetadataType>& target,
158 int64_t id) = 0;
159
160 virtual void ListAvailableAttachments(std::list<FileContentType>& target,
161 int64_t id) = 0;
162
163 virtual void LogChange(int64_t internalId,
164 const ServerIndexChange& change) = 0;
165
166 virtual void LogExportedResource(const ExportedResource& resource) = 0;
167
168 virtual bool LookupAttachment(FileInfo& attachment,
169 int64_t id,
170 FileContentType contentType) = 0;
171
172 virtual bool LookupGlobalProperty(std::string& target,
173 GlobalProperty property) = 0;
174
175 virtual bool LookupMetadata(std::string& target,
176 int64_t id,
177 MetadataType type) = 0;
178
179 virtual bool LookupParent(int64_t& parentId,
180 int64_t resourceId) = 0;
181
182 virtual bool LookupResource(int64_t& id,
183 ResourceType& type,
184 const std::string& publicId) = 0;
185
186 virtual bool SelectPatientToRecycle(int64_t& internalId) = 0;
187
188 virtual bool SelectPatientToRecycle(int64_t& internalId,
189 int64_t patientIdToAvoid) = 0;
190
191 virtual void SetGlobalProperty(GlobalProperty property,
192 const std::string& value) = 0;
193
194 virtual void ClearMainDicomTags(int64_t id) = 0;
195
196 virtual void SetMetadata(int64_t id,
197 MetadataType type,
198 const std::string& value) = 0;
199
200 virtual void SetProtectedPatient(int64_t internalId,
201 bool isProtected) = 0;
202
203 virtual ITransaction* StartTransaction() = 0;
204
205 virtual void SetListener(IDatabaseListener& listener) = 0;
206
207 virtual unsigned int GetDatabaseVersion() = 0;
208
209 virtual void Upgrade(unsigned int targetVersion,
210 IStorageArea& storageArea) = 0;
211
212
213 /**
214 * Primitives introduced in Orthanc 1.5.2
215 **/
216
217 virtual bool IsDiskSizeAbove(uint64_t threshold) = 0;
218
219 virtual void ApplyLookupResources(std::list<std::string>& resourcesId,
220 std::list<std::string>* instancesId, // Can be NULL if not needed
221 const std::vector<DatabaseConstraint>& lookup,
222 ResourceType queryLevel,
223 size_t limit) = 0;
224
225 // Returns "true" iff. the instance already exists. If "false" is
226 // returned, the content of "result" is undefined, but
227 // "instanceId" must be properly set.
228 virtual bool CreateInstance(CreateInstanceResult& result, /* out */
229 int64_t& instanceId, /* out */
230 const std::string& patient,
231 const std::string& study,
232 const std::string& series,
233 const std::string& instance) = 0;
234
235 // It is guaranteed that the resources to be modified have no main
236 // DICOM tags, and no DICOM identifiers associated with
237 // them. However, some metadata might be already existing, and
238 // have to be overwritten.
239 virtual void SetResourcesContent(const ResourcesContent& content) = 0;
240
241 virtual void GetChildrenMetadata(std::list<std::string>& target,
242 int64_t resourceId,
243 MetadataType metadata) = 0;
244 };
245 }