annotate OrthancServer/ResourceFinder.h @ 1361:94ffb597d297

refactoring of C-Find SCP
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 15 May 2015 17:19:33 +0200
parents 0649c5aef34a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * This program is free software: you can redistribute it and/or
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * modify it under the terms of the GNU General Public License as
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * published by the Free Software Foundation, either version 3 of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * License, or (at your option) any later version.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * In addition, as a special exception, the copyright holders of this
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * program give permission to link the code of its release with the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * that use the same license as the "OpenSSL" library), and distribute
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * the linked executables. You must obey the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * in all respects for all of the code used other than "OpenSSL". If you
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * modify file(s) with this exception, you may extend this exception to
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * your version of the file(s), but you are not obligated to do so. If
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * you do not wish to do so, delete this exception statement from your
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * version. If you delete this exception statement from all source files
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * in the program, then also delete it here.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * This program is distributed in the hope that it will be useful, but
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * WITHOUT ANY WARRANTY; without even the implied warranty of
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * General Public License for more details.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * You should have received a copy of the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 **/
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #pragma once
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
35 #include "ServerIndex.h"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
36
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
37 #include <boost/noncopyable.hpp>
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 namespace Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
41 class ResourceFinder : public boost::noncopyable
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
43 public:
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
44 class IQuery : public boost::noncopyable
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
45 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
46 public:
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
47 virtual ~IQuery()
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
48 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
49 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
50
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
51 virtual ResourceType GetLevel() const = 0;
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
52
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
53 virtual bool RestrictIdentifier(std::string& value,
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
54 DicomTag identifier) const = 0;
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
55
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
56 virtual bool HasMainDicomTagsFilter(ResourceType level) const = 0;
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
57
1361
94ffb597d297 refactoring of C-Find SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1360
diff changeset
58 virtual bool FilterMainDicomTags(const std::string& resourceId,
94ffb597d297 refactoring of C-Find SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1360
diff changeset
59 ResourceType level,
94ffb597d297 refactoring of C-Find SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1360
diff changeset
60 const DicomMap& mainTags) const = 0;
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
61
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
62 virtual bool HasInstanceFilter() const = 0;
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
63
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
64 virtual bool FilterInstance(const std::string& instanceId,
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
65 const Json::Value& content) const = 0;
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
66 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
67
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
68
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 private:
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
70 typedef std::map<DicomTag, std::string> Identifiers;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
71
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
72 class CandidateResources;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
73
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
74 ServerContext& context_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
75 size_t maxResults_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
76
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
77 void ApplyAtLevel(CandidateResources& candidates,
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
78 const IQuery& query,
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
79 ResourceType level);
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 public:
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
82 ResourceFinder(ServerContext& context);
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 void SetMaxResults(size_t value)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 {
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
86 maxResults_ = value;
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 size_t GetMaxResults() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 {
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
91 return maxResults_;
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93
1359
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
94 // Returns "true" iff. all the matching resources have been
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
95 // returned. Will be "false" if the results were truncated by
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1358
diff changeset
96 // "SetMaxResults()".
1360
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
97 bool Apply(std::list<std::string>& result,
0649c5aef34a DicomFindQuery
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1359
diff changeset
98 const IQuery& query);
1358
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 }