add Split classes

Author: ianardee

src/main/java/com/mindee/v2/product/ocr/OcrResult.java

@@ -28,8 +28,8 @@ public final class OcrResult {
   public String toString() {
     StringJoiner joiner = new StringJoiner("\n");
     joiner.add("Pages\n======");
-    for (OcrPage page : pages) {
-      joiner.add(page.toString());
+    for (OcrPage item : pages) {
+      joiner.add(item.toString());
     }
     return joiner.toString();
   }

src/main/java/com/mindee/v2/product/split/SplitInference.java

@@ -0,0 +1,9 @@
+package com.mindee.v2.product.split;
+
+import com.mindee.v2.parsing.BaseInference;
+
+/**
+ * The inference result for a split utility request.
+ */
+public class SplitInference extends BaseInference<SplitResult> {
+}

src/main/java/com/mindee/v2/product/split/SplitRange.java

@@ -0,0 +1,32 @@
+package com.mindee.v2.product.split;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.ArrayList;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * A single document as identified when splitting a multi-document source file.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public class SplitRange {
+  /**
+   * 0-based page indexes, where the first integer indicates the start page and the second integer
+   * indicates the end page.
+   */
+  @JsonProperty("page_range")
+  public ArrayList<Integer> pageRange;
+
+  /**
+   * The document type, as identified on given classification values.
+   */
+  @JsonProperty("document_type")
+  public String documentType;
+}

src/main/java/com/mindee/v2/product/split/SplitResponse.java

@@ -0,0 +1,20 @@
+package com.mindee.v2.product.split;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.mindee.parsing.v2.CommonResponse;
+import lombok.Getter;
+
+/**
+ * Response for a crop utility inference.
+ */
+@Getter
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class SplitResponse extends CommonResponse {
+
+  /**
+   * The inference result for a split utility request.
+   */
+  @JsonProperty("inference")
+  private SplitInference inference;
+}

src/main/java/com/mindee/v2/product/split/SplitResult.java

@@ -0,0 +1,36 @@
+package com.mindee.v2.product.split;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.ArrayList;
+import java.util.StringJoiner;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * Result of the document splitter inference.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public final class SplitResult {
+  /**
+   * List of documents identified within a multi-document source file.
+   */
+  @JsonProperty("splits")
+  private ArrayList<SplitRange> splits;
+
+  @Override
+  public String toString() {
+    StringJoiner joiner = new StringJoiner("\n");
+    joiner.add("Splits\n======");
+    for (SplitRange item : splits) {
+      joiner.add(item.toString());
+    }
+    return joiner.toString();
+  }
+}

src/test/java/com/mindee/v2/product/SplitTest.java

@@ -0,0 +1,64 @@
+package com.mindee.v2.product;
+
+import static com.mindee.TestingUtilities.getV2ResourcePath;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+import com.mindee.input.LocalResponse;
+import com.mindee.v2.product.split.SplitRange;
+import com.mindee.v2.product.split.SplitResponse;
+import java.io.IOException;
+import java.util.ArrayList;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
+@DisplayName("MindeeV2 - Split Model Tests")
+public class SplitTest {
+  private SplitResponse loadResponse(String filePath) throws IOException {
+    LocalResponse localResponse = new LocalResponse(getV2ResourcePath(filePath));
+    return localResponse.deserializeResponse(SplitResponse.class);
+  }
+
+  @Nested
+  @DisplayName("Result with single value")
+  class SinglePredictionTest {
+    @Test
+    @DisplayName("all properties must be valid")
+    void mustHaveValidProperties() throws IOException {
+      SplitResponse response = loadResponse("products/split/split_single.json");
+      assertNotNull(response.getInference());
+
+      ArrayList<SplitRange> splits = response.getInference().getResult().getSplits();
+      assertEquals(1, splits.size());
+      assertEquals("receipt", splits.get(0).getDocumentType());
+      assertEquals(0, splits.get(0).getPageRange().get(0));
+    }
+  }
+
+  @Nested
+  @DisplayName("Result with multiple values")
+  class MultiPredictionTest {
+    @Test
+    @DisplayName("all properties must be valid")
+    void mustHaveValidProperties() throws IOException {
+      SplitResponse response = loadResponse("products/split/split_multiple.json");
+      assertNotNull(response.getInference());
+
+      ArrayList<SplitRange> splits = response.getInference().getResult().getSplits();
+      assertEquals(3, splits.size());
+
+      SplitRange split1 = splits.get(0);
+      assertEquals("invoice", split1.getDocumentType());
+      assertEquals(0, split1.getPageRange().get(0));
+
+      SplitRange split2 = splits.get(1);
+      assertEquals("invoice", split2.getDocumentType());
+      assertEquals(1, split2.getPageRange().get(0));
+
+      SplitRange split3 = splits.get(2);
+      assertEquals("invoice", split3.getDocumentType());
+      assertEquals(4, split3.getPageRange().get(0));
+    }
+  }
+}