Mercurial > hg > orthanc

annotate OrthancServer/Sources/Database/FindResponse.h @ 5595:a87f2a56257d find-refactoring

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
implemented FindRequest::retrieveChildrenMetadata_
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 May 2024 12:53:12 +0200
parents a906dc19264c
children 81a29ad7fb4b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 * Copyright (C) 2017-2024 Osimis S.A., Belgium
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * License, or (at your option) any later version.
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * General Public License for more details.
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * You should have received a copy of the GNU General Public License
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #include "../../../OrthancFramework/Sources/DicomFormat/DicomMap.h"
5574
5a13483d12c5 find-refactoring: attachments
Alain Mazy <am@orthanc.team>
parents: 5568
diff changeset
26 #include "../../../OrthancFramework/Sources/Enumerations.h"
5a13483d12c5 find-refactoring: attachments
Alain Mazy <am@orthanc.team>
parents: 5568
diff changeset
27 #include "../../../OrthancFramework/Sources/FileStorage/FileInfo.h"
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include "../ServerEnumerations.h"
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 #include "OrthancIdentifiers.h"
5565
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
30 #include "FindRequest.h"
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 #include <boost/noncopyable.hpp>
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33 #include <deque>
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #include <map>
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include <set>
5565
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
36 #include <list>
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 namespace Orthanc
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 class FindResponse : public boost::noncopyable
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
43 private:
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
44 class ChildrenAtLevel : public boost::noncopyable
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
45 {
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
46 private:
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
47 std::set<std::string> identifiers_;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
48
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
49 public:
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
50 void AddIdentifier(const std::string& identifier);
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
51
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
52 const std::set<std::string>& GetIdentifiers() const
5565
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
53 {
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
54 return identifiers_;
5565
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
55 }
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
56 };
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
57
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
58
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
59 public:
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
60 class Resource : public boost::noncopyable
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 {
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 private:
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
63 class DicomValue;
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
64
5595
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
65 typedef std::map<DicomTag, DicomValue*> MainDicomTags;
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
66 typedef std::map<MetadataType, std::list<std::string>*> ChildrenMetadata;
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
67
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
68 ResourceType level_;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
69 std::string identifier_;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
70 std::unique_ptr<std::string> parentIdentifier_;
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
71 MainDicomTags mainDicomTags_;
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
72 ChildrenAtLevel childrenStudies_;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
73 ChildrenAtLevel childrenSeries_;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
74 ChildrenAtLevel childrenInstances_;
5568
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
75 std::set<std::string> labels_;
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
76 std::map<MetadataType, std::string> metadata_;
5574
5a13483d12c5 find-refactoring: attachments
Alain Mazy <am@orthanc.team>
parents: 5568
diff changeset
77 std::map<FileContentType, FileInfo> attachments_;
5595
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
78 ChildrenMetadata childrenMetadata_;
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
80 ChildrenAtLevel& GetChildrenAtLevel(ResourceType level);
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
81
5594
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
82 const ChildrenAtLevel& GetChildrenAtLevel(ResourceType level) const
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
83 {
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
84 return const_cast<Resource&>(*this).GetChildrenAtLevel(level);
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
85 }
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
86
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 public:
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
88 Resource(ResourceType level,
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
89 const std::string& identifier) :
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
90 level_(level),
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
91 identifier_(identifier)
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 {
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 }
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
95 ~Resource();
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
96
5588
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
97 ResourceType GetLevel() const
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
98 {
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
99 return level_;
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
100 }
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
101
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
102 const std::string& GetIdentifier() const
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
103 {
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
104 return identifier_;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
105 }
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
107 const std::string& GetParentIdentifier() const;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
108
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
109 void SetParentIdentifier(const std::string& id);
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
110
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
111 bool HasParentIdentifier() const;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
112
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
113 void AddStringDicomTag(uint16_t group,
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
114 uint16_t element,
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
115 const std::string& value);
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
117 // The "Null" value could be used in the future to indicate a
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
118 // value that is not available, typically a new "ExtraMainDicomTag"
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
119 void AddNullDicomTag(uint16_t group,
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
120 uint16_t element);
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
121
5592
1e2631b8b9af GenericFind::Execute() is working for a basic request
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5589
diff changeset
122 void GetMainDicomTags(DicomMap& target) const;
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
123
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
124 void AddChildIdentifier(ResourceType level,
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
125 const std::string& childId)
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
126 {
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
127 GetChildrenAtLevel(level).AddIdentifier(childId);
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
128 }
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
129
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
130 const std::set<std::string>& GetChildrenIdentifiers(ResourceType level) const
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
131 {
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
132 return const_cast<Resource&>(*this).GetChildrenAtLevel(level).GetIdentifiers();
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
133 }
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
134
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
135 void AddLabel(const std::string& label);
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
136
5594
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
137 std::set<std::string>& GetLabels()
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
138 {
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
139 return labels_;
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
140 }
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
141
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
142 const std::set<std::string>& GetLabels() const
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
143 {
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
144 return labels_;
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
145 }
5568
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
146
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
147 void AddMetadata(MetadataType metadata,
5568
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
148 const std::string& value);
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
149
5594
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
150 std::map<MetadataType, std::string>& GetMetadata()
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
151 {
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
152 return metadata_;
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
153 }
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
154
5568
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
155 const std::map<MetadataType, std::string>& GetMetadata() const
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
156 {
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
157 return metadata_;
b0b5546f1b9f find refactor: re-use existing code. /studies?expand is almost fully implemented with new code
Alain Mazy <am@orthanc.team>
parents: 5565
diff changeset
158 }
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
159
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
160 bool HasMetadata(MetadataType metadata) const
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
161 {
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
162 return metadata_.find(metadata) != metadata_.end();
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
163 }
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
164
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
165 bool LookupMetadata(std::string& value,
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
166 MetadataType metadata) const;
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
167
5565
def06a42e5ef Updated FindRequest & FindResponse definitions
Alain Mazy <am@orthanc.team>
parents: 5554
diff changeset
168 void ListMetadata(std::set<MetadataType>& metadata) const;
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
169
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
170 void AddAttachment(const FileInfo& attachment);
5574
5a13483d12c5 find-refactoring: attachments
Alain Mazy <am@orthanc.team>
parents: 5568
diff changeset
171
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
172 bool LookupAttachment(FileInfo& target,
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
173 FileContentType type) const;
5594
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
174
5595
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
175 void AddChildrenMetadata(MetadataType metadata,
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
176 const std::list<std::string>& values);
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
177
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
178 bool LookupChildrenMetadata(std::list<std::string>& values,
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
179 MetadataType metadata) const;
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
180
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
181 SeriesStatus GetSeriesStatus(uint32_t& expecterNumberOfInstances) const;
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
182
a87f2a56257d implemented FindRequest::retrieveChildrenMetadata_
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5594
diff changeset
183 void Expand(Json::Value& target,
5594
a906dc19264c created FindResponse::Resource::Format()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5592
diff changeset
184 const FindRequest& request) const;
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
185 };
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
186
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
187 private:
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
188 typedef std::map<std::string, Resource*> Index;
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
189
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
190 std::deque<Resource*> items_;
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
191 Index index_;
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
192
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
193 public:
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
194 ~FindResponse();
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
195
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
196 void Add(Resource* item /* takes ownership */);
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
197
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
198 size_t GetSize() const
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
199 {
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
200 return items_.size();
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
201 }
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
202
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
203 const Resource& GetResource(size_t index) const;
5586
fc3914c07dd3 refactoring FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5583
diff changeset
204
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
205 Resource& GetResource(const std::string& id);
5588
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
206
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
207 const Resource& GetResource(const std::string& id) const
5588
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
208 {
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
209 return const_cast<FindResponse&>(*this).GetResource(id);
5588
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
210 }
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
211
5589
b51ee994cd6f renamed FindResponse::Item as FindResponse::Resource
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5588
diff changeset
212 bool HasResource(const std::string& id) const
5588
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
213 {
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
214 return (index_.find(id) != index_.end());
1b0fc6685f57 add index of resources into FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5587
diff changeset
215 }
5554
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
216 };
12d8a1a266e9 introduction of FindRequest and FindResponse
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
217 }