comparison OrthancServer/DatabaseWrapper.h @ 183:baada606da3c

databasewrapper
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 12 Nov 2012 14:52:30 +0100
parents
children 8e673a65564d
comparison
equal deleted inserted replaced
182:93ff5babcaf8 183:baada606da3c
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012 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/SQLite/Connection.h"
36 #include "../Core/DicomFormat/DicomInstanceHasher.h"
37 #include "IServerIndexListener.h"
38
39 #include <list>
40 #include <boost/date_time/posix_time/posix_time.hpp>
41
42 namespace Orthanc
43 {
44 namespace Internals
45 {
46 class SignalRemainingAncestor;
47 }
48
49 /**
50 * This class manages an instance of the Orthanc SQLite database. It
51 * translates low-level requests into SQL statements. Mutual
52 * exclusion MUST be implemented at a higher level.
53 **/
54 class DatabaseWrapper
55 {
56 private:
57 IServerIndexListener& listener_;
58 SQLite::Connection db_;
59 Internals::SignalRemainingAncestor* signalRemainingAncestor_;
60
61 void Open();
62
63 public:
64 void SetGlobalProperty(const std::string& name,
65 const std::string& value);
66
67 bool FindGlobalProperty(std::string& target,
68 const std::string& name);
69
70 std::string GetGlobalProperty(const std::string& name,
71 const std::string& defaultValue = "");
72
73 int64_t CreateResource(const std::string& publicId,
74 ResourceType type);
75
76 bool FindResource(const std::string& publicId,
77 int64_t& id,
78 ResourceType& type);
79
80 void AttachChild(int64_t parent,
81 int64_t child);
82
83 void DeleteResource(int64_t id);
84
85 void SetMetadata(int64_t id,
86 MetadataType type,
87 const std::string& value);
88
89 bool FindMetadata(std::string& target,
90 int64_t id,
91 MetadataType type);
92
93 std::string GetMetadata(int64_t id,
94 MetadataType type,
95 const std::string& defaultValue = "");
96
97 void AttachFile(int64_t id,
98 const std::string& name,
99 const std::string& fileUuid,
100 size_t compressedSize,
101 size_t uncompressedSize,
102 CompressionType compressionType);
103
104 void AttachFile(int64_t id,
105 const std::string& name,
106 const std::string& fileUuid,
107 size_t fileSize)
108 {
109 AttachFile(id, name, fileUuid, fileSize, fileSize, CompressionType_None);
110 }
111
112 bool FindFile(int64_t id,
113 const std::string& name,
114 std::string& fileUuid,
115 size_t& compressedSize,
116 size_t& uncompressedSize,
117 CompressionType& compressionType);
118
119 void SetMainDicomTags(int64_t id,
120 const DicomMap& tags);
121
122 void GetMainDicomTags(DicomMap& map,
123 int64_t id);
124
125 bool GetParentPublicId(std::string& result,
126 int64_t id);
127
128 void GetChildrenPublicId(std::list<std::string>& result,
129 int64_t id);
130
131 void LogChange(ChangeType changeType,
132 const std::string& publicId,
133 ResourceType resourceType,
134 const boost::posix_time::ptime& date);
135
136 void LogExportedInstance(const std::string& remoteModality,
137 DicomInstanceHasher& hasher,
138 const boost::posix_time::ptime& date);
139
140 int64_t GetTableRecordCount(const std::string& table);
141
142 uint64_t GetTotalCompressedSize();
143
144 uint64_t GetTotalUncompressedSize();
145
146 DatabaseWrapper(const std::string& path,
147 IServerIndexListener& listener);
148
149 DatabaseWrapper(IServerIndexListener& listener);
150 };
151 }