Mercurial > hg > orthanc
annotate OrthancServer/IDatabaseWrapper.h @ 1729:54d78925cbb6 db-changes
notes
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Tue, 20 Oct 2015 17:39:58 +0200 |
| parents | 4941494b5dd8 |
| children | 38dda23c7d7d |
| 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 | |
|
1672
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
54 virtual void Open() = 0; |
|
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
55 |
|
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
56 virtual void Close() = 0; |
|
4c5a85c3ff43
sample database plugin now working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1668
diff
changeset
|
57 |
| 1247 | 58 virtual void AddAttachment(int64_t id, |
| 59 const FileInfo& attachment) = 0; | |
| 60 | |
| 61 virtual void AttachChild(int64_t parent, | |
| 62 int64_t child) = 0; | |
| 63 | |
| 1286 | 64 virtual void ClearChanges() = 0; |
| 65 | |
| 66 virtual void ClearExportedResources() = 0; | |
| 1247 | 67 |
| 68 virtual int64_t CreateResource(const std::string& publicId, | |
| 69 ResourceType type) = 0; | |
| 70 | |
| 71 virtual void DeleteAttachment(int64_t id, | |
| 72 FileContentType attachment) = 0; | |
| 73 | |
| 74 virtual void DeleteMetadata(int64_t id, | |
| 75 MetadataType type) = 0; | |
| 76 | |
| 77 virtual void DeleteResource(int64_t id) = 0; | |
| 78 | |
| 79 virtual void FlushToDisk() = 0; | |
| 80 | |
|
1306
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
81 virtual bool HasFlushToDisk() const = 0; |
|
8cd5784a6d80
IDatabaseWrapper::HasFlushToDisk()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1302
diff
changeset
|
82 |
| 1301 | 83 virtual void GetAllMetadata(std::map<MetadataType, std::string>& target, |
| 1247 | 84 int64_t id) = 0; |
| 85 | |
| 86 virtual void GetAllPublicIds(std::list<std::string>& target, | |
| 87 ResourceType resourceType) = 0; | |
| 88 | |
|
1509
0586ed8897f1
limit and since arguments while retrieving DICOM resources in the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1432
diff
changeset
|
89 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
|
90 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
|
91 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
|
92 size_t limit) = 0; |
| 1247 | 93 |
| 94 virtual void GetChanges(std::list<ServerIndexChange>& target /*out*/, | |
| 95 bool& done /*out*/, | |
| 96 int64_t since, | |
| 1302 | 97 uint32_t maxResults) = 0; |
| 1247 | 98 |
| 1301 | 99 virtual void GetChildrenInternalId(std::list<int64_t>& target, |
| 1247 | 100 int64_t id) = 0; |
| 101 | |
| 1301 | 102 virtual void GetChildrenPublicId(std::list<std::string>& target, |
| 1247 | 103 int64_t id) = 0; |
| 104 | |
| 105 virtual void GetExportedResources(std::list<ExportedResource>& target /*out*/, | |
| 106 bool& done /*out*/, | |
| 107 int64_t since, | |
| 1302 | 108 uint32_t maxResults) = 0; |
| 1247 | 109 |
| 110 virtual void GetLastChange(std::list<ServerIndexChange>& target /*out*/) = 0; | |
| 111 | |
| 112 virtual void GetLastExportedResource(std::list<ExportedResource>& target /*out*/) = 0; | |
| 113 | |
| 114 virtual void GetMainDicomTags(DicomMap& map, | |
| 115 int64_t id) = 0; | |
| 116 | |
| 117 virtual std::string GetPublicId(int64_t resourceId) = 0; | |
| 118 | |
| 119 virtual uint64_t GetResourceCount(ResourceType resourceType) = 0; | |
| 120 | |
| 121 virtual ResourceType GetResourceType(int64_t resourceId) = 0; | |
| 122 | |
| 123 virtual uint64_t GetTotalCompressedSize() = 0; | |
| 124 | |
| 125 virtual uint64_t GetTotalUncompressedSize() = 0; | |
| 126 | |
| 127 virtual bool IsExistingResource(int64_t internalId) = 0; | |
| 128 | |
| 129 virtual bool IsProtectedPatient(int64_t internalId) = 0; | |
| 130 | |
| 131 virtual void ListAvailableMetadata(std::list<MetadataType>& target, | |
| 132 int64_t id) = 0; | |
| 133 | |
| 1301 | 134 virtual void ListAvailableAttachments(std::list<FileContentType>& target, |
| 1247 | 135 int64_t id) = 0; |
| 136 | |
| 137 virtual void LogChange(int64_t internalId, | |
| 138 const ServerIndexChange& change) = 0; | |
| 139 | |
| 140 virtual void LogExportedResource(const ExportedResource& resource) = 0; | |
| 141 | |
| 142 virtual bool LookupAttachment(FileInfo& attachment, | |
| 143 int64_t id, | |
| 144 FileContentType contentType) = 0; | |
| 145 | |
| 146 virtual bool LookupGlobalProperty(std::string& target, | |
| 147 GlobalProperty property) = 0; | |
| 148 | |
|
1728
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
149 virtual void LookupIdentifierExact(std::list<int64_t>& target, |
|
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
150 ResourceType level, |
|
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
151 const DicomTag& tag, |
|
4941494b5dd8
rename LookupIdentifier as LookupIdentifierExact
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1727
diff
changeset
|
152 const std::string& value) = 0; |
| 1247 | 153 |
| 1729 | 154 /** |
| 155 * Primitive for wildcard matching, as defined in DICOM: | |
| 156 * http://dicom.nema.org/dicom/2013/output/chtml/part04/sect_C.2.html#sect_C.2.2.2.4 | |
| 157 * | |
| 158 * "Any occurrence of an "*" or a "?", then "*" shall match any | |
| 159 * sequence of characters (including a zero length value) and "?" | |
| 160 * shall match any single character. This matching is case | |
| 161 * sensitive, except for Attributes with an PN Value | |
| 162 * Representation (e.g., Patient Name (0010,0010))." | |
| 163 * | |
| 164 * Pay attention to the fact that "*" (resp. "?") generally | |
| 165 * corresponds to "%" (resp. "_") in primitive LIKE of SQL. The | |
| 166 * values "%", "_", "\" should in the user request should | |
| 167 * respectively be escaped as "\%", "\_" and "\\". | |
| 168 * | |
| 169 * This matching must be case sensitive: The special case of PN VR | |
| 170 * is taken into consideration by normalizing the query string in | |
| 171 * method "ServerIndex::LookupIdentifierWildcard()". | |
| 172 **/ | |
| 173 virtual void LookupIdentifierWildcard(std::list<int64_t>& target, | |
| 174 const DicomTag& tag, | |
| 175 const std::string& value) = 0; | |
| 176 | |
| 1247 | 177 virtual bool LookupMetadata(std::string& target, |
| 178 int64_t id, | |
| 179 MetadataType type) = 0; | |
| 180 | |
| 181 virtual bool LookupParent(int64_t& parentId, | |
| 182 int64_t resourceId) = 0; | |
| 183 | |
| 1294 | 184 virtual bool LookupResource(int64_t& id, |
| 185 ResourceType& type, | |
| 186 const std::string& publicId) = 0; | |
| 1247 | 187 |
| 188 virtual bool SelectPatientToRecycle(int64_t& internalId) = 0; | |
| 189 | |
| 190 virtual bool SelectPatientToRecycle(int64_t& internalId, | |
| 191 int64_t patientIdToAvoid) = 0; | |
| 192 | |
| 193 virtual void SetGlobalProperty(GlobalProperty property, | |
| 194 const std::string& value) = 0; | |
| 195 | |
|
1668
de1413733c97
reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
196 virtual void ClearMainDicomTags(int64_t id) = 0; |
|
de1413733c97
reconstructing main dicom tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
197 |
| 1286 | 198 virtual void SetMainDicomTag(int64_t id, |
| 199 const DicomTag& tag, | |
| 200 const std::string& value) = 0; | |
| 1247 | 201 |
| 1713 | 202 virtual void SetIdentifierTag(int64_t id, |
| 203 const DicomTag& tag, | |
| 204 const std::string& value) = 0; | |
| 205 | |
| 1247 | 206 virtual void SetMetadata(int64_t id, |
| 207 MetadataType type, | |
| 208 const std::string& value) = 0; | |
| 209 | |
| 210 virtual void SetProtectedPatient(int64_t internalId, | |
| 211 bool isProtected) = 0; | |
| 212 | |
| 213 virtual SQLite::ITransaction* StartTransaction() = 0; | |
| 214 | |
|
1432
0ac74fa21db8
rename IServerIndexListener as IDatabaseListener
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1306
diff
changeset
|
215 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
|
216 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
217 virtual unsigned int GetDatabaseVersion() = 0; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
218 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1509
diff
changeset
|
219 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
|
220 IStorageArea& storageArea) = 0; |
| 1247 | 221 }; |
| 222 } |