org.ehrbase.util.StoredQueryQualifiedName Maven / Gradle / Ivy
/*
* Copyright (c) 2024 vitasystems GmbH.
*
* This file is part of project EHRbase
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.ehrbase.util;
import java.util.Optional;
import org.springframework.lang.NonNull;
import org.springframework.lang.Nullable;
/**
* Represents a stored AQL Query, as described in
* openEHR Platform Service Model: 8. Query Service
* with format
*
* reverse-domain-name '::' semantic-id [ '/' version ]
*
* org.example.departmentx.test::diabetes-patient-overview/1.0.2
*
*
* @param reverseDomainName reverse domain name like rg.example.departmentx.test::diabetes-patient-overview
* @param semanticId semantic identifier of the query prod
* @param semVer semantic version of the query like 1.2.3
*
* @see openEHR Platform Service Model: 8. Query Service
* @see semver.org
*/
public record StoredQueryQualifiedName(
@NonNull String reverseDomainName, @NonNull String semanticId, @NonNull SemVer semVer) {
public static StoredQueryQualifiedName create(@NonNull String qualifiedName, @Nullable SemVer version) {
String[] nameParts = qualifiedName.split("::");
if (nameParts.length != 2 || qualifiedName.contains("/"))
throw new IllegalArgumentException(
"Qualified name is not valid (https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_query_service):"
+ qualifiedName);
return new StoredQueryQualifiedName(
nameParts[0], nameParts[1], Optional.ofNullable(version).orElse(SemVer.NO_VERSION));
}
/**
* Returns the name part of the qualified query name:
*
* reverse-domain-name '::' semantic-id [ '/' version ]
*
* org.example.departmentx.test::diabetes-patient-overview/1.0.2
*
*
* @return name part concatenated {@link #reverseDomainName}::{@link #semanticId}
*/
public String toName() {
return reverseDomainName + "::" + semanticId;
}
/**
* Returns the fully qualified query name
*
* reverse-domain-name '::' semantic-id
*
* org.example.departmentx.test::diabetes-patient-overview
*
*
* @return qualifiedName part concatenated {@link #reverseDomainName}::{@link #semanticId}/{@link #semVer}
*/
public String toQualifiedNameString() {
StringBuilder sb =
new StringBuilder().append(reverseDomainName).append("::").append(semanticId);
if (!semVer.isNoVersion()) {
sb.append('/').append(semVer);
}
return sb.toString();
}
/**
* Uses {@link #toQualifiedNameString()}
*
* @return qualifiedName from {@link #toQualifiedNameString()}
*/
public String toString() {
return toQualifiedNameString();
}
}