diff OrthancServer/Sources/Database/FindRequest.cpp @ 5554:12d8a1a266e9 find-refactoring

introduction of FindRequest and FindResponse
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 15 Apr 2024 16:13:24 +0200
parents
children def06a42e5ef
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/OrthancServer/Sources/Database/FindRequest.cpp	Mon Apr 15 16:13:24 2024 +0200
@@ -0,0 +1,243 @@
+/**
+ * Orthanc - A Lightweight, RESTful DICOM Store
+ * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
+ * Department, University Hospital of Liege, Belgium
+ * Copyright (C) 2017-2024 Osimis S.A., Belgium
+ * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
+ *
+ * This program is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ **/
+
+
+#include "FindRequest.h"
+
+#include "../../../OrthancFramework/Sources/OrthancException.h"
+
+
+#include <cassert>
+
+namespace Orthanc
+{
+  bool FindRequest::IsCompatibleLevel(ResourceType levelOfInterest) const
+  {
+    switch (level_)
+    {
+      case ResourceType_Patient:
+        return (levelOfInterest == ResourceType_Patient);
+
+      case ResourceType_Study:
+        return (levelOfInterest == ResourceType_Patient ||
+                levelOfInterest == ResourceType_Study);
+
+      case ResourceType_Series:
+        return (levelOfInterest == ResourceType_Patient ||
+                levelOfInterest == ResourceType_Study ||
+                levelOfInterest == ResourceType_Series);
+
+      case ResourceType_Instance:
+        return (levelOfInterest == ResourceType_Patient ||
+                levelOfInterest == ResourceType_Study ||
+                levelOfInterest == ResourceType_Series ||
+                levelOfInterest == ResourceType_Instance);
+
+      default:
+        throw OrthancException(ErrorCode_ParameterOutOfRange);
+    }
+  }
+
+
+  FindRequest::FindRequest(ResourceType level) :
+    level_(level),
+    responseType_(ResponseType_OrthancIdentifiers),
+    hasLimits_(false),
+    limitsSince_(0),
+    limitsCount_(0),
+    metadataMode_(MetadataMode_None),
+    retrievePatientTags_(false),
+    retrieveStudyTags_(false),
+    retrieveSeriesTags_(false),
+    retrieveInstanceTags_(false)
+  {
+  }
+
+
+  FindRequest::~FindRequest()
+  {
+    for (std::deque<TagConstraint*>::iterator it = tagConstraints_.begin(); it != tagConstraints_.end(); ++it)
+    {
+      assert(*it != NULL);
+      delete *it;
+    }
+  }
+
+
+  void FindRequest::AddTagConstraint(TagConstraint* constraint /* takes ownership */)
+  {
+    if (constraint == NULL)
+    {
+      throw OrthancException(ErrorCode_NullPointer);
+    }
+    else
+    {
+      tagConstraints_.push_back(constraint);
+    }
+  }
+
+
+  const FindRequest::TagConstraint& FindRequest::GetTagConstraint(size_t index) const
+  {
+    if (index >= tagConstraints_.size())
+    {
+      throw OrthancException(ErrorCode_ParameterOutOfRange);
+    }
+    else
+    {
+      assert(tagConstraints_[index] != NULL);
+      return *tagConstraints_[index];
+    }
+  }
+
+
+  void FindRequest::SetLimits(uint64_t since,
+                              uint64_t count)
+  {
+    if (hasLimits_)
+    {
+      throw OrthancException(ErrorCode_BadSequenceOfCalls);
+    }
+    else
+    {
+      hasLimits_ = true;
+      limitsSince_ = since;
+      limitsCount_ = count;
+    }
+  }
+
+
+  uint64_t FindRequest::GetLimitsSince() const
+  {
+    if (hasLimits_)
+    {
+      return limitsSince_;
+    }
+    else
+    {
+      throw OrthancException(ErrorCode_BadSequenceOfCalls);
+    }
+  }
+
+
+  uint64_t FindRequest::GetLimitsCount() const
+  {
+    if (hasLimits_)
+    {
+      return limitsCount_;
+    }
+    else
+    {
+      throw OrthancException(ErrorCode_BadSequenceOfCalls);
+    }
+  }
+
+
+  void FindRequest::SetRetrieveTagsAtLevel(ResourceType levelOfInterest,
+                                           bool retrieve)
+  {
+    if (!IsCompatibleLevel(levelOfInterest))
+    {
+      throw OrthancException(ErrorCode_ParameterOutOfRange);
+    }
+
+    switch (levelOfInterest)
+    {
+      case ResourceType_Patient:
+        retrievePatientTags_ = true;
+        break;
+
+      case ResourceType_Study:
+        retrieveStudyTags_ = true;
+        break;
+
+      case ResourceType_Series:
+        retrieveSeriesTags_ = true;
+        break;
+
+      case ResourceType_Instance:
+        retrieveInstanceTags_ = true;
+        break;
+
+      default:
+        throw OrthancException(ErrorCode_ParameterOutOfRange);
+    }
+  }
+
+
+  bool FindRequest::IsRetrieveTagsAtLevel(ResourceType levelOfInterest) const
+  {
+    switch (levelOfInterest)
+    {
+      case ResourceType_Patient:
+        return retrievePatientTags_;
+
+      case ResourceType_Study:
+        return retrieveStudyTags_;
+
+      case ResourceType_Series:
+        return retrieveSeriesTags_;
+
+      case ResourceType_Instance:
+        return retrieveInstanceTags_;
+
+      default:
+        throw OrthancException(ErrorCode_ParameterOutOfRange);
+    }
+  }
+
+
+  void FindRequest::SetTagOrdering(DicomTag tag,
+                                   Ordering ordering)
+  {
+    switch (ordering)
+    {
+      case Ordering_None:
+        tagOrdering_.erase(tag);
+        break;
+
+      case Ordering_Ascending:
+        tagOrdering_[tag] = Ordering_Ascending;
+        break;
+
+      case Ordering_Descending:
+        tagOrdering_[tag] = Ordering_Descending;
+        break;
+
+      default:
+        throw OrthancException(ErrorCode_ParameterOutOfRange);
+    }
+  }
+
+
+  void FindRequest::AddMetadataConstraint(MetadataType metadata,
+                                          const std::string& value)
+  {
+    if (metadataConstraints_.find(metadata) == metadataConstraints_.end())
+    {
+      metadataConstraints_[metadata] = value;
+    }
+    else
+    {
+      throw OrthancException(ErrorCode_BadSequenceOfCalls);
+    }
+  }
+}