Merge branch '268-new-externalpropertytype-jsontonative' into 'dev'

greenrobot-team · greenrobot-team · commit 1ffb9a38515c · 2025-05-13T12:12:42.000+02:00
Support new external type JsonToNative #268 See merge request objectbox/objectbox-java!157
diff --git a/objectbox-java-api/src/main/java/io/objectbox/annotation/ExternalPropertyType.java b/objectbox-java-api/src/main/java/io/objectbox/annotation/ExternalPropertyType.java
@@ -112,6 +112,21 @@ public enum ExternalPropertyType {
      * Representing type: String
      */
     JAVASCRIPT,
+    /**
+     * A JSON string that is converted to a native "complex" representation in the external system.
+     * <p>
+     * For example in MongoDB, embedded/nested documents are converted to a JSON string in ObjectBox and vice versa.
+     * This allows a quick and simple way to work with non-normalized data from MongoDB in ObjectBox. Alternatively, you
+     * can use {@link #FLEX_MAP} and {@link #FLEX_VECTOR} to map to language primitives (e.g. maps with string keys; not
+     * supported by all ObjectBox languages yet).
+     * <p>
+     * For MongoDB, (nested) documents and arrays are supported.
+     * <p>
+     * Note that this is very close to the internal representation, e.g. the key order is preserved (unlike Flex).
+     * <p>
+     * Representing type: String
+     */
+    JSON_TO_NATIVE,
     /**
      * A vector (array) of Int128 values.
      */
diff --git a/objectbox-java/src/main/java/io/objectbox/model/ExternalPropertyType.java b/objectbox-java/src/main/java/io/objectbox/model/ExternalPropertyType.java
@@ -100,7 +100,17 @@ private ExternalPropertyType() { }
    * Representing type: String
    */
   public static final short JavaScript = 111;
-  public static final short Reserved5 = 112;
+  /**
+   * A JSON string that is converted to a native "complex" representation in the external system.
+   * For example in MongoDB, embedded/nested documents are converted to a JSON string in ObjectBox and vice versa.
+   * This allows a quick and simple way to work with non-normalized data from MongoDB in ObjectBox.
+   * Alternatively, you can use FlexMap and FlexVector to map to language primitives (e.g. maps with string keys;
+   * not supported by all ObjectBox languages yet).
+   * For MongoDB, (nested) documents and arrays are supported.
+   * Note that this is very close to the internal representation, e.g. the key order is preserved (unlike Flex).
+   * Representing type: String
+   */
+  public static final short JsonToNative = 112;
   public static final short Reserved6 = 113;
   public static final short Reserved7 = 114;
   public static final short Reserved8 = 115;
@@ -110,7 +120,7 @@ private ExternalPropertyType() { }
   public static final short Int128Vector = 116;
   public static final short Reserved9 = 117;
   /**
-   * A vector (array) of Int128 values
+   * A vector (array) of UUID values
    */
   public static final short UuidVector = 118;
   public static final short Reserved10 = 119;
@@ -144,7 +154,7 @@ private ExternalPropertyType() { }
    */
   public static final short MongoRegex = 127;
 
-  public static final String[] names = { "Unknown", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "Int128", "Reserved1", "Uuid", "Decimal128", "UuidString", "UuidV4", "UuidV4String", "FlexMap", "FlexVector", "Json", "Bson", "JavaScript", "Reserved5", "Reserved6", "Reserved7", "Reserved8", "Int128Vector", "Reserved9", "UuidVector", "Reserved10", "Reserved11", "Reserved12", "Reserved13", "MongoId", "MongoIdVector", "MongoTimestamp", "MongoBinary", "MongoRegex", };
+  public static final String[] names = { "Unknown", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "Int128", "Reserved1", "Uuid", "Decimal128", "UuidString", "UuidV4", "UuidV4String", "FlexMap", "FlexVector", "Json", "Bson", "JavaScript", "JsonToNative", "Reserved6", "Reserved7", "Reserved8", "Int128Vector", "Reserved9", "UuidVector", "Reserved10", "Reserved11", "Reserved12", "Reserved13", "MongoId", "MongoIdVector", "MongoTimestamp", "MongoBinary", "MongoRegex", };
 
   public static String name(int e) { return names[e]; }
 }
diff --git a/tests/objectbox-java-test/src/main/java/io/objectbox/TestEntity.java b/tests/objectbox-java-test/src/main/java/io/objectbox/TestEntity.java
@@ -76,9 +76,13 @@ public class TestEntity {
     private float[] floatArray;
     private double[] doubleArray;
     private Date date;
-    // Just smoke testing, also use UUID instead of the default Mongo ID
+    // Just smoke testing this property type (tests do not use Sync).
+    // Also use UUID instead of the default MONGO_ID.
     @ExternalType(ExternalPropertyType.UUID)
     private byte[] externalId;
+    // Just smoke testing this property type (tests do not use Sync).
+    @ExternalType(ExternalPropertyType.JSON_TO_NATIVE)
+    private String externalJsonToNative;
 
     transient boolean noArgsConstructorCalled;
 
@@ -115,7 +119,8 @@ public TestEntity(long id,
                       float[] floatArray,
                       double[] doubleArray,
                       Date date,
-                      byte[] externalId
+                      byte[] externalId,
+                      String externalJsonToNative
     ) {
         this.id = id;
         this.simpleBoolean = simpleBoolean;
@@ -143,6 +148,7 @@ public TestEntity(long id,
         this.doubleArray = doubleArray;
         this.date = date;
         this.externalId = externalId;
+        this.externalJsonToNative = externalJsonToNative;
         if (STRING_VALUE_THROW_IN_CONSTRUCTOR.equals(simpleString)) {
             throw new RuntimeException(EXCEPTION_IN_CONSTRUCTOR_MESSAGE);
         }
@@ -370,6 +376,15 @@ public void setExternalId(@Nullable byte[] externalId) {
         this.externalId = externalId;
     }
 
+    @Nullable
+    public String getExternalJsonToNative() {
+        return externalJsonToNative;
+    }
+
+    public void setExternalJsonToNative(@Nullable String externalJsonToNative) {
+        this.externalJsonToNative = externalJsonToNative;
+    }
+
     @Override
     public String toString() {
         return "TestEntity{" +
@@ -399,6 +414,7 @@ public String toString() {
                 ", doubleArray=" + Arrays.toString(doubleArray) +
                 ", date=" + date +
                 ", externalId=" + Arrays.toString(externalId) +
+                ", externalJsonToString='" + externalJsonToNative + '\'' +
                 ", noArgsConstructorCalled=" + noArgsConstructorCalled +
                 '}';
     }
diff --git a/tests/objectbox-java-test/src/main/java/io/objectbox/TestEntityCursor.java b/tests/objectbox-java-test/src/main/java/io/objectbox/TestEntityCursor.java
@@ -75,6 +75,7 @@ public Cursor<TestEntity> createCursor(io.objectbox.Transaction tx, long cursorH
     private final static int __ID_doubleArray = TestEntity_.doubleArray.id;
     private final static int __ID_date = TestEntity_.date.id;
     private final static int __ID_externalId = TestEntity_.externalId.id;
+    private final static int __ID_externalJsonToNative = TestEntity_.externalJsonToNative.id;
 
     public TestEntityCursor(io.objectbox.Transaction tx, long cursor, BoxStore boxStore) {
         super(tx, cursor, TestEntity_.__INSTANCE, boxStore);
@@ -149,6 +150,8 @@ public long put(TestEntity entity) {
 
         String simpleString = entity.getSimpleString();
         int __id8 = simpleString != null ? __ID_simpleString : 0;
+        String externalJsonToNative = entity.getExternalJsonToNative();
+        int __id26 = externalJsonToNative != null ? __ID_externalJsonToNative : 0;
         byte[] simpleByteArray = entity.getSimpleByteArray();
         int __id9 = simpleByteArray != null ? __ID_simpleByteArray : 0;
         byte[] externalId = entity.getExternalId();
@@ -157,7 +160,7 @@ public long put(TestEntity entity) {
         int __id15 = stringObjectMap != null ? __ID_stringObjectMap : 0;
 
         collect430000(cursor, 0, 0,
-                __id8, simpleString, 0, null,
+                __id8, simpleString, __id26, externalJsonToNative,
                 0, null, 0, null,
                 __id9, simpleByteArray, __id25, externalId,
                 __id15, __id15 != 0 ? stringObjectMapConverter.convertToDatabaseValue(stringObjectMap) : null);
diff --git a/tests/objectbox-java-test/src/main/java/io/objectbox/TestEntity_.java b/tests/objectbox-java-test/src/main/java/io/objectbox/TestEntity_.java
@@ -130,6 +130,9 @@ public final class TestEntity_ implements EntityInfo<TestEntity> {
     public final static io.objectbox.Property<TestEntity> externalId =
             new io.objectbox.Property<>(__INSTANCE, 25, 25, byte[].class, "externalId");
 
+    public final static io.objectbox.Property<TestEntity> externalJsonToNative =
+            new io.objectbox.Property<>(__INSTANCE, 26, 27, String.class, "externalJsonToNative");
+
     @SuppressWarnings("unchecked")
     public final static io.objectbox.Property<TestEntity>[] __ALL_PROPERTIES = new io.objectbox.Property[]{
             id,
@@ -157,7 +160,8 @@ public final class TestEntity_ implements EntityInfo<TestEntity> {
             floatArray,
             doubleArray,
             date,
-            externalId
+            externalId,
+            externalJsonToNative
     };
 
     public final static io.objectbox.Property<TestEntity> __ID_PROPERTY = id;
diff --git a/tests/objectbox-java-test/src/test/java/io/objectbox/AbstractObjectBoxTest.java b/tests/objectbox-java-test/src/test/java/io/objectbox/AbstractObjectBoxTest.java
@@ -305,13 +305,14 @@ private void addTestEntity(ModelBuilder modelBuilder, @Nullable IndexType simple
         // Date property
         entityBuilder.property("date", PropertyType.Date).id(TestEntity_.date.id, ++lastUid);
 
-        int lastId = TestEntity_.externalId.id;
-
         // External type property
         // Note: there is no way to test external type mapping works here. Instead, verify passing a model with
         // externalType(int) works.
-        entityBuilder.property("externalId", PropertyType.ByteVector).id(lastId, ++lastUid)
+        entityBuilder.property("externalId", PropertyType.ByteVector).id(TestEntity_.externalId.id, ++lastUid)
                 .externalType(ExternalPropertyType.Uuid);
+        int lastId = TestEntity_.externalJsonToNative.id;
+        entityBuilder.property("externalJsonToNative", PropertyType.String).id(lastId, ++lastUid)
+                .externalType(ExternalPropertyType.JsonToNative);
 
         entityBuilder.lastPropertyId(lastId, lastUid);
         addOptionalFlagsToTestEntity(entityBuilder);
@@ -377,6 +378,7 @@ protected TestEntity createTestEntity(@Nullable String simpleString, int nr) {
         // Note: there is no way to test external type mapping works here. Instead, verify that
         // there are no side effects for put and get.
         entity.setExternalId(simpleByteArray);
+        entity.setExternalJsonToNative("{\"simpleString\":\"" + simpleString + "\"}");
         return entity;
     }
 
diff --git a/tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreBuilderTest.java b/tests/objectbox-java-test/src/test/java/io/objectbox/BoxStoreBuilderTest.java
@@ -302,7 +302,7 @@ public void maxDataSize() {
                 DbMaxDataSizeExceededException.class,
                 () -> getTestEntityBox().put(testEntity2)
         );
-        assertEquals("Exceeded user-set maximum by [bytes]: 592", maxDataExc.getMessage());
+        assertEquals("Exceeded user-set maximum by [bytes]: 768", maxDataExc.getMessage());
 
         // Remove to get below max data size, then put again.
         getTestEntityBox().remove(testEntity1);
diff --git a/tests/objectbox-java-test/src/test/java/io/objectbox/BoxTest.java b/tests/objectbox-java-test/src/test/java/io/objectbox/BoxTest.java
@@ -90,6 +90,7 @@ public void testPutAndGet() {
         assertArrayEquals(new double[]{-valDouble, valDouble}, entity.getDoubleArray(), 0);
         assertEquals(new Date(1000 + simpleInt), entity.getDate());
         assertArrayEquals(valByteArray, entity.getExternalId());
+        assertEquals("{\"simpleString\":\"" + simpleString + "\"}", entity.getExternalJsonToNative());
     }
 
     @Test
@@ -122,6 +123,7 @@ public void testPutAndGet_defaultOrNullValues() {
         assertNull(defaultEntity.getDoubleArray());
         assertNull(defaultEntity.getDate());
         assertNull(defaultEntity.getExternalId());
+        assertNull(defaultEntity.getExternalJsonToNative());
     }
 
     // Note: There is a similar test using the Cursor API directly (which is deprecated) in CursorTest.

Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,7 @@ public void testPutAndGet() {`
`90`	`90`	`assertArrayEquals(new double[]{-valDouble, valDouble}, entity.getDoubleArray(), 0);`
`91`	`91`	`assertEquals(new Date(1000 + simpleInt), entity.getDate());`
`92`	`92`	`assertArrayEquals(valByteArray, entity.getExternalId());`
	`93`	`+ assertEquals("{\"simpleString\":\"" + simpleString + "\"}", entity.getExternalJsonToNative());`
`93`	`94`	`}`
`94`	`95`
`95`	`96`	`@Test`
`@@ -122,6 +123,7 @@ public void testPutAndGet_defaultOrNullValues() {`
`122`	`123`	`assertNull(defaultEntity.getDoubleArray());`
`123`	`124`	`assertNull(defaultEntity.getDate());`
`124`	`125`	`assertNull(defaultEntity.getExternalId());`
	`126`	`+ assertNull(defaultEntity.getExternalJsonToNative());`
`125`	`127`	`}`
`126`	`128`
`127`	`129`	`// Note: There is a similar test using the Cursor API directly (which is deprecated) in CursorTest.`