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