Merge branch 'release/v2.3.0'

.circleci/config.yml

@@ -1601,7 +1601,7 @@ commands:
 orbs:
   maven: circleci/maven@1.0.1
   openjdk-install: cloudesire/openjdk-install@1.2.3
-  sonarcloud: sonarsource/sonarcloud@1.0.2
+  sonarcloud: sonarsource/sonarcloud@2.0.0
 
 executors:
   docker-python3:

.github/dependabot.yml

@@ -13,4 +13,9 @@ updates:
        - dependency-name: "*"
          update-types: ["version-update:semver-major"]
        - dependency-name: "org.antlr:*"
-         update-types: ["version-update:semver-minor"] 
+         update-types: ["version-update:semver-minor"]
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every week
+      interval: "weekly"

.github/workflows/build.yml

@@ -12,12 +12,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
       - name: Setup Java
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
           java-version: '17'
@@ -27,7 +27,7 @@ jobs:
         run: mvn -B verify
 
       - name: Setup Maven Central
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
           distribution: 'temurin'
           java-version: '17'

.github/workflows/codeql.yml

@@ -40,12 +40,13 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: setup java 17
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v3
         with:
-         java-version: 17
+          distribution: 'temurin'
+          java-version: 17
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL

.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           # This will be used by git in all further steps

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Note: version releases in the 0.x.y range may introduce breaking changes.
 
+## [2.3.0]
+ ### Added 
+- AQL Dto model add terminology , and Versioning  ([#511](https://github.com/ehrbase/openEHR_SDK/pull/511))
+ ### Fixed 
+
 ## [2.2.0]
  ### Added 
  ### Fixed 
@@ -334,3 +339,4 @@ Note: version releases in the 0.x.y range may introduce breaking changes.
 [2.0.0]: https://github.com/ehrbase/openEHR_SDK/compare/v1.29.0...v2.0.0
 [2.1.0]: https://github.com/ehrbase/openEHR_SDK/compare/v2.0.0...v2.1.0
 [2.2.0]: https://github.com/ehrbase/openEHR_SDK/compare/v2.1.0...v2.2.0
+[2.3.0]: https://github.com/ehrbase/openEHR_SDK/compare/v2.2.0...v2.3.0

aql/pom.xml

@@ -25,7 +25,7 @@
     <parent>
         <groupId>org.ehrbase.openehr.sdk</groupId>
         <artifactId>sdk-parent</artifactId>
-        <version>2.2.0</version>
+        <version>2.3.0</version>
     </parent>
 
     <artifactId>aql</artifactId>

aql/src/main/antlr4/org/ehrbase/openehr/sdk/aql/parser/antlr/AqlLexer.g4

@@ -168,6 +168,7 @@ fragment MINUTE: [0-5][0-9] ; // minutes
 fragment SECOND: [0-5][0-9] ; // seconds
 
 // ------------------- special word symbols --------------
+BOOLEAN: SYM_TRUE | SYM_FALSE ;
 
 fragment SYM_TRUE: T R U E ;
 fragment SYM_FALSE: F A L S E ;
@@ -181,6 +182,8 @@ IDENTIFIER: IDENTIFIER_CHAR;
 fragment IDENTIFIER_CHAR : ALPHA_CHAR WORD_CHAR* ;
 fragment ARCHETYPE_CONCEPT_ID : ALPHA_CHAR NAME_CHAR* ;
 
+
+
 // --------------------- composed primitive types -------------------
 // coded term shortcut e.g. 'ICD10AM(1998)::F23', 'ISO_639-1::en' or 'snomed_ct(3.1)::3415004|cyanosis|'
 TERM_CODE : TERM_CODE_CHAR+ ( '(' TERM_CODE_CHAR+ ')' )? '::' TERM_CODE_CHAR+ ('|' ~[|[\]]+ '|')?;
@@ -241,8 +244,6 @@ fragment LABEL: ALPHA_CHAR (NAME_CHAR|URI_PCT_ENCODED)* ;
 
 // --------------------- atomic primitive types -------------------
 
-BOOLEAN: SYM_TRUE | SYM_FALSE ;
-
 INTEGER: DIGIT+;
 REAL: DIGIT* '.' DIGIT+;
 SCI_INTEGER: INTEGER E_SUFFIX;

aql/src/main/java/org/ehrbase/openehr/sdk/aql/dto/containment/AbstractContainmentExpression.java

@@ -19,14 +19,22 @@
 
 import com.fasterxml.jackson.annotation.JsonIdentityInfo;
 import com.fasterxml.jackson.annotation.ObjectIdGenerators;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.Objects;
+import org.ehrbase.openehr.sdk.aql.dto.path.AndOperatorPredicate;
+import org.ehrbase.openehr.sdk.aql.serializer.PredicateDeserializer;
+import org.ehrbase.openehr.sdk.aql.serializer.PredicateSerializer;
 
 /**
  * @author Stefan Spiska
  */
 @JsonIdentityInfo(generator = ObjectIdGenerators.PropertyGenerator.class, property = "identifier")
 public abstract class AbstractContainmentExpression implements Containment {
 
+    protected List<AndOperatorPredicate> predicates;
     private Containment contains;
 
     private String identifier;
@@ -47,21 +55,40 @@ public void setIdentifier(String identifier) {
         this.identifier = identifier;
     }
 
+    @JsonSerialize(using = PredicateSerializer.class)
+    public List<AndOperatorPredicate> getPredicates() {
+        return predicates;
+    }
+
+    @JsonDeserialize(using = PredicateDeserializer.class)
+    public void setPredicates(List<AndOperatorPredicate> predicates) {
+        if (predicates != null) {
+            this.predicates = new ArrayList<>(predicates);
+        } else {
+            this.predicates = null;
+        }
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         AbstractContainmentExpression that = (AbstractContainmentExpression) o;
-        return Objects.equals(contains, that.contains) && Objects.equals(identifier, that.identifier);
+        return Objects.equals(predicates, that.predicates)
+                && Objects.equals(contains, that.contains)
+                && Objects.equals(identifier, that.identifier);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(contains, identifier);
+        return Objects.hash(predicates, contains, identifier);
     }
 
     @Override
     public String toString() {
-        return "AbstractContainmentExpression{" + "contains=" + contains + ", identifier='" + identifier + '\'' + '}';
+        return "AbstractContainmentExpression{" + "predicates="
+                + predicates + ", contains="
+                + contains + ", identifier='"
+                + identifier + '\'' + '}';
     }
 }

aql/src/main/java/org/ehrbase/openehr/sdk/aql/dto/containment/ContainmentClassExpression.java

@@ -17,21 +17,12 @@
  */
 package org.ehrbase.openehr.sdk.aql.dto.containment;
 
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-import com.fasterxml.jackson.databind.annotation.JsonSerialize;
-import java.util.ArrayList;
-import java.util.List;
 import java.util.Objects;
-import org.ehrbase.openehr.sdk.aql.dto.path.AndOperatorPredicate;
-import org.ehrbase.openehr.sdk.aql.serializer.PredicateDeserializer;
-import org.ehrbase.openehr.sdk.aql.serializer.PredicateSerializer;
 
 public class ContainmentClassExpression extends AbstractContainmentExpression {
 
     private String type;
 
-    private List<AndOperatorPredicate> predicates;
-
     public String getType() {
         return type;
     }
@@ -40,35 +31,22 @@ public void setType(String type) {
         this.type = type;
     }
 
-    @JsonSerialize(using = PredicateSerializer.class)
-    public List<AndOperatorPredicate> getPredicates() {
-        return predicates;
-    }
-
-    @JsonDeserialize(using = PredicateDeserializer.class)
-    public void setPredicates(List<AndOperatorPredicate> predicates) {
-        this.predicates = new ArrayList<>(predicates);
-    }
-
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         if (!super.equals(o)) return false;
         ContainmentClassExpression that = (ContainmentClassExpression) o;
-        return Objects.equals(type, that.type) && Objects.equals(predicates, that.predicates);
+        return Objects.equals(type, that.type);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(super.hashCode(), type, predicates);
+        return Objects.hash(super.hashCode(), type);
     }
 
     @Override
     public String toString() {
-        return "ContainmentClassExpression{" + "type='"
-                + type + '\'' + ", predicates="
-                + predicates + "} "
-                + super.toString();
+        return "ContainmentClassExpression{" + "type='" + type + '\'' + "} " + super.toString();
     }
 }

aql/src/main/java/org/ehrbase/openehr/sdk/aql/dto/containment/ContainmentVersionExpression.java

@@ -17,7 +17,63 @@
  */
 package org.ehrbase.openehr.sdk.aql.dto.containment;
 
+import java.util.List;
+import java.util.Objects;
+import org.ehrbase.openehr.sdk.aql.dto.path.AndOperatorPredicate;
+
 /**
  * @author Stefan Spiska
  */
-public class ContainmentVersionExpression extends AbstractContainmentExpression {}
+public class ContainmentVersionExpression extends AbstractContainmentExpression {
+
+    public enum VersionPredicateType {
+        LATEST_VERSION,
+        ALL_VERSIONS,
+        STANDARD_PREDICATE;
+    }
+
+    private VersionPredicateType versionPredicateType;
+
+    public VersionPredicateType getVersionPredicateType() {
+        return versionPredicateType;
+    }
+
+    public void setVersionPredicateType(VersionPredicateType versionPredicateType) {
+        this.versionPredicateType = versionPredicateType;
+
+        if (versionPredicateType.equals(VersionPredicateType.ALL_VERSIONS)
+                || versionPredicateType.equals(VersionPredicateType.LATEST_VERSION)) {
+            setPredicates(null);
+        }
+    }
+
+    @Override
+    public void setPredicates(List<AndOperatorPredicate> predicates) {
+        super.setPredicates(predicates);
+
+        if (predicates != null) {
+            versionPredicateType = VersionPredicateType.STANDARD_PREDICATE;
+        }
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        if (!super.equals(o)) return false;
+        ContainmentVersionExpression that = (ContainmentVersionExpression) o;
+        return versionPredicateType == that.versionPredicateType;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(super.hashCode(), versionPredicateType);
+    }
+
+    @Override
+    public String toString() {
+        return "ContainmentVersionExpression{" + "versionPredicateType="
+                + versionPredicateType + "} "
+                + super.toString();
+    }
+}

aql/src/test/java/org/ehrbase/openehr/sdk/aql/roundtriptest/AqlTestCase.java → aql/src/main/java/org/ehrbase/openehr/sdk/aql/dto/operand/FunctionCall.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022 vitasystems GmbH and Hannover Medical School.
+ * Copyright (c) 2023 vitasystems GmbH and Hannover Medical School.
  *
  * This file is part of project openEHR_SDK
  *
@@ -15,14 +15,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.ehrbase.openehr.sdk.aql.roundtriptest;
+package org.ehrbase.openehr.sdk.aql.dto.operand;
 
 /**
  * @author Stefan Spiska
  */
-public interface AqlTestCase {
-
-    String getTestAql();
-
-    String getExpectedAql();
-}
+public interface FunctionCall extends ColumnExpression, Operand, ComparisonLeftOperand {}

aql/src/main/java/org/ehrbase/openehr/sdk/aql/dto/operand/IdentifiedPath.java

@@ -27,6 +27,7 @@
 import org.ehrbase.openehr.sdk.aql.dto.containment.AbstractContainmentExpression;
 import org.ehrbase.openehr.sdk.aql.dto.path.AndOperatorPredicate;
 import org.ehrbase.openehr.sdk.aql.dto.path.AqlObjectPath;
+import org.ehrbase.openehr.sdk.aql.render.AqlRenderer;
 import org.ehrbase.openehr.sdk.aql.serializer.PredicateDeserializer;
 import org.ehrbase.openehr.sdk.aql.serializer.PredicateSerializer;
 
@@ -87,4 +88,8 @@ public int hashCode() {
     public String toString() {
         return "IdentifiedPath{" + "root=" + root + ", rootPredicate=" + rootPredicate + ", path=" + path + '}';
     }
+
+    public String render() {
+        return AqlRenderer.render(this);
+    }
 }

aql/src/main/java/org/ehrbase/openehr/sdk/aql/dto/operand/SingleRowFunction.java

@@ -23,7 +23,7 @@
 /**
  * @author Stefan Spiska
  */
-public class SingleRowFunction implements ColumnExpression, Operand, ComparisonLeftOperand {
+public class SingleRowFunction implements FunctionCall {
 
     private SingleRowFunctionName functionName;
     private List<Operand> operandList;