annotate Resources/Orthanc/Databases/DatabaseConstraint.h @ 285:f2e160b2dc3e

use openssl-3.x branch while syncing
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 22 Jun 2021 07:47:35 +0200
parents 3236894320d6
children 1280b40d6696
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
152
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-2016 Sebastien Jodogne, Medical Physics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
193
3236894320d6 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 170
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * General Public License for more details.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #pragma once
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #if !defined(ORTHANC_BUILDING_SERVER_LIBRARY)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 # error Macro ORTHANC_BUILDING_SERVER_LIBRARY must be defined
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #if ORTHANC_BUILDING_SERVER_LIBRARY == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 # include "../../../OrthancFramework/Sources/DicomFormat/DicomMap.h"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 #else
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 // This is for the "orthanc-databases" project to reuse this file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 # include <DicomFormat/DicomMap.h>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #define ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT 0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 #if ORTHANC_ENABLE_PLUGINS == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 # include <orthanc/OrthancCDatabasePlugin.h>
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 # if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in 1.3.1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 5, 2)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 # undef ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 # define ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 # endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 # endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 namespace Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49 enum ConstraintType
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51 ConstraintType_Equal,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
52 ConstraintType_SmallerOrEqual,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 ConstraintType_GreaterOrEqual,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 ConstraintType_Wildcard,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 ConstraintType_List
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 namespace Plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 #if ORTHANC_ENABLE_PLUGINS == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 OrthancPluginResourceType Convert(ResourceType type);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 #if ORTHANC_ENABLE_PLUGINS == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 ResourceType Convert(OrthancPluginResourceType type);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
68 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 OrthancPluginConstraintType Convert(ConstraintType constraint);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
71
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
72 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
73 ConstraintType Convert(OrthancPluginConstraintType constraint);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 // This class is also used by the "orthanc-databases" project
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 class DatabaseConstraint
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 private:
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 ResourceType level_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 DicomTag tag_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 bool isIdentifier_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 ConstraintType constraintType_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 std::vector<std::string> values_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 bool caseSensitive_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 bool mandatory_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90 public:
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
91 DatabaseConstraint(ResourceType level,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 const DicomTag& tag,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 bool isIdentifier,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 ConstraintType type,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 const std::vector<std::string>& values,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 bool caseSensitive,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 bool mandatory);
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
170
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 152
diff changeset
100 explicit DatabaseConstraint(const OrthancPluginDatabaseConstraint& constraint);
152
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
101 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 ResourceType GetLevel() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 return level_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 const DicomTag& GetTag() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110 return tag_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
112
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 bool IsIdentifier() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 return isIdentifier_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 ConstraintType GetConstraintType() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
120 return constraintType_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
121 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
123 size_t GetValuesCount() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
124 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
125 return values_.size();
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
126 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 const std::string& GetValue(size_t index) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
129
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
130 const std::string& GetSingleValue() const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
131
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
132 bool IsCaseSensitive() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134 return caseSensitive_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 bool IsMandatory() const
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
138 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
139 return mandatory_;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
140 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
141
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
142 bool IsMatch(const DicomMap& dicom) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
143
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
144 #if ORTHANC_PLUGINS_HAS_DATABASE_CONSTRAINT == 1
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
145 void EncodeForPlugins(OrthancPluginDatabaseConstraint& constraint,
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
146 std::vector<const char*>& tmpValues) const;
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 #endif
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
148 };
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
149 }