comparison OrthancServer/Resources/Graveyard/DatabaseOptimizations/LookupIdentifierQuery.h @ 4044:d25f4c0fa160 framework

splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Resources/Graveyard/DatabaseOptimizations/LookupIdentifierQuery.h@94f4a18a79cc
children d9473bd5ed43
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #include "../IDatabaseWrapper.h"
37
38 #include "SetOfResources.h"
39
40 #include <vector>
41 #include <boost/noncopyable.hpp>
42
43 namespace Orthanc
44 {
45 /**
46 * Primitive for wildcard matching, as defined in DICOM:
47 * http://dicom.nema.org/dicom/2013/output/chtml/part04/sect_C.2.html#sect_C.2.2.2.4
48 *
49 * "Any occurrence of an "*" or a "?", then "*" shall match any
50 * sequence of characters (including a zero length value) and "?"
51 * shall match any single character. This matching is case
52 * sensitive, except for Attributes with an PN Value
53 * Representation (e.g., Patient Name (0010,0010))."
54 *
55 * Pay attention to the fact that "*" (resp. "?") generally
56 * corresponds to "%" (resp. "_") in primitive LIKE of SQL. The
57 * values "%", "_", "\" should in the user request should
58 * respectively be escaped as "\%", "\_" and "\\".
59 *
60 * This matching must be case sensitive: The special case of PN VR
61 * is taken into consideration by normalizing the query string in
62 * method "NormalizeIdentifier()".
63 **/
64
65 class LookupIdentifierQuery : public boost::noncopyable
66 {
67 // This class encodes a conjunction ("AND") of disjunctions. Each
68 // disjunction represents an "OR" of several constraints.
69
70 public:
71 class SingleConstraint
72 {
73 private:
74 DicomTag tag_;
75 IdentifierConstraintType type_;
76 std::string value_;
77
78 public:
79 SingleConstraint(const DicomTag& tag,
80 IdentifierConstraintType type,
81 const std::string& value);
82
83 const DicomTag& GetTag() const
84 {
85 return tag_;
86 }
87
88 IdentifierConstraintType GetType() const
89 {
90 return type_;
91 }
92
93 const std::string& GetValue() const
94 {
95 return value_;
96 }
97 };
98
99
100 class RangeConstraint
101 {
102 private:
103 DicomTag tag_;
104 std::string start_;
105 std::string end_;
106
107 public:
108 RangeConstraint(const DicomTag& tag,
109 const std::string& start,
110 const std::string& end);
111
112 const DicomTag& GetTag() const
113 {
114 return tag_;
115 }
116
117 const std::string& GetStart() const
118 {
119 return start_;
120 }
121
122 const std::string& GetEnd() const
123 {
124 return end_;
125 }
126 };
127
128
129 class Disjunction : public boost::noncopyable
130 {
131 private:
132 std::vector<SingleConstraint*> singleConstraints_;
133 std::vector<RangeConstraint*> rangeConstraints_;
134
135 public:
136 ~Disjunction();
137
138 void Add(const DicomTag& tag,
139 IdentifierConstraintType type,
140 const std::string& value);
141
142 void AddRange(const DicomTag& tag,
143 const std::string& start,
144 const std::string& end);
145
146 size_t GetSingleConstraintsCount() const
147 {
148 return singleConstraints_.size();
149 }
150
151 const SingleConstraint& GetSingleConstraint(size_t i) const
152 {
153 return *singleConstraints_[i];
154 }
155
156 size_t GetRangeConstraintsCount() const
157 {
158 return rangeConstraints_.size();
159 }
160
161 const RangeConstraint& GetRangeConstraint(size_t i) const
162 {
163 return *rangeConstraints_[i];
164 }
165 };
166
167
168 private:
169 typedef std::vector<Disjunction*> Disjunctions;
170
171 ResourceType level_;
172 Disjunctions disjunctions_;
173
174 public:
175 LookupIdentifierQuery(ResourceType level) : level_(level)
176 {
177 }
178
179 ~LookupIdentifierQuery();
180
181 bool IsIdentifier(const DicomTag& tag);
182
183 void AddConstraint(DicomTag tag,
184 IdentifierConstraintType type,
185 const std::string& value);
186
187 void AddRange(DicomTag tag,
188 const std::string& start,
189 const std::string& end);
190
191 Disjunction& AddDisjunction();
192
193 ResourceType GetLevel() const
194 {
195 return level_;
196 }
197
198 // The database must be locked
199 void Apply(std::list<std::string>& result,
200 IDatabaseWrapper& database);
201
202 void Apply(SetOfResources& result,
203 IDatabaseWrapper& database);
204
205 void Print(std::ostream& s) const;
206 };
207 }