annotate OrthancServer/Search/LookupResource.h @ 3021:2cbafb5d5a62

renamed LookupResource::IVisitor as ServerContext::ILookupVisitor
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sat, 15 Dec 2018 16:29:50 +0100
parents af1530b45290
children 4e43e67f8ecf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1758
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
2447
878b59270859 upgrade to year 2018
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
1755
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
36 #include "ListConstraint.h"
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #include "SetOfResources.h"
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <memory>
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 namespace Orthanc
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 class LookupResource : public boost::noncopyable
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 private:
1756
03b030680e3d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1755
diff changeset
46 typedef std::map<DicomTag, IFindConstraint*> Constraints;
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 class Level
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 {
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 private:
1750
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
51 ResourceType level_;
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 std::set<DicomTag> identifiers_;
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 std::set<DicomTag> mainTags_;
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 Constraints identifiersConstraints_;
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 Constraints mainTagsConstraints_;
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 public:
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 Level(ResourceType level);
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 ~Level();
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61
1756
03b030680e3d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1755
diff changeset
62 bool Add(const DicomTag& tag,
03b030680e3d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1755
diff changeset
63 std::auto_ptr<IFindConstraint>& constraint);
1750
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
64
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
65 void Apply(SetOfResources& candidates,
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
66 IDatabaseWrapper& database) const;
3012
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
67
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
68 bool IsMatch(const DicomMap& dicom) const;
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 };
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71 typedef std::map<ResourceType, Level*> Levels;
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72
1755
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
73 ResourceType level_;
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
74 Levels levels_;
3005
8265a6b56100 DicomMap::FromDicomAsJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3003
diff changeset
75 Constraints unoptimizedConstraints_; // Constraints on non-main DICOM tags
1755
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
76 std::auto_ptr<ListConstraint> modalitiesInStudy_;
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 bool AddInternal(ResourceType level,
1756
03b030680e3d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1755
diff changeset
79 const DicomTag& tag,
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 std::auto_ptr<IFindConstraint>& constraint);
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81
1750
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
82 void ApplyLevel(SetOfResources& candidates,
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
83 ResourceType level,
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
84 IDatabaseWrapper& database) const;
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
85
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 public:
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 LookupResource(ResourceType level);
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89 ~LookupResource();
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
1753
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1751
diff changeset
91 ResourceType GetLevel() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1751
diff changeset
92 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1751
diff changeset
93 return level_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1751
diff changeset
94 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1751
diff changeset
95
1755
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
96 void SetModalitiesInStudy(const std::string& modalities);
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
97
1756
03b030680e3d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1755
diff changeset
98 void Add(const DicomTag& tag,
03b030680e3d refactoring
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1755
diff changeset
99 IFindConstraint* constraint); // Takes ownership
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
100
1755
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
101 void AddDicomConstraint(const DicomTag& tag,
39c37a994b2f handling of DICOM_TAG_MODALITIES_IN_STUDY
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1753
diff changeset
102 const std::string& dicomQuery,
1758
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1756
diff changeset
103 bool caseSensitive);
1751
fb569ee09a69 LookupResource complete
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1750
diff changeset
104
1753
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1751
diff changeset
105 void FindCandidates(std::list<int64_t>& result,
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1751
diff changeset
106 IDatabaseWrapper& database) const;
1750
55d52567bebb LookupResource implemented
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1749
diff changeset
107
3012
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
108 bool HasOnlyMainDicomTags() const
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
109 {
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
110 return unoptimizedConstraints_.empty();
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
111 }
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
112
af1530b45290 Optimization: On finds, do not read JSON (disk) if main DICOM tags (DB) are sufficient
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3005
diff changeset
113 bool IsMatch(const DicomMap& dicom) const;
1749
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 };
99f4a05f39fa various types of constraints
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 }