Merge pull request #2 from Ouest-France/1-improve-querydsl-to-allow-l…

…ogical-operand

feat(logical-operators): add logical operators on single and multiple…

.github/workflows/check.yml

@@ -0,0 +1,18 @@
+name: Check Feature
+
+on:
+  push:
+    branches-ignore:  [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: maven
+      - name: Build
+        run: mvn -ntp -B package --file pom.xml

README.md

@@ -87,7 +87,6 @@ To achieve the transformations between annotation based and concrete source, you
 ```java
 package postgrest.mappers;
 
-import fr.ouestfrance.querydsl.model.FilterFieldInfoModel;
 import fr.ouestfrance.querydsl.service.ext.Mapper;
 import fr.ouestfrance.querydsl.FilterOperation;
 
@@ -103,7 +102,9 @@ public class EqualsMapper implements Mapper<String> {
         // Will transform model to queryString "$key=eq.value" => example : service=eq.CIA
     }
 
-    public FilterOperation getOperation(){ return FilterOperation.EQ; }
+    public FilterOperation getOperation() {
+        return FilterOperation.EQ;
+    }
 }
 ```
 

src/main/java/fr/ouestfrance/querydsl/FilterField.java

@@ -32,4 +32,9 @@
      * @return <code>true</code> is should handle null, otherwise <code>false</code>
      */
     boolean orNull() default false;
+    /**
+     * Group the filter in "or group" every filter with "orGroup" will be joined together
+     * @return group name
+     */
+    String groupName() default "";
 }

src/main/java/fr/ouestfrance/querydsl/FilterFields.java

@@ -13,7 +13,15 @@
 
     /**
      * List of filterField, using value allow to avoid attribute name
-     * @return list of filterField
+     *
+     * @return filter fields
      */
     FilterField[] value() default {};
+
+    /**
+     * Group the filter in "or group" every filter with "orGroup" will be joined together
+     *
+     * @return group name
+     */
+    String groupName() default "";
 }

src/main/java/fr/ouestfrance/querydsl/model/FieldMetadata.java

@@ -0,0 +1,15 @@
+package fr.ouestfrance.querydsl.model;
+
+import java.lang.reflect.Method;
+import java.lang.reflect.Type;
+
+/**
+ * FieldInformation class represent metadata on declared field in a class
+ *
+ * @param name   Name of the field
+ * @param type   Return declared type of the field
+ * @param getter Getter method to access data
+ */
+public record FieldMetadata(String name, Type type, Method getter) {
+
+}

src/main/java/fr/ouestfrance/querydsl/model/Filter.java

@@ -0,0 +1,8 @@
+package fr.ouestfrance.querydsl.model;
+
+/**
+ * Filter interface
+ * The filter can be SimpleFilter or GroupFilter
+ */
+public interface Filter {
+}

src/main/java/fr/ouestfrance/querydsl/model/GroupFilter.java

@@ -0,0 +1,26 @@
+package fr.ouestfrance.querydsl.model;
+
+import java.util.List;
+
+/**
+ * Group filter allow to create a filter with logical operand and sub filters
+ * @param name of the group
+ * @param filters list of filters in the group
+ * @param operand logical operator to apply
+ */
+public record GroupFilter(String name, List<Filter> filters, Operand operand) implements Filter {
+
+    /**
+     * Operand types
+     */
+    public enum Operand {
+        /**
+         * OR Operand
+         */
+        OR,
+        /**
+         * AND Operand
+         */
+        AND
+    }
+}

src/main/java/fr/ouestfrance/querydsl/model/SimpleFilter.java

@@ -0,0 +1,14 @@
+package fr.ouestfrance.querydsl.model;
+
+import fr.ouestfrance.querydsl.FilterOperation;
+
+/**
+ * FilterFieldInfoModel allow to store object representation of FilterField Annotation
+ * @param key key of the criteria
+ * @param operation operator to apply
+ * @param orNull allow the field to be null
+ * @param metadata metadata of the field representing type, method accessor and field name
+ */
+public record SimpleFilter(String key, FilterOperation operation, boolean orNull,
+                           FieldMetadata metadata) implements Filter {
+}

src/main/java/fr/ouestfrance/querydsl/service/FilterFieldAnnotationProcessorService.java

@@ -1,6 +1,6 @@
 package fr.ouestfrance.querydsl.service;
 
-import fr.ouestfrance.querydsl.model.FilterFieldModel;
+import fr.ouestfrance.querydsl.model.Filter;
 import fr.ouestfrance.querydsl.service.scanner.FilterFieldAnnotationScanner;
 
 import java.util.List;
@@ -16,7 +16,7 @@ public class FilterFieldAnnotationProcessorService {
     /**
      * Cache of models
      */
-    private static final Map<Class<?>, List<FilterFieldModel>> CACHE = new ConcurrentHashMap<>();
+    private static final Map<Class<?>, List<Filter>> CACHE = new ConcurrentHashMap<>();
     /**
      * Annotation scanner
      */
@@ -28,7 +28,7 @@ public class FilterFieldAnnotationProcessorService {
      * @param clazz clazz to handle
      * @return List of filterFieldModel
      */
-    public List<FilterFieldModel> process(Class<?> clazz) {
+    public List<Filter> process(Class<?> clazz) {
         return CACHE.computeIfAbsent(clazz, x -> scanner.scan(clazz));
     }
 }

src/main/java/fr/ouestfrance/querydsl/service/ext/Mapper.java

@@ -1,7 +1,7 @@
 package fr.ouestfrance.querydsl.service.ext;
 
 import fr.ouestfrance.querydsl.FilterOperation;
-import fr.ouestfrance.querydsl.model.FilterFieldInfoModel;
+import fr.ouestfrance.querydsl.model.SimpleFilter;
 
 /**
  * Interface that allow to transform operation to concrete filter objet depending on the connector source
@@ -33,7 +33,7 @@ public interface Mapper<T> {
      * @param data        value data to apply to filter
      * @return criteria representation
      */
-    T map(FilterFieldInfoModel filterField, Object data);
+    T map(SimpleFilter filterField, Object data);
 
     /**
      * type of the operation handled by the mapper