Implemented DatabaseField annotation parameter that allows to specify more java side field than in postgres type

Author: Maciej Rosiek

database/test/21_shard1/21_schema1/03_types/20_partial_object.sql

@@ -0,0 +1,3 @@
+create type partial_object as (
+    name text
+);

database/test/21_shard1/21_schema1/05_stored_procedures/20_get_partial_object.sql

@@ -0,0 +1,10 @@
+CREATE OR REPLACE FUNCTION get_partial_object(p partial_object)
+RETURNS partial_object AS
+$$
+DECLARE
+    r partial_object;
+BEGIN
+  r.name := p.name;
+  return r;
+END;
+$$ LANGUAGE plpgsql SECURITY DEFINER;

src/main/java/de/zalando/typemapper/annotations/DatabaseField.java

@@ -35,5 +35,4 @@
 
     Class<? extends ObjectMapper<?>> mapper() default DefaultObjectMapper.class;
 
-    boolean optional() default false;
 }

src/main/java/de/zalando/typemapper/annotations/DatabaseType.java

@@ -20,4 +20,10 @@
      * Flattens hierarchical structure of object and makes parent fields exposed to PgTypeHelper.
      */
     boolean inheritance() default false;
+
+    /**
+     * Annotated java class can have more @DatabaseField annotated fields than corresponding database type.
+     */
+    boolean partial() default false;
+
 }

src/main/java/de/zalando/typemapper/core/DatabaseFieldDescriptor.java

@@ -11,21 +11,18 @@ public class DatabaseFieldDescriptor {
     private int position;
     private Class<? extends ValueTransformer<?, ?>> transformer;
     private Class<? extends ObjectMapper<?>> mapper;
-    private boolean optional;
 
     public DatabaseFieldDescriptor(final DatabaseField databaseField) {
         this.name = databaseField.name();
         this.position = databaseField.position();
         this.transformer = databaseField.transformer();
         this.mapper = databaseField.mapper();
-        this.optional = databaseField.optional();
     }
 
     public DatabaseFieldDescriptor(final Column column) {
         this.name = column.name();
         this.position = -1;
         this.transformer = AnyTransformer.class;
-        this.optional = false;
     }
 
     public String getName() {
@@ -44,8 +41,4 @@ public Class<? extends ObjectMapper<?>> getMapper() {
         return mapper;
     }
 
-    public boolean isOptional() {
-        return optional;
-    }
-
 }

src/main/java/de/zalando/typemapper/postgres/PgTypeHelper.java

@@ -314,7 +314,7 @@ public int compare(final Field a, final Field b) {
                         dbField = dbFields.get(dbFieldName);
 
                         if (dbField == null) {
-                            if (!databaseFieldDescriptor.isOptional()) {
+                            if (databaseType == null || !databaseType.partial()) {
                                 throw new IllegalArgumentException("Field " + f.getName() + " (" + dbFieldName
                                         + ") of class " + clazz.getSimpleName()
                                         + " could not be found in database type " + typeName);
@@ -329,7 +329,7 @@ public int compare(final Field a, final Field b) {
                             resultList = new ArrayList<Object>();
                         }
 
-                        if (!databaseFieldDescriptor.isOptional()) {
+                        if (databaseType == null || !databaseType.partial()) {
                             resultList.add(value);
                         }
                     }

src/test/java/de/zalando/sprocwrapper/PartialDatabaseTypeIT.java

@@ -0,0 +1,41 @@
+package de.zalando.sprocwrapper;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import org.junit.runner.RunWith;
+
+import org.springframework.beans.factory.annotation.Autowired;
+
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+import de.zalando.sprocwrapper.example.ExampleSProcService;
+import de.zalando.sprocwrapper.example.NotPartialObject;
+import de.zalando.sprocwrapper.example.PartialObject;
+
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(locations = {"classpath:backendContextTest.xml"})
+public class PartialDatabaseTypeIT {
+
+    @Autowired
+    private ExampleSProcService exampleSProcService;
+
+    @Test
+    public void testPartialObject() {
+        PartialObject partialObject = new PartialObject();
+        partialObject.setId(999);
+        partialObject.setName("Test Name");
+
+        PartialObject partialObjectDb = exampleSProcService.getPartialObject(partialObject);
+
+        Assert.assertEquals(0, partialObjectDb.getId());
+        Assert.assertEquals("Test Name", partialObjectDb.getName());
+    }
+
+    @Test(expected = IllegalArgumentException.class)
+    public void testNotPartialObject() {
+        exampleSProcService.getPartialObject(new NotPartialObject());
+    }
+
+}

src/test/java/de/zalando/sprocwrapper/example/ExampleSProcService.java

@@ -279,4 +279,11 @@ int createOrder(@SProcParam String orderNumber, @SProcParam OrderMonetaryAmount
 
     @SProcCall(sql = "SELECT version()")
     String getPostgreSqlVersion();
+
+    @SProcCall
+    PartialObject getPartialObject(@SProcParam PartialObject partialObject);
+
+    @SProcCall
+    PartialObject getPartialObject(@SProcParam NotPartialObject partialObject);
+
 }

src/test/java/de/zalando/sprocwrapper/example/ExampleSProcServiceImpl.java

@@ -443,4 +443,14 @@ public String getValueFromBasicTable(@SProcParam final String key) {
     public String getPostgreSqlVersion() {
         return sproc.getPostgreSqlVersion();
     }
+
+    @Override
+    public PartialObject getPartialObject(final PartialObject partialObject) {
+        return sproc.getPartialObject(partialObject);
+    }
+
+    @Override
+    public PartialObject getPartialObject(final NotPartialObject notPartialObject) {
+        return sproc.getPartialObject(notPartialObject);
+    }
 }

src/test/java/de/zalando/sprocwrapper/example/NotPartialObject.java

@@ -0,0 +1,30 @@
+package de.zalando.sprocwrapper.example;
+
+import de.zalando.typemapper.annotations.DatabaseField;
+import de.zalando.typemapper.annotations.DatabaseType;
+
+@DatabaseType(name = "partial_object")
+public class NotPartialObject {
+
+    @DatabaseField
+    private int id;
+    @DatabaseField
+    private String name;
+
+    public void setId(final int id) {
+        this.id = id;
+    }
+
+    public int getId() {
+        return id;
+    }
+
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+}