Added page related code

AAFC-BICoE · Feb 14, 2024 · f60b92b · f60b92b
1 parent 918b080
commit f60b92b
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 4 deletions.
diff --git a/dina-base-api/pom.xml b/dina-base-api/pom.xml
@@ -143,7 +143,7 @@
     <dependency>
       <groupId>io.github.aafc-bicoe</groupId>
       <artifactId>dina-filter</artifactId>
-      <version>0.115-SNAPSHOT</version>
+      <version>0.118-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>io.github.aafc-bicoe</groupId>

diff --git a/.../AntlBasedSimpleSearchFilterListener.java → ...AntlrBasedSimpleSearchFilterListener.java b/.../AntlBasedSimpleSearchFilterListener.java → ...AntlrBasedSimpleSearchFilterListener.java
@@ -8,12 +8,15 @@
 import ca.gc.aafc.dina.filter.simple.SimpleSearchFilterBaseListener;
 import ca.gc.aafc.dina.filter.simple.SimpleSearchFilterParser;
 
-public class AntlBasedSimpleSearchFilterListener extends SimpleSearchFilterBaseListener {
+public class AntlrBasedSimpleSearchFilterListener extends SimpleSearchFilterBaseListener {
 
   private final List<FilterComponent> components = new ArrayList<>();
   private final List<String> includes = new ArrayList<>();
   private final List<String> sortAttributes = new ArrayList<>();
 
+  private Integer pageOffset;
+  private Integer pageLimit;
+
   @Override
   public void exitFilter(SimpleSearchFilterParser.FilterContext ctx) {
     // more than 1 value means a OR
@@ -32,6 +35,7 @@ public void exitFilter(SimpleSearchFilterParser.FilterContext ctx) {
     }
   }
 
+  @Override
   public void exitInclude(SimpleSearchFilterParser.IncludeContext ctx) {
     for(var attribute :  ctx.propertyName()) {
       includes.add(attribute.getText());
@@ -45,6 +49,15 @@ public void exitSort(SimpleSearchFilterParser.SortContext ctx) {
     }
   }
 
+  @Override
+  public void exitPage(SimpleSearchFilterParser.PageContext ctx) {
+    if (ctx.getText().contains("offset")) {
+      pageOffset = Integer.valueOf(ctx.pageValue().getText());
+    } else if (ctx.getText().contains("limit")) {
+      pageLimit = Integer.valueOf(ctx.pageValue().getText());
+    }
+  }
+
   /**
    * Build the FilterComponent object once the filter is parsed.
    * @return
@@ -68,6 +81,14 @@ public List<String> getSort() {
     return sortAttributes;
   }
 
+  public Integer getPageOffset() {
+    return pageOffset;
+  }
+
+  public Integer getPageLimit() {
+    return pageLimit;
+  }
+
   public Ops translateOperator(String op) {
     return switch (op) {
       case "EQ" -> Ops.EQ;

diff --git a/dina-base-api/src/test/java/ca/gc/aafc/dina/filter/AntlrGrammarTest.java b/dina-base-api/src/test/java/ca/gc/aafc/dina/filter/AntlrGrammarTest.java
@@ -28,7 +28,7 @@ public void onFilterAsString_structureReturned() {
     ParseTree tree = parser.simpleFilter();
 
     ParseTreeWalker walker = new ParseTreeWalker();
-    AntlBasedSimpleSearchFilterListener listener= new AntlBasedSimpleSearchFilterListener();
+    AntlrBasedSimpleSearchFilterListener listener= new AntlrBasedSimpleSearchFilterListener();
     walker.walk(listener, tree);
 
 
@@ -38,6 +38,9 @@ public void onFilterAsString_structureReturned() {
     assertEquals("position", listener.getSort().get(0));
     assertEquals("-name", listener.getSort().get(1));
     assertEquals("author.name", listener.getInclude().get(0));
+
+    assertEquals(5, listener.getPageOffset());
+    assertEquals(1, listener.getPageLimit());
   }
 
 }
diff --git a/dina-filter/src/main/antlr4/ca.gc.aafc.dina.filter.simple/SimpleSearchFilter.g4 b/dina-filter/src/main/antlr4/ca.gc.aafc.dina.filter.simple/SimpleSearchFilter.g4
@@ -8,7 +8,7 @@ filter: 'filter' '[' propertyName ']'( '[' comparison ']' )? '=' attributeValue
 
 sort: 'sort' '=' sortPropertyName ( ',' sortPropertyName )*;
 
-page: 'page' '[' ( 'limit' | 'offset' ) ']' '=' INT;
+page: 'page' '[' ( 'limit' | 'offset' ) ']' '=' pageValue;
 
 include: 'include' '=' propertyName ( ',' propertyName )*;
 
@@ -28,6 +28,8 @@ attributeValue: (
   | DASH
   | SYMBOLS)+;
 
+pageValue: INT;
+
 // lexer rules in order
 INT: [0-9]+;
 LETTERS: [a-zA-Z]+;