Mercurial > hg > orthanc

comparison OrthancServer/IDatabaseWrapper.h @ 1247:32fcc5dc7562

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
abstraction
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 08 Dec 2014 13:54:27 +0100
parents
children ee43f0d611a8
comparison
equal deleted inserted replaced
1246:54bf0f0245f4 1247:32fcc5dc7562
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege,
4 * Belgium
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
59 virtual void ClearTable(const std::string& tableName) = 0;
60
61 virtual int64_t CreateResource(const std::string& publicId,
62 ResourceType type) = 0;
63
64 virtual void DeleteAttachment(int64_t id,
65 FileContentType attachment) = 0;
66
67 virtual void DeleteMetadata(int64_t id,
68 MetadataType type) = 0;
69
70 virtual void DeleteResource(int64_t id) = 0;
71
72 virtual void FlushToDisk() = 0;
73
74 virtual void GetAllMetadata(std::map<MetadataType, std::string>& result,
75 int64_t id) = 0;
76
77 virtual void GetAllPublicIds(std::list<std::string>& target,
78 ResourceType resourceType) = 0;
79
80
81 virtual void GetChanges(std::list<ServerIndexChange>& target /*out*/,
82 bool& done /*out*/,
83 int64_t since,
84 unsigned int maxResults) = 0;
85
86 virtual void GetChildrenInternalId(std::list<int64_t>& result,
87 int64_t id) = 0;
88
89 virtual void GetChildrenPublicId(std::list<std::string>& result,
90 int64_t id) = 0;
91
92 virtual void GetExportedResources(std::list<ExportedResource>& target /*out*/,
93 bool& done /*out*/,
94 int64_t since,
95 unsigned int maxResults) = 0;
96
97 virtual void GetLastChange(std::list<ServerIndexChange>& target /*out*/) = 0;
98
99 virtual void GetLastExportedResource(std::list<ExportedResource>& target /*out*/) = 0;
100
101 virtual void GetMainDicomTags(DicomMap& map,
102 int64_t id) = 0;
103
104 virtual std::string GetPublicId(int64_t resourceId) = 0;
105
106 virtual uint64_t GetResourceCount(ResourceType resourceType) = 0;
107
108 virtual ResourceType GetResourceType(int64_t resourceId) = 0;
109
110 virtual uint64_t GetTotalCompressedSize() = 0;
111
112 virtual uint64_t GetTotalUncompressedSize() = 0;
113
114 virtual bool IsExistingResource(int64_t internalId) = 0;
115
116 virtual bool IsProtectedPatient(int64_t internalId) = 0;
117
118 virtual void ListAvailableMetadata(std::list<MetadataType>& target,
119 int64_t id) = 0;
120
121 virtual void ListAvailableAttachments(std::list<FileContentType>& result,
122 int64_t id) = 0;
123
124 virtual void LogChange(int64_t internalId,
125 const ServerIndexChange& change) = 0;
126
127 virtual void LogExportedResource(const ExportedResource& resource) = 0;
128
129 virtual bool LookupAttachment(FileInfo& attachment,
130 int64_t id,
131 FileContentType contentType) = 0;
132
133 virtual bool LookupGlobalProperty(std::string& target,
134 GlobalProperty property) = 0;
135
136 virtual void LookupIdentifier(std::list<int64_t>& result,
137 const DicomTag& tag,
138 const std::string& value) = 0;
139
140 virtual void LookupIdentifier(std::list<int64_t>& result,
141 const std::string& value) = 0;
142
143 virtual bool LookupMetadata(std::string& target,
144 int64_t id,
145 MetadataType type) = 0;
146
147 virtual bool LookupParent(int64_t& parentId,
148 int64_t resourceId) = 0;
149
150 virtual bool LookupResource(const std::string& publicId,
151 int64_t& id,
152 ResourceType& type) = 0;
153
154 virtual bool SelectPatientToRecycle(int64_t& internalId) = 0;
155
156 virtual bool SelectPatientToRecycle(int64_t& internalId,
157 int64_t patientIdToAvoid) = 0;
158
159 virtual void SetGlobalProperty(GlobalProperty property,
160 const std::string& value) = 0;
161
162 virtual void SetMainDicomTags(int64_t id,
163 const DicomMap& tags) = 0;
164
165 virtual void SetMetadata(int64_t id,
166 MetadataType type,
167 const std::string& value) = 0;
168
169 virtual void SetProtectedPatient(int64_t internalId,
170 bool isProtected) = 0;
171
172 virtual SQLite::ITransaction* StartTransaction() = 0;
173
174 virtual void SetListener(IServerIndexListener& listener) = 0;
175 };
176 }