add crop classes

Author: ianardee

src/main/java/com/mindee/v2/product/crop/CropInference.java

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

src/main/java/com/mindee/v2/product/crop/CropItem.java

@@ -0,0 +1,36 @@
+package com.mindee.v2.product.crop;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.mindee.parsing.v2.field.FieldLocation;
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+/**
+ * Result of a cropped document region.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public class CropItem {
+  /**
+   * Type or classification of the detected object.
+   */
+  @JsonProperty("object_type")
+  private String objectType;
+  /**
+   * Location which includes cropping coordinates for the detected object, within the source
+   * document.
+   */
+  @JsonProperty("location")
+  private FieldLocation location;
+
+  @Override
+  public String toString() {
+    return "* :Location: " + location + "\n  :Object Type: " + objectType;
+  }
+}

src/main/java/com/mindee/v2/product/crop/CropResponse.java

@@ -0,0 +1,20 @@
+package com.mindee.v2.product.crop;
+
+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 CropResponse extends CommonResponse {
+
+  /**
+   * The inference result for a crop utility request.
+   */
+  @JsonProperty("inference")
+  private CropInference inference;
+}

src/main/java/com/mindee/v2/product/crop/CropResult.java

@@ -0,0 +1,36 @@
+package com.mindee.v2.product.crop;
+
+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 a crop utility inference.
+ */
+@Getter
+@EqualsAndHashCode
+@JsonIgnoreProperties(ignoreUnknown = true)
+@AllArgsConstructor
+@NoArgsConstructor
+public final class CropResult {
+  /**
+   * List of objects and their cropping coordinates identified in the source document.
+   */
+  @JsonProperty("crops")
+  private ArrayList<CropItem> crops;
+
+  @Override
+  public String toString() {
+    StringJoiner joiner = new StringJoiner("\n");
+    joiner.add("Crops").add("=====");
+    for (CropItem item : this.crops) {
+      joiner.add(item.toString());
+    }
+    return joiner.toString();
+  }
+}

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

@@ -19,7 +19,7 @@ private ClassificationResponse loadResponse(String filePath) throws IOException
   }
 
   @Nested
-  @DisplayName("Classification with single value")
+  @DisplayName("Result with single value")
   class SinglePredictionTest {
     @Test
     @DisplayName("all properties must be valid")

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

@@ -0,0 +1,86 @@
+package com.mindee.v2.product;
+
+import static com.mindee.TestingUtilities.assertStringEqualsFile;
+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.crop.CropItem;
+import com.mindee.v2.product.crop.CropResponse;
+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 - Crop Model Tests")
+public class CropTest {
+  private CropResponse loadResponse(String filePath) throws IOException {
+    LocalResponse localResponse = new LocalResponse(getV2ResourcePath(filePath));
+    return localResponse.deserializeResponse(CropResponse.class);
+  }
+
+  @Nested
+  @DisplayName("Result with single value")
+  class SinglePredictionTest {
+    @Test
+    @DisplayName("all properties must be valid")
+    void mustHaveValidProperties() throws IOException {
+      CropResponse response = loadResponse("products/crop/crop_single.json");
+      assertNotNull(response.getInference());
+
+      ArrayList<CropItem> crops = response.getInference().getResult().getCrops();
+      assertEquals(1, crops.size());
+
+      CropItem crop1 = crops.get(0);
+      assertEquals("invoice", crop1.getObjectType());
+      assertNotNull(crop1.getLocation().getPolygon());
+      assertEquals(0, crop1.getLocation().getPage());
+    }
+
+    @Test
+    @DisplayName("RST output must be valid")
+    void mustHaveValidDisplay() throws IOException {
+      CropResponse response = loadResponse("products/crop/crop_single.json");
+      assertStringEqualsFile(
+        response.getInference().toString(),
+        getV2ResourcePath("products/crop/crop_single.rst")
+      );
+    }
+  }
+
+  @Nested
+  @DisplayName("Result with multiple values")
+  class MultiPredictionTest {
+    @Test
+    @DisplayName("all properties must be valid")
+    void mustHaveValidProperties() throws IOException {
+      CropResponse response = loadResponse("products/crop/crop_multiple.json");
+      assertNotNull(response.getInference());
+
+      ArrayList<CropItem> crops = response.getInference().getResult().getCrops();
+      assertEquals(2, crops.size());
+
+      CropItem crop1 = crops.get(0);
+      assertEquals("invoice", crop1.getObjectType());
+      assertNotNull(crop1.getLocation().getPolygon());
+      assertEquals(0, crop1.getLocation().getPage());
+
+      CropItem crop2 = crops.get(1);
+      assertEquals("invoice", crop2.getObjectType());
+      assertNotNull(crop2.getLocation().getPolygon());
+      assertEquals(0, crop2.getLocation().getPage());
+    }
+
+    @Test
+    @DisplayName("RST output must be valid")
+    void mustHaveValidDisplay() throws IOException {
+      CropResponse response = loadResponse("products/crop/crop_multiple.json");
+      assertStringEqualsFile(
+        response.getInference().toString(),
+        getV2ResourcePath("products/crop/crop_multiple.rst")
+      );
+    }
+  }
+}