Improve query functionality

src/main/java/de/rwth/idsg/steve/repository/OcppTagRepository.java

@@ -31,7 +31,7 @@
  * @since 19.08.2014
  */
 public interface OcppTagRepository {
-    List<OcppTag.Overview> getOverview(OcppTagQueryForm form);
+    List<OcppTag.OcppTagOverview> getOverview(OcppTagQueryForm form);
 
     Result<OcppTagActivityRecord> getRecords();
     Result<OcppTagActivityRecord> getRecords(List<String> idTagList);

src/main/java/de/rwth/idsg/steve/repository/dto/OcppTag.java

@@ -35,7 +35,7 @@ public final class OcppTag {
     @Getter
     @Builder
     @ToString
-    public static final class Overview {
+    public static final class OcppTagOverview {
         @Schema(description = "PK of the OCPP tag")
         private final Integer ocppTagPk;
 

src/main/java/de/rwth/idsg/steve/repository/impl/ChargePointRepositoryImpl.java

@@ -158,6 +158,10 @@ private Result<Record5<Integer, String, String, String, DateTime>> getOverviewIn
             selectQuery.addConditions(includes(CHARGE_BOX.CHARGE_BOX_ID, form.getChargeBoxId()));
         }
 
+        if (form.isSetNote()) {
+            selectQuery.addConditions(includes(CHARGE_BOX.NOTE, form.getNote()));
+        }
+
         switch (form.getHeartbeatPeriod()) {
             case ALL:
                 break;

src/main/java/de/rwth/idsg/steve/repository/impl/OcppTagRepositoryImpl.java

@@ -20,7 +20,7 @@
 
 import de.rwth.idsg.steve.SteveException;
 import de.rwth.idsg.steve.repository.OcppTagRepository;
-import de.rwth.idsg.steve.repository.dto.OcppTag.Overview;
+import de.rwth.idsg.steve.repository.dto.OcppTag.OcppTagOverview;
 import de.rwth.idsg.steve.web.dto.OcppTagForm;
 import de.rwth.idsg.steve.web.dto.OcppTagQueryForm;
 import jooq.steve.db.tables.OcppTagActivity;
@@ -43,6 +43,7 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+import static de.rwth.idsg.steve.utils.CustomDSL.includes;
 import static de.rwth.idsg.steve.utils.DateTimeUtils.humanize;
 import static de.rwth.idsg.steve.utils.DateTimeUtils.toDateTime;
 import static jooq.steve.db.tables.OcppTag.OCPP_TAG;
@@ -65,7 +66,7 @@
 
     @Override
     @SuppressWarnings("unchecked")
-    public List<Overview> getOverview(OcppTagQueryForm form) {
+    public List<OcppTagOverview> getOverview(OcppTagQueryForm form) {
         SelectQuery selectQuery = ctx.selectQuery();
         selectQuery.addFrom(OCPP_TAG_ACTIVITY);
 
@@ -98,6 +99,10 @@
             selectQuery.addConditions(OCPP_TAG_ACTIVITY.PARENT_ID_TAG.eq(form.getParentIdTag()));
         }
 
+        if (form.isNoteSet()) {
+            selectQuery.addConditions(includes(OCPP_TAG_ACTIVITY.NOTE, form.getNote()));
+        }
+
         switch (form.getExpired()) {
             case ALL:
                 break;
@@ -253,10 +258,10 @@
     }
 
     private static class UserMapper
-            implements RecordMapper<Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String>, Overview> {
+            implements RecordMapper<Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String>, OcppTagOverview> {
         @Override
-        public Overview map(Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String> r) {
-            return Overview.builder()
+        public OcppTagOverview map(Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String> r) {
+            return OcppTagOverview.builder()
                           .ocppTagPk(r.value1())
                           .parentOcppTagPk(r.value2())
                           .idTag(r.value3())

src/main/java/de/rwth/idsg/steve/service/OcppTagService.java

@@ -22,7 +22,6 @@
 import static de.rwth.idsg.steve.utils.OcppTagActivityRecordUtils.isExpired;
 
 import com.google.common.base.Strings;
-import de.rwth.idsg.steve.SteveException;
 import de.rwth.idsg.steve.repository.OcppTagRepository;
 import de.rwth.idsg.steve.repository.dto.OcppTag;
 import de.rwth.idsg.steve.service.dto.UnidentifiedIncomingObject;
@@ -56,7 +55,7 @@ public class OcppTagService {
     private final OcppTagRepository ocppTagRepository;
     private final AuthTagService authTagService;
 
-    public List<OcppTag.Overview> getOverview(OcppTagQueryForm form) {
+    public List<OcppTag.OcppTagOverview> getOverview(OcppTagQueryForm form) {
         return ocppTagRepository.getOverview(form);
     }
 

src/main/java/de/rwth/idsg/steve/web/api/OcppTagsRestController.java

@@ -19,11 +19,11 @@
 package de.rwth.idsg.steve.web.api;
 
 import de.rwth.idsg.steve.SteveException;
-import de.rwth.idsg.steve.repository.dto.OcppTag;
+import de.rwth.idsg.steve.repository.dto.OcppTag.OcppTagOverview;
 import de.rwth.idsg.steve.service.OcppTagService;
 import de.rwth.idsg.steve.web.api.ApiControllerAdvice.ApiErrorResponse;
 import de.rwth.idsg.steve.web.dto.OcppTagForm;
-import de.rwth.idsg.steve.web.dto.OcppTagQueryForm;
+import de.rwth.idsg.steve.web.dto.OcppTagQueryForm.OcppTagQueryFormForApi;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
@@ -80,7 +80,7 @@
     )
     @GetMapping(value = "")
     @ResponseBody
-    public List<OcppTag.Overview> get(OcppTagQueryForm.ForApi params) {
+    public List<OcppTagOverview> get(OcppTagQueryFormForApi params) {
         log.debug("Read request for query: {}", params);
 
         var response = ocppTagService.getOverview(params);
@@ -100,7 +100,7 @@
     )
     @GetMapping("/{ocppTagPk}")
     @ResponseBody
-    public OcppTag.Overview getOne(@PathVariable("ocppTagPk") Integer ocppTagPk) {
+    public OcppTagOverview getOne(@PathVariable("ocppTagPk") Integer ocppTagPk) {
         log.debug("Read request for ocppTagPk: {}", ocppTagPk);
 
         var response = getOneInternal(ocppTagPk);
@@ -123,7 +123,7 @@
     @PostMapping
     @ResponseBody
     @ResponseStatus(HttpStatus.CREATED)
-    public OcppTag.Overview create(@RequestBody @Valid OcppTagForm params) {
+    public OcppTagOverview create(@RequestBody @Valid OcppTagForm params) {
         log.debug("Create request: {}", params);
 
         int ocppTagPk = ocppTagService.addOcppTag(params);
@@ -145,7 +145,7 @@
     )
     @PutMapping("/{ocppTagPk}")
     @ResponseBody
-    public OcppTag.Overview update(@PathVariable("ocppTagPk") Integer ocppTagPk, @RequestBody @Valid OcppTagForm params) {
+    public OcppTagOverview update(@PathVariable("ocppTagPk") Integer ocppTagPk, @RequestBody @Valid OcppTagForm params) {
         params.setOcppTagPk(ocppTagPk); // the one from incoming params does not matter
         log.debug("Update request: {}", params);
 
@@ -169,7 +169,7 @@
     )
     @DeleteMapping("/{ocppTagPk}")
     @ResponseBody
-    public OcppTag.Overview delete(@PathVariable("ocppTagPk") Integer ocppTagPk) {
+    public OcppTagOverview delete(@PathVariable("ocppTagPk") Integer ocppTagPk) {
         log.debug("Delete request for ocppTagPk: {}", ocppTagPk);
 
         var response = getOneInternal(ocppTagPk);
@@ -179,11 +179,11 @@
         return response;
     }
 
-    private OcppTag.Overview getOneInternal(int ocppTagPk) {
-        OcppTagQueryForm.ForApi params = new OcppTagQueryForm.ForApi();
+    private OcppTagOverview getOneInternal(int ocppTagPk) {
+        OcppTagQueryFormForApi params = new OcppTagQueryFormForApi();
         params.setOcppTagPk(ocppTagPk);
 
-        List<OcppTag.Overview> results = ocppTagService.getOverview(params);
+        List<OcppTagOverview> results = ocppTagService.getOverview(params);
         if (results.isEmpty()) {
             throw new SteveException.NotFound("Could not find this ocppTag");
         }

src/main/java/de/rwth/idsg/steve/web/api/TransactionsRestController.java

@@ -70,7 +70,7 @@ public class TransactionsRestController {
     )
     @GetMapping(value = "")
     @ResponseBody
-    public List<Transaction> get(@Valid TransactionQueryForm.ForApi params) {
+    public List<Transaction> get(@Valid TransactionQueryForm.TransactionQueryFormForApi params) {
         log.debug("Read request for query: {}", params);
 
         if (params.isReturnCSV()) {

src/main/java/de/rwth/idsg/steve/web/dto/ChargePointQueryForm.java

@@ -18,6 +18,7 @@
  */
 package de.rwth.idsg.steve.web.dto;
 
+import com.google.common.base.Strings;
 import de.rwth.idsg.steve.ocpp.OcppVersion;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
@@ -35,6 +36,7 @@ public class ChargePointQueryForm {
 
     private String chargeBoxId;
     private String description;
+    private String note;
     private OcppVersion ocppVersion;
     private QueryPeriodType heartbeatPeriod;
 
@@ -57,6 +59,10 @@ public boolean isSetChargeBoxId() {
         return chargeBoxId != null;
     }
 
+    public boolean isSetNote() {
+        return !Strings.isNullOrEmpty(note);
+    }
+
     @RequiredArgsConstructor
     public enum QueryPeriodType {
         ALL("All"),

src/main/java/de/rwth/idsg/steve/web/dto/OcppTagQueryForm.java

@@ -18,6 +18,7 @@
  */
 package de.rwth.idsg.steve.web.dto;
 
+import com.google.common.base.Strings;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
@@ -53,6 +54,9 @@
     @Schema(description = "Return blocked, not blocked, or all Ocpp tags? Defaults to ALL")
     private BooleanType blocked = BooleanType.FALSE;
 
+    @Schema(description = "Query by the note associated with the OCPP tag. The value of this field does not have to exactly match the note. A substring is also accepted.")
+    private String note;
+
     @Schema(hidden = true)
     public boolean isOcppTagPkSet() {
         return ocppTagPk != null;
@@ -68,6 +72,11 @@
         return parentIdTag != null;
     }
 
+    @Schema(hidden = true)
+    public boolean isNoteSet() {
+        return !Strings.isNullOrEmpty(note);
+    }
+
     public BooleanType getExpired() {
         return Objects.requireNonNullElse(expired, BooleanType.ALL);
     }
@@ -107,9 +116,9 @@
     }
 
     @ToString(callSuper = true)
-    public static class ForApi extends OcppTagQueryForm {
+    public static class OcppTagQueryFormForApi extends OcppTagQueryForm {
 
-        public ForApi () {
+        public OcppTagQueryFormForApi() {
             super();
             setExpired(BooleanType.ALL);
             setInTransaction(BooleanType.ALL);

src/main/java/de/rwth/idsg/steve/web/dto/TransactionQueryForm.java

@@ -119,9 +119,9 @@ public static QueryPeriodType fromValue(String v) {
     }
 
     @ToString(callSuper = true)
-    public static class ForApi extends TransactionQueryForm {
+    public static class TransactionQueryFormForApi extends TransactionQueryForm {
 
-        public ForApi() {
+        public TransactionQueryFormForApi() {
             super();
             setType(QueryType.ALL);
             setPeriodType(QueryPeriodType.ALL);

src/main/resources/webapp/WEB-INF/views/data-man/chargepoints.jsp

@@ -98,6 +98,10 @@
                     </form:select>
                     </td>
                 </tr>
+                <tr>
+                    <td>Note:</td>
+                    <td><form:input path="note"/></td>
+                </tr>
                 <tr>
                     <td></td>
                     <td id="add_space">

src/main/resources/webapp/WEB-INF/views/data-man/ocppTags.jsp

@@ -112,6 +112,10 @@
                     </form:select>
                     </td>
                 </tr>
+                <tr>
+                    <td>Note:</td>
+                    <td><form:input path="note"/></td>
+                </tr>
                 <tr>
                     <td></td>
                     <td id="add_space">

src/test/java/de/rwth/idsg/steve/issues/Issue1219.java

@@ -94,7 +94,7 @@ private void realTest() {
         var repository = new OcppTagRepositoryImpl(ctx);
 
         long start = System.currentTimeMillis();
-        List<OcppTag.Overview> values = repository.getOverview(new OcppTagQueryForm());
+        List<OcppTag.OcppTagOverview> values = repository.getOverview(new OcppTagQueryForm());
         long stop = System.currentTimeMillis();
 
         System.out.println("took " + Duration.millis(stop - start));