🎨 a few minor improvements to using Generated products (#163)

Author: ianardee

src/main/java/com/mindee/parsing/generated/GeneratedObject.java

@@ -21,9 +21,9 @@ public class GeneratedObject extends HashMap<String, Object> {
   public StringField asStringField() {
     return new StringField(
       (String) this.get("value"),
-      (String) this.get("raw_value"),
+      this.get("raw_value") != null ? (String) this.get("raw_value") : null,
       this.getConfidence(),
-      this.getAsPolygon("polygon"),
+      this.getPolygon(),
       this.getPageId()
     );
   }
@@ -35,7 +35,7 @@ public AmountField asAmountField() {
     return new AmountField(
       (Double) this.get("value"),
       this.getConfidence(),
-      this.getAsPolygon("polygon"),
+      this.getPolygon(),
       this.getPageId()
     );
   }
@@ -47,7 +47,7 @@ public DateField asDateField() {
     return new DateField(
       LocalDate.parse((String) this.get("value")),
       this.getConfidence(),
-      this.getAsPolygon("polygon"),
+      this.getPolygon(),
       this.getPageId()
     );
   }
@@ -61,15 +61,34 @@ public ClassificationField asClassificationField() {
     );
   }
 
+  /**
+   * Get the polygon, if present.
+   */
+  public Polygon getPolygon() {
+    return this.getAsPolygon("polygon");
+  }
+
+  /**
+   * Get the specified key as a {@link Polygon} object.
+   */
   public Polygon getAsPolygon(String key) {
-    return PolygonUtils.getFrom((List<List<Double>>) this.get(key));
+    if (this.containsKey(key)) {
+      return PolygonUtils.getFrom((List<List<Double>>) this.get(key));
+    }
+    return null;
   }
 
+  /**
+   * Get the page ID, if present.
+   */
   public Integer getPageId() {
-    return (Integer) this.get("page_id");
+    return this.get("page_id") != null ? (Integer) this.get("page_id") : null;
   }
 
+  /**
+   * Get the confidence score, if present.
+   */
   public Double getConfidence() {
-    return (Double) this.get("confidence");
+    return this.get("confidence") != null ? (Double) this.get("confidence") : null;
   }
 }

src/test/java/com/mindee/product/generated/GeneratedV1Test.java

@@ -54,6 +54,8 @@ void whenAsyncCompleteDeserialized_mustHaveValidProperties() throws IOException
 
     Map<String, GeneratedFeature> features = docPrediction.getFields();
 
+    // Direct access to the hashmap
+
     Assertions.assertFalse(features.get("address").isList());
     Assertions.assertEquals("AVDA DE MADRID S-N MADRID MADRID", features.get("address").get(0).get("value"));
 
@@ -75,6 +77,24 @@ void whenAsyncCompleteDeserialized_mustHaveValidProperties() throws IOException
     Assertions.assertTrue(features.get("surnames").isList());
     Assertions.assertEquals("ESPAÑOLA", features.get("surnames").get(0).get("value"));
     Assertions.assertEquals("ESPAÑOLA", features.get("surnames").get(1).get("value"));
+
+    // Access as a StringField without raw_value
+    StringField addressField = features.get("address").asStringField();
+    Assertions.assertEquals(
+        "AVDA DE MADRID S-N MADRID MADRID",
+        addressField.getValue()
+    );
+    Assertions.assertNull(addressField.getRawValue());
+    Assertions.assertNull(addressField.getConfidence());
+    Assertions.assertNull(addressField.getPageId());
+    Assertions.assertNull(addressField.getPolygon());
+
+    // Access as a DateField
+    DateField expiryDateField = features.get("expiry_date").asDateField();
+    Assertions.assertEquals(
+      LocalDate.parse("2025-01-01"),
+      expiryDateField.getValue()
+    );
   }
 
   @Test
@@ -120,13 +140,12 @@ void whenSyncCompleteDeserialized_mustHaveValidProperties() throws IOException {
       1,
       customerName.get(0).get("page_id")
     );
-    System.out.println(customerName.get(0).get("polygon").getClass());
     Assertions.assertEquals(
       "Polygon with 4 points.",
       customerName.get(0).getAsPolygon("polygon").toString()
     );
 
-    // Access as a StringField
+    // Access as a StringField with raw_value
     StringField customerNameField = customerName.asStringField();
     Assertions.assertEquals(
       "JIRO DOI",
@@ -140,6 +159,36 @@ void whenSyncCompleteDeserialized_mustHaveValidProperties() throws IOException {
       0.87,
       customerNameField.getConfidence()
     );
+    Assertions.assertEquals(
+      1,
+      customerNameField.getPageId()
+    );
+    Assertions.assertEquals(
+      "Polygon with 4 points.",
+      customerNameField.getPolygon().toString()
+    );
+
+    // Access as a StringField without raw_value
+    StringField supplierAddressField = features.get("supplier_address").asStringField();
+    Assertions.assertEquals(
+      "156 University Ave, Toronto ON, Canada M5H 2H7",
+      supplierAddressField.getValue()
+    );
+    Assertions.assertNull(
+      supplierAddressField.getRawValue()
+    );
+    Assertions.assertEquals(
+      0.53,
+      supplierAddressField.getConfidence()
+    );
+    Assertions.assertEquals(
+      1,
+      supplierAddressField.getPageId()
+    );
+    Assertions.assertEquals(
+      "Polygon with 4 points.",
+      supplierAddressField.getPolygon().toString()
+    );
 
     // Access as an AmountField
     AmountField totalAmountField = features.get("total_amount").asAmountField();