Mercurial > hg > orthanc
annotate OrthancServer/IDatabaseWrapper.h @ 1745:38dda23c7d7d db-changes
LookupIdentifierQuery
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 26 Oct 2015 13:47:50 +0100 |
parents | 54d78925cbb6 |
children | d143db00a794 |
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" | |
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
37 #include "../Core/FileStorage/IStorageArea.h" |
1247 | 38 #include "../Core/FileStorage/FileInfo.h" |
1432
0ac74fa21db8
rename IServerIndexListener as IDatabaseListener
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1306
diff
changeset
|
39 #include "IDatabaseListener.h" |
1247 | 40 #include "ExportedResource.h" |
41 | |
42 #include <list> | |
43 #include <boost/noncopyable.hpp> | |
44 | |
45 namespace Orthanc | |
46 { | |
1745
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1729
diff
changeset
|
47 class LookupIdentifierQuery; |
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1729
diff
changeset
|
48 |
1247 | 49 class IDatabaseWrapper : public boost::noncopyable |
50 { | |
51 public: | |
52 virtual ~IDatabaseWrapper() | |
53 { | |
54 } | |
55 | |
1672
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
56 virtual void Open() = 0; |
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
57 |
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
58 virtual void Close() = 0; |
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
59 |
1247 | 60 virtual void AddAttachment(int64_t id, |
61 const FileInfo& attachment) = 0; | |
62 | |
63 virtual void AttachChild(int64_t parent, | |
64 int64_t child) = 0; | |
65 | |
1286 | 66 virtual void ClearChanges() = 0; |
67 | |
68 virtual void ClearExportedResources() = 0; | |
1247 | 69 |
70 virtual int64_t CreateResource(const std::string& publicId, | |
71 ResourceType type) = 0; | |
72 | |
73 virtual void DeleteAttachment(int64_t id, | |
74 FileContentType attachment) = 0; | |
75 | |
76 virtual void DeleteMetadata(int64_t id, | |
77 MetadataType type) = 0; | |
78 | |
79 virtual void DeleteResource(int64_t id) = 0; | |
80 | |
81 virtual void FlushToDisk() = 0; | |
82 | |
1306
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
83 virtual bool HasFlushToDisk() const = 0; |
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
84 |
1301 | 85 virtual void GetAllMetadata(std::map<MetadataType, std::string>& target, |
1247 | 86 int64_t id) = 0; |
87 | |
88 virtual void GetAllPublicIds(std::list<std::string>& target, | |
89 ResourceType resourceType) = 0; | |
90 | |
1509
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
91 virtual void GetAllPublicIds(std::list<std::string>& target, |
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
92 ResourceType resourceType, |
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
93 size_t since, |
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
94 size_t limit) = 0; |
1247 | 95 |
96 virtual void GetChanges(std::list<ServerIndexChange>& target /*out*/, | |
97 bool& done /*out*/, | |
98 int64_t since, | |
1302 | 99 uint32_t maxResults) = 0; |
1247 | 100 |
1301 | 101 virtual void GetChildrenInternalId(std::list<int64_t>& target, |
1247 | 102 int64_t id) = 0; |
103 | |
1301 | 104 virtual void GetChildrenPublicId(std::list<std::string>& target, |
1247 | 105 int64_t id) = 0; |
106 | |
107 virtual void GetExportedResources(std::list<ExportedResource>& target /*out*/, | |
108 bool& done /*out*/, | |
109 int64_t since, | |
1302 | 110 uint32_t maxResults) = 0; |
1247 | 111 |
112 virtual void GetLastChange(std::list<ServerIndexChange>& target /*out*/) = 0; | |
113 | |
114 virtual void GetLastExportedResource(std::list<ExportedResource>& target /*out*/) = 0; | |
115 | |
116 virtual void GetMainDicomTags(DicomMap& map, | |
117 int64_t id) = 0; | |
118 | |
119 virtual std::string GetPublicId(int64_t resourceId) = 0; | |
120 | |
121 virtual uint64_t GetResourceCount(ResourceType resourceType) = 0; | |
122 | |
123 virtual ResourceType GetResourceType(int64_t resourceId) = 0; | |
124 | |
125 virtual uint64_t GetTotalCompressedSize() = 0; | |
126 | |
127 virtual uint64_t GetTotalUncompressedSize() = 0; | |
128 | |
129 virtual bool IsExistingResource(int64_t internalId) = 0; | |
130 | |
131 virtual bool IsProtectedPatient(int64_t internalId) = 0; | |
132 | |
133 virtual void ListAvailableMetadata(std::list<MetadataType>& target, | |
134 int64_t id) = 0; | |
135 | |
1301 | 136 virtual void ListAvailableAttachments(std::list<FileContentType>& target, |
1247 | 137 int64_t id) = 0; |
138 | |
139 virtual void LogChange(int64_t internalId, | |
140 const ServerIndexChange& change) = 0; | |
141 | |
142 virtual void LogExportedResource(const ExportedResource& resource) = 0; | |
143 | |
144 virtual bool LookupAttachment(FileInfo& attachment, | |
145 int64_t id, | |
146 FileContentType contentType) = 0; | |
147 | |
148 virtual bool LookupGlobalProperty(std::string& target, | |
149 GlobalProperty property) = 0; | |
150 | |
1728
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
151 virtual void LookupIdentifierExact(std::list<int64_t>& target, |
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
152 ResourceType level, |
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
153 const DicomTag& tag, |
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
154 const std::string& value) = 0; |
1247 | 155 |
1745
38dda23c7d7d
LookupIdentifierQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1729
diff
changeset
|
156 virtual void LookupIdentifier(const LookupIdentifierQuery& query) = 0; |
1729 | 157 |
1247 | 158 virtual bool LookupMetadata(std::string& target, |
159 int64_t id, | |
160 MetadataType type) = 0; | |
161 | |
162 virtual bool LookupParent(int64_t& parentId, | |
163 int64_t resourceId) = 0; | |
164 | |
1294 | 165 virtual bool LookupResource(int64_t& id, |
166 ResourceType& type, | |
167 const std::string& publicId) = 0; | |
1247 | 168 |
169 virtual bool SelectPatientToRecycle(int64_t& internalId) = 0; | |
170 | |
171 virtual bool SelectPatientToRecycle(int64_t& internalId, | |
172 int64_t patientIdToAvoid) = 0; | |
173 | |
174 virtual void SetGlobalProperty(GlobalProperty property, | |
175 const std::string& value) = 0; | |
176 | |
1668
de1413733c97
reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
177 virtual void ClearMainDicomTags(int64_t id) = 0; |
de1413733c97
reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
178 |
1286 | 179 virtual void SetMainDicomTag(int64_t id, |
180 const DicomTag& tag, | |
181 const std::string& value) = 0; | |
1247 | 182 |
1713 | 183 virtual void SetIdentifierTag(int64_t id, |
184 const DicomTag& tag, | |
185 const std::string& value) = 0; | |
186 | |
1247 | 187 virtual void SetMetadata(int64_t id, |
188 MetadataType type, | |
189 const std::string& value) = 0; | |
190 | |
191 virtual void SetProtectedPatient(int64_t internalId, | |
192 bool isProtected) = 0; | |
193 | |
194 virtual SQLite::ITransaction* StartTransaction() = 0; | |
195 | |
1432
0ac74fa21db8
rename IServerIndexListener as IDatabaseListener
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1306
diff
changeset
|
196 virtual void SetListener(IDatabaseListener& listener) = 0; |
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
197 |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
198 virtual unsigned int GetDatabaseVersion() = 0; |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
199 |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
200 virtual void Upgrade(unsigned int targetVersion, |
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
201 IStorageArea& storageArea) = 0; |
1247 | 202 }; |
203 } |