view OrthancServer/Sources/Database/FindRequest.cpp @ 5606:6e2dad336446 find-refactoring

added "IsStable" field in expanded resources
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 08 May 2024 10:46:11 +0200
parents 81a29ad7fb4b
children 4690a0d2b01e
line wrap: on
line source

/**
 * 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
{
  FindRequest::FindRequest(ResourceType level) :
    level_(level),
    hasLimits_(false),
    limitsSince_(0),
    limitsCount_(0),
    retrieveMainDicomTagsPatients_(false),
    retrieveMainDicomTagsStudies_(false),
    retrieveMainDicomTagsSeries_(false),
    retrieveMainDicomTagsInstances_(false),
    retrieveMetadataPatients_(false),
    retrieveMetadataStudies_(false),
    retrieveMetadataSeries_(false),
    retrieveMetadataInstances_(false),
    retrieveLabels_(false),
    retrieveAttachments_(false),
    retrieveParentIdentifier_(false),
    retrieveChildrenIdentifiers_(false)
  {
  }


  FindRequest::~FindRequest()
  {

    for (std::deque<Ordering*>::iterator it = ordering_.begin(); it != ordering_.end(); ++it)
    {
      assert(*it != NULL);
      delete *it;
    }
  }

  void FindRequest::AddDicomTagConstraint(const DicomTagConstraint& constraint)
  {
    dicomTagConstraints_.push_back(constraint);
  }

  const DicomTagConstraint& FindRequest::GetDicomTagConstraint(size_t index) const
  {
    if (index >= dicomTagConstraints_.size())
    {
      throw OrthancException(ErrorCode_ParameterOutOfRange);
    }
    else
    {
      return dicomTagConstraints_[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::AddOrdering(const DicomTag& tag,
                                OrderingDirection direction)
  {
    ordering_.push_back(new Ordering(Key(tag), direction));
  }


  void FindRequest::AddOrdering(MetadataType metadataType, 
                                OrderingDirection direction)
  {
    ordering_.push_back(new Ordering(Key(metadataType), direction));
  }


  void FindRequest::SetRetrieveMainDicomTags(ResourceType level,
                                             bool retrieve)
  {
    if (!IsResourceLevelAboveOrEqual(level, level_))
    {
      throw OrthancException(ErrorCode_ParameterOutOfRange);
    }

    switch (level)
    {
      case ResourceType_Patient:
        retrieveMainDicomTagsPatients_ = retrieve;
        break;

      case ResourceType_Study:
        retrieveMainDicomTagsStudies_ = retrieve;
        break;

      case ResourceType_Series:
        retrieveMainDicomTagsSeries_ = retrieve;
        break;

      case ResourceType_Instance:
        retrieveMainDicomTagsInstances_ = retrieve;
        break;

      default:
        throw OrthancException(ErrorCode_InternalError);
    }
  }


  bool FindRequest::IsRetrieveMainDicomTags(ResourceType level) const
  {
    if (!IsResourceLevelAboveOrEqual(level, level_))
    {
      throw OrthancException(ErrorCode_ParameterOutOfRange);
    }

    switch (level)
    {
      case ResourceType_Patient:
        return retrieveMainDicomTagsPatients_;

      case ResourceType_Study:
        return retrieveMainDicomTagsStudies_;

      case ResourceType_Series:
        return retrieveMainDicomTagsSeries_;

      case ResourceType_Instance:
        return retrieveMainDicomTagsInstances_;

      default:
        throw OrthancException(ErrorCode_InternalError);
    }
  }


  void FindRequest::SetRetrieveMetadata(ResourceType level,
                                        bool retrieve)
  {
    if (!IsResourceLevelAboveOrEqual(level, level_))
    {
      throw OrthancException(ErrorCode_ParameterOutOfRange);
    }

    switch (level)
    {
      case ResourceType_Patient:
        retrieveMetadataPatients_ = retrieve;
        break;

      case ResourceType_Study:
        retrieveMetadataStudies_ = retrieve;
        break;

      case ResourceType_Series:
        retrieveMetadataSeries_ = retrieve;
        break;

      case ResourceType_Instance:
        retrieveMetadataInstances_ = retrieve;
        break;

      default:
        throw OrthancException(ErrorCode_InternalError);
    }
  }


  bool FindRequest::IsRetrieveMetadata(ResourceType level) const
  {
    if (!IsResourceLevelAboveOrEqual(level, level_))
    {
      throw OrthancException(ErrorCode_ParameterOutOfRange);
    }

    switch (level)
    {
      case ResourceType_Patient:
        return retrieveMetadataPatients_;

      case ResourceType_Study:
        return retrieveMetadataStudies_;

      case ResourceType_Series:
        return retrieveMetadataSeries_;

      case ResourceType_Instance:
        return retrieveMetadataInstances_;

      default:
        throw OrthancException(ErrorCode_InternalError);
    }
  }


  void FindRequest::SetRetrieveParentIdentifier(bool retrieve)
  {
    if (level_ == ResourceType_Patient)
    {
      throw OrthancException(ErrorCode_BadParameterType);
    }
    else
    {
      retrieveParentIdentifier_ = retrieve;
    }
  }


  void FindRequest::SetRetrieveChildrenIdentifiers(bool retrieve)
  {
    if (level_ == ResourceType_Instance)
    {
      throw OrthancException(ErrorCode_BadParameterType);
    }
    else
    {
      retrieveChildrenIdentifiers_ = retrieve;
    }
  }


  void FindRequest::AddRetrieveChildrenMetadata(MetadataType metadata)
  {
    if (IsRetrieveChildrenMetadata(metadata))
    {
      throw OrthancException(ErrorCode_BadSequenceOfCalls);
    }
    else
    {
      retrieveChildrenMetadata_.insert(metadata);
    }
  }


  void FindRequest::AddRetrieveAttachmentOfOneInstance(FileContentType type)
  {
    if (retrieveAttachmentOfOneInstance_.find(type) == retrieveAttachmentOfOneInstance_.end())
    {
      retrieveAttachmentOfOneInstance_.insert(type);
    }
    else
    {
      throw OrthancException(ErrorCode_BadSequenceOfCalls);
    }
  }
}