Merge pull request #967 from anvuong119/anvuong-sd1212

Add "type" property to AttributeHeader so that the type of a display form can be passed to an AFM execution response

Reviewed-by: Libor Ryšavý
             https://github.com/liry

Author: gdgate

gooddata-java-model/src/main/java/com/gooddata/sdk/model/executeafm/response/AttributeHeader.java

@@ -30,6 +30,7 @@ public class AttributeHeader implements Header, LocallyIdentifiable {
     private final String localIdentifier;
     private final String uri;
     private final String identifier;
+    private final String type;
     private final AttributeInHeader formOf;
 
     private List<TotalHeaderItem> totalItems;
@@ -55,17 +56,38 @@ public AttributeHeader(final String name, final String localIdentifier, final St
      * @param formOf info about attribute which this header's display form is form of
      * @param totalHeaderItems total header items
      */
+    public AttributeHeader(@JsonProperty("name") final String name,
+                           @JsonProperty("localIdentifier") final String localIdentifier,
+                           @JsonProperty("uri") final String uri,
+                           @JsonProperty("identifier") final String identifier,
+                           @JsonProperty("formOf") final AttributeInHeader formOf,
+                           @JsonProperty("totalItems") final List<TotalHeaderItem> totalHeaderItems) {
+        this(name, localIdentifier, uri, identifier, null, formOf, totalHeaderItems);
+    }
+
+    /**
+     * Creates new header
+     * @param name name
+     * @param localIdentifier local identifier
+     * @param uri uri
+     * @param identifier identifier
+     * @param type type
+     * @param formOf info about attribute which this header's display form is form of
+     * @param totalHeaderItems total header items
+     */
     @JsonCreator
     public AttributeHeader(@JsonProperty("name") final String name,
                            @JsonProperty("localIdentifier") final String localIdentifier,
                            @JsonProperty("uri") final String uri,
                            @JsonProperty("identifier") final String identifier,
+                           @JsonProperty("type") final String type,
                            @JsonProperty("formOf") final AttributeInHeader formOf,
                            @JsonProperty("totalItems") final List<TotalHeaderItem> totalHeaderItems) {
         this.name = notEmpty(name, "name");
         this.localIdentifier = notEmpty(localIdentifier, "localIdentifier");
         this.uri = notEmpty(uri, "uri");
         this.identifier = notEmpty(identifier, "identifier");
+        this.type = type;
         this.formOf = notNull(formOf, "formOf");
         this.totalItems = totalHeaderItems;
     }
@@ -104,6 +126,14 @@ public String getIdentifier() {
         return identifier;
     }
 
+    /**
+     * Metadata type of attribute's display form
+     * @return type
+     */
+    public String getType() {
+        return type;
+    }
+
     public AttributeInHeader getFormOf() {
         return formOf;
     }

gooddata-java-model/src/test/groovy/com/gooddata/sdk/model/executeafm/response/AttributeHeaderTest.groovy

@@ -15,16 +15,23 @@ import static spock.util.matcher.HamcrestSupport.that
 class AttributeHeaderTest extends Specification {
 
     private static final String ATTRIBUTE_HEADER_JSON = 'executeafm/response/attributeHeader.json'
+    private static final String ATTRIBUTE_HEADER_EXCEPT_TYPE_JSON = 'executeafm/response/attributeHeaderExceptType.json'
     private static final String ATTRIBUTE_HEADER_FULL_JSON = 'executeafm/response/attributeHeaderFull.json'
 
     private static final AttributeInHeader FORM_OF = new AttributeInHeader('Some attr', '/gdc/md/project_id/obj/567', 'attr.some.id')
 
     def "should serialize full"() {
         expect:
-        that new AttributeHeader('Name', 'a1', '/gdc/md/project_id/obj/123', 'attr.dataset.name', FORM_OF, [new TotalHeaderItem('sum')]),
+        that new AttributeHeader('Name', 'a1', '/gdc/md/project_id/obj/123', 'attr.dataset.name', 'GDC.time.day_us', FORM_OF, [new TotalHeaderItem('sum')]),
                 jsonEquals(resource(ATTRIBUTE_HEADER_FULL_JSON))
     }
 
+    def "should serialize except type"() {
+        expect:
+        that new AttributeHeader('Name', 'a1', '/gdc/md/project_id/obj/123', 'attr.dataset.name', FORM_OF, [new TotalHeaderItem('sum')]),
+                jsonEquals(resource(ATTRIBUTE_HEADER_EXCEPT_TYPE_JSON))
+    }
+
     def "should serialize"() {
         expect:
         that new AttributeHeader('Name', 'a1', '/gdc/md/project_id/obj/123', 'attr.dataset.name', FORM_OF),
@@ -43,6 +50,22 @@ class AttributeHeaderTest extends Specification {
         header.formOf == FORM_OF
     }
 
+    def "should deserialize except type"() {
+        when:
+        AttributeHeader header = readObjectFromResource("/$ATTRIBUTE_HEADER_EXCEPT_TYPE_JSON", AttributeHeader)
+
+        then:
+        header.name == 'Name'
+        header.localIdentifier == 'a1'
+        header.uri == '/gdc/md/project_id/obj/123'
+        header.identifier == 'attr.dataset.name'
+        header.type == null
+        header.formOf == FORM_OF
+        header.totalItems.size() == 1
+        header.totalItems.first().name == 'sum'
+        header.toString()
+    }
+
     def "should deserialize full"() {
         when:
         AttributeHeader header = readObjectFromResource("/$ATTRIBUTE_HEADER_FULL_JSON", AttributeHeader)
@@ -52,6 +75,7 @@ class AttributeHeaderTest extends Specification {
         header.localIdentifier == 'a1'
         header.uri == '/gdc/md/project_id/obj/123'
         header.identifier == 'attr.dataset.name'
+        header.type == 'GDC.time.day_us'
         header.formOf == FORM_OF
         header.totalItems.size() == 1
         header.totalItems.first().name == 'sum'

gooddata-java-model/src/test/resources/executeafm/response/attributeHeaderExceptType.json

@@ -0,0 +1,20 @@
+{
+  "attributeHeader": {
+    "name": "Name",
+    "localIdentifier": "a1",
+    "uri": "/gdc/md/project_id/obj/123",
+    "identifier": "attr.dataset.name",
+    "formOf": {
+      "name": "Some attr",
+      "uri": "/gdc/md/project_id/obj/567",
+      "identifier": "attr.some.id"
+    },
+    "totalItems": [
+      {
+        "totalHeaderItem": {
+          "name": "sum"
+        }
+      }
+    ]
+  }
+}

gooddata-java-model/src/test/resources/executeafm/response/attributeHeaderFull.json

@@ -4,6 +4,7 @@
     "localIdentifier": "a1",
     "uri": "/gdc/md/project_id/obj/123",
     "identifier": "attr.dataset.name",
+    "type": "GDC.time.day_us",
     "formOf": {
       "name": "Some attr",
       "uri": "/gdc/md/project_id/obj/567",