Mercurial > hg > orthanc
changeset 5831:22623aa8e6fc find-refactoring
DB SDK: ordering + metadata constraints
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Tue, 08 Oct 2024 17:53:06 +0200 |
parents | 40f236ad829c |
children | dd2af8692cbc |
files | OrthancServer/Plugins/Engine/OrthancPluginDatabaseV4.cpp OrthancServer/Plugins/Include/orthanc/OrthancDatabasePlugin.proto |
diffstat | 2 files changed, 127 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/OrthancServer/Plugins/Engine/OrthancPluginDatabaseV4.cpp Tue Oct 08 17:05:18 2024 +0200 +++ b/OrthancServer/Plugins/Engine/OrthancPluginDatabaseV4.cpp Tue Oct 08 17:53:06 2024 +0200 @@ -36,6 +36,7 @@ #include "../../Sources/Database/VoidDatabaseListener.h" #include "../../Sources/ServerToolbox.h" #include "PluginsEnumerations.h" +#include "../../Sources/Database/MainDicomTagsRegistry.h" #include "OrthancDatabasePlugin.pb.h" // Auto-generated file @@ -179,6 +180,94 @@ } + static void Convert(DatabasePluginMessages::DatabaseMetadataConstraint& target, + const DatabaseMetadataConstraint& source) + { + target.set_metadata(source.GetMetadata()); + target.set_is_case_sensitive(source.IsCaseSensitive()); + target.set_is_mandatory(source.IsMandatory()); + + target.mutable_values()->Reserve(source.GetValuesCount()); + for (size_t j = 0; j < source.GetValuesCount(); j++) + { + target.add_values(source.GetValue(j)); + } + + switch (source.GetConstraintType()) + { + case ConstraintType_Equal: + target.set_type(DatabasePluginMessages::CONSTRAINT_EQUAL); + break; + + case ConstraintType_SmallerOrEqual: + target.set_type(DatabasePluginMessages::CONSTRAINT_SMALLER_OR_EQUAL); + break; + + case ConstraintType_GreaterOrEqual: + target.set_type(DatabasePluginMessages::CONSTRAINT_GREATER_OR_EQUAL); + break; + + case ConstraintType_Wildcard: + target.set_type(DatabasePluginMessages::CONSTRAINT_WILDCARD); + break; + + case ConstraintType_List: + target.set_type(DatabasePluginMessages::CONSTRAINT_LIST); + break; + + default: + throw OrthancException(ErrorCode_ParameterOutOfRange); + } + } + + + static void Convert(DatabasePluginMessages::Find_Request_Ordering& target, + const FindRequest::Ordering& source) + { + switch (source.GetKeyType()) + { + case FindRequest::KeyType_DicomTag: + { + ResourceType tagLevel; + DicomTagType tagType; + MainDicomTagsRegistry registry; + + registry.LookupTag(tagLevel, tagType, source.GetDicomTag()); + + target.set_key_type(DatabasePluginMessages::ORDERING_KEY_TYPE_DICOM_TAG); + target.set_tag_group(source.GetDicomTag().GetGroup()); + target.set_tag_element(source.GetDicomTag().GetElement()); + target.set_is_identifier_tag(tagType == DicomTagType_Identifier); + target.set_tag_level(Convert(tagLevel)); + + }; break; + + case FindRequest::KeyType_Metadata: + target.set_key_type(DatabasePluginMessages::ORDERING_KEY_TYPE_METADATA); + target.set_metadata(source.GetMetadataType()); + + break; + + default: + throw OrthancException(ErrorCode_ParameterOutOfRange); + } + + switch (source.GetDirection()) + { + case FindRequest::OrderingDirection_Ascending: + target.set_direction(DatabasePluginMessages::ORDERING_DIRECTION_ASC); + break; + + case FindRequest::OrderingDirection_Descending: + target.set_direction(DatabasePluginMessages::ORDERING_DIRECTION_DESC); + + break; + + default: + throw OrthancException(ErrorCode_ParameterOutOfRange); + } + } + static DatabasePluginMessages::LabelsConstraintType Convert(LabelsConstraint constraint) { switch (constraint) @@ -1420,6 +1509,16 @@ Convert(*dbRequest.mutable_find()->add_dicom_tag_constraints(), request.GetDicomTagConstraints().GetConstraint(i)); } + for (std::deque<DatabaseMetadataConstraint*>::const_iterator it = request.GetMetadataConstraint().begin(); it != request.GetMetadataConstraint().end(); ++it) + { + Convert(*dbRequest.mutable_find()->add_metadata_constraints(), *(*it)); + } + + for (std::deque<FindRequest::Ordering*>::const_iterator it = request.GetOrdering().begin(); it != request.GetOrdering().end(); ++it) + { + Convert(*dbRequest.mutable_find()->add_ordering(), *(*it)); + } + if (request.HasLimits()) { dbRequest.mutable_find()->mutable_limits()->set_since(request.GetLimitsSince()); @@ -1433,9 +1532,6 @@ dbRequest.mutable_find()->set_labels_constraint(Convert(request.GetLabelsConstraint())); - // TODO-FIND: ordering_ - // TODO-FIND: metadataConstraints__ - dbRequest.mutable_find()->set_retrieve_main_dicom_tags(request.IsRetrieveMainDicomTags()); dbRequest.mutable_find()->set_retrieve_metadata(request.IsRetrieveMetadata()); dbRequest.mutable_find()->set_retrieve_labels(request.IsRetrieveLabels());
--- a/OrthancServer/Plugins/Include/orthanc/OrthancDatabasePlugin.proto Tue Oct 08 17:05:18 2024 +0200 +++ b/OrthancServer/Plugins/Include/orthanc/OrthancDatabasePlugin.proto Tue Oct 08 17:53:06 2024 +0200 @@ -78,6 +78,16 @@ LABELS_CONSTRAINT_NONE = 2; } +enum OrderingKeyType { + ORDERING_KEY_TYPE_DICOM_TAG = 0; + ORDERING_KEY_TYPE_METADATA = 1; +} + +enum OrderingDirection { + ORDERING_DIRECTION_ASC = 0; + ORDERING_DIRECTION_DESC = 1; +} + message ServerIndexChange { int64 seq = 1; int32 change_type = 2; // opaque "ChangeType" in Orthanc @@ -109,6 +119,13 @@ repeated string values = 8; } +message DatabaseMetadataConstraint { + int32 metadata = 1; + bool is_case_sensitive = 2; + bool is_mandatory = 3; + ConstraintType type = 4; + repeated string values = 5; +} /** * Database-level operations. @@ -860,6 +877,15 @@ repeated int32 retrieve_metadata = 2; repeated Tag retrieve_main_dicom_tags = 3; } + message Ordering { + OrderingKeyType key_type = 1; + OrderingDirection direction = 2; + uint32 tag_group = 3; + uint32 tag_element = 4; + bool is_identifier_tag = 5; + ResourceType tag_level = 6; + int32 metadata = 7; + } // Part 1 of the request: Constraints ResourceType level = 1; @@ -871,9 +897,9 @@ Limits limits = 7; // optional repeated string labels = 8; LabelsConstraintType labels_constraint = 9; + repeated Ordering ordering = 10; + repeated DatabaseMetadataConstraint metadata_constraints = 11; - // TODO-FIND: ordering_ - // TODO-FIND: metadataConstraints_ // Part 2 of the request: What is to be retrieved bool retrieve_main_dicom_tags = 100;