Mercurial > hg > orthanc
annotate OrthancServer/IDatabaseWrapper.h @ 1342:9ec7ac03152d
"?expand" flag for URIs "/patients", "/studies" and "/series"
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Fri, 03 Apr 2015 15:25:04 +0200 |
parents | 8cd5784a6d80 |
children | 0ac74fa21db8 |
rev | line source |
---|---|
1247 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1286
diff
changeset
|
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics |
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1286
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
1247 | 5 * |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU General Public License as | |
8 * published by the Free Software Foundation, either version 3 of the | |
9 * License, or (at your option) any later version. | |
10 * | |
11 * In addition, as a special exception, the copyright holders of this | |
12 * program give permission to link the code of its release with the | |
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
14 * that use the same license as the "OpenSSL" library), and distribute | |
15 * the linked executables. You must obey the GNU General Public License | |
16 * in all respects for all of the code used other than "OpenSSL". If you | |
17 * modify file(s) with this exception, you may extend this exception to | |
18 * your version of the file(s), but you are not obligated to do so. If | |
19 * you do not wish to do so, delete this exception statement from your | |
20 * version. If you delete this exception statement from all source files | |
21 * in the program, then also delete it here. | |
22 * | |
23 * This program is distributed in the hope that it will be useful, but | |
24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
26 * General Public License for more details. | |
27 * | |
28 * You should have received a copy of the GNU General Public License | |
29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
30 **/ | |
31 | |
32 | |
33 #pragma once | |
34 | |
35 #include "../Core/DicomFormat/DicomMap.h" | |
36 #include "../Core/SQLite/ITransaction.h" | |
37 #include "../Core/FileStorage/FileInfo.h" | |
38 #include "IServerIndexListener.h" | |
39 #include "ExportedResource.h" | |
40 | |
41 #include <list> | |
42 #include <boost/noncopyable.hpp> | |
43 | |
44 namespace Orthanc | |
45 { | |
46 class IDatabaseWrapper : public boost::noncopyable | |
47 { | |
48 public: | |
49 virtual ~IDatabaseWrapper() | |
50 { | |
51 } | |
52 | |
53 virtual void AddAttachment(int64_t id, | |
54 const FileInfo& attachment) = 0; | |
55 | |
56 virtual void AttachChild(int64_t parent, | |
57 int64_t child) = 0; | |
58 | |
1286 | 59 virtual void ClearChanges() = 0; |
60 | |
61 virtual void ClearExportedResources() = 0; | |
1247 | 62 |
63 virtual int64_t CreateResource(const std::string& publicId, | |
64 ResourceType type) = 0; | |
65 | |
66 virtual void DeleteAttachment(int64_t id, | |
67 FileContentType attachment) = 0; | |
68 | |
69 virtual void DeleteMetadata(int64_t id, | |
70 MetadataType type) = 0; | |
71 | |
72 virtual void DeleteResource(int64_t id) = 0; | |
73 | |
74 virtual void FlushToDisk() = 0; | |
75 | |
1306
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
76 virtual bool HasFlushToDisk() const = 0; |
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
77 |
1301 | 78 virtual void GetAllMetadata(std::map<MetadataType, std::string>& target, |
1247 | 79 int64_t id) = 0; |
80 | |
81 virtual void GetAllPublicIds(std::list<std::string>& target, | |
82 ResourceType resourceType) = 0; | |
83 | |
84 | |
85 virtual void GetChanges(std::list<ServerIndexChange>& target /*out*/, | |
86 bool& done /*out*/, | |
87 int64_t since, | |
1302 | 88 uint32_t maxResults) = 0; |
1247 | 89 |
1301 | 90 virtual void GetChildrenInternalId(std::list<int64_t>& target, |
1247 | 91 int64_t id) = 0; |
92 | |
1301 | 93 virtual void GetChildrenPublicId(std::list<std::string>& target, |
1247 | 94 int64_t id) = 0; |
95 | |
96 virtual void GetExportedResources(std::list<ExportedResource>& target /*out*/, | |
97 bool& done /*out*/, | |
98 int64_t since, | |
1302 | 99 uint32_t maxResults) = 0; |
1247 | 100 |
101 virtual void GetLastChange(std::list<ServerIndexChange>& target /*out*/) = 0; | |
102 | |
103 virtual void GetLastExportedResource(std::list<ExportedResource>& target /*out*/) = 0; | |
104 | |
105 virtual void GetMainDicomTags(DicomMap& map, | |
106 int64_t id) = 0; | |
107 | |
108 virtual std::string GetPublicId(int64_t resourceId) = 0; | |
109 | |
110 virtual uint64_t GetResourceCount(ResourceType resourceType) = 0; | |
111 | |
112 virtual ResourceType GetResourceType(int64_t resourceId) = 0; | |
113 | |
114 virtual uint64_t GetTotalCompressedSize() = 0; | |
115 | |
116 virtual uint64_t GetTotalUncompressedSize() = 0; | |
117 | |
118 virtual bool IsExistingResource(int64_t internalId) = 0; | |
119 | |
120 virtual bool IsProtectedPatient(int64_t internalId) = 0; | |
121 | |
122 virtual void ListAvailableMetadata(std::list<MetadataType>& target, | |
123 int64_t id) = 0; | |
124 | |
1301 | 125 virtual void ListAvailableAttachments(std::list<FileContentType>& target, |
1247 | 126 int64_t id) = 0; |
127 | |
128 virtual void LogChange(int64_t internalId, | |
129 const ServerIndexChange& change) = 0; | |
130 | |
131 virtual void LogExportedResource(const ExportedResource& resource) = 0; | |
132 | |
133 virtual bool LookupAttachment(FileInfo& attachment, | |
134 int64_t id, | |
135 FileContentType contentType) = 0; | |
136 | |
137 virtual bool LookupGlobalProperty(std::string& target, | |
138 GlobalProperty property) = 0; | |
139 | |
1301 | 140 virtual void LookupIdentifier(std::list<int64_t>& target, |
1247 | 141 const DicomTag& tag, |
142 const std::string& value) = 0; | |
143 | |
1301 | 144 virtual void LookupIdentifier(std::list<int64_t>& target, |
1247 | 145 const std::string& value) = 0; |
146 | |
147 virtual bool LookupMetadata(std::string& target, | |
148 int64_t id, | |
149 MetadataType type) = 0; | |
150 | |
151 virtual bool LookupParent(int64_t& parentId, | |
152 int64_t resourceId) = 0; | |
153 | |
1294 | 154 virtual bool LookupResource(int64_t& id, |
155 ResourceType& type, | |
156 const std::string& publicId) = 0; | |
1247 | 157 |
158 virtual bool SelectPatientToRecycle(int64_t& internalId) = 0; | |
159 | |
160 virtual bool SelectPatientToRecycle(int64_t& internalId, | |
161 int64_t patientIdToAvoid) = 0; | |
162 | |
163 virtual void SetGlobalProperty(GlobalProperty property, | |
164 const std::string& value) = 0; | |
165 | |
1286 | 166 virtual void SetMainDicomTag(int64_t id, |
167 const DicomTag& tag, | |
168 const std::string& value) = 0; | |
1247 | 169 |
170 virtual void SetMetadata(int64_t id, | |
171 MetadataType type, | |
172 const std::string& value) = 0; | |
173 | |
174 virtual void SetProtectedPatient(int64_t internalId, | |
175 bool isProtected) = 0; | |
176 | |
177 virtual SQLite::ITransaction* StartTransaction() = 0; | |
178 | |
179 virtual void SetListener(IServerIndexListener& listener) = 0; | |
180 }; | |
181 } |