Introduce totals field in the visualization Bucket

Author: peter-plochan

gooddata-java-model/src/main/java/com/gooddata/sdk/model/md/visualization/Bucket.java

@@ -11,8 +11,10 @@
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.gooddata.sdk.model.executeafm.afm.LocallyIdentifiable;
+import com.gooddata.sdk.model.executeafm.resultspec.TotalItem;
 
 import java.io.Serializable;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 
@@ -26,17 +28,33 @@ public class Bucket implements Serializable, LocallyIdentifiable {
     private static final long serialVersionUID = -7718720886547680021L;
     private final String localIdentifier;
     private final List<BucketItem> items;
+    private final List<TotalItem> totals;
+
+    /**
+     * Creates new instance of bucket without totals
+     *
+     * @param localIdentifier local identifier of bucket
+     * @param items           list of {@link BucketItem}s for this bucket
+     */
+    public Bucket(@JsonProperty("localIdentifier") final String localIdentifier,
+            @JsonProperty("items") final List<BucketItem> items) {
+        this(localIdentifier, items, null);
+    }
 
     /**
      * Creates new instance of bucket
+     *
      * @param localIdentifier local identifier of bucket
-     * @param items list of {@link BucketItem}s for this bucket
+     * @param items           list of {@link BucketItem}s for this bucket
+     * @param totals          list of {@link TotalItem}s for this bucket
      */
     @JsonCreator
     public Bucket(@JsonProperty("localIdentifier") final String localIdentifier,
-                  @JsonProperty("items") final List<BucketItem> items) {
+            @JsonProperty("items") final List<BucketItem> items,
+            @JsonProperty("totals") List<TotalItem> totals) {
         this.localIdentifier = localIdentifier;
         this.items = items;
+        this.totals = totals;
     }
 
     /**
@@ -53,6 +71,13 @@ public List<BucketItem> getItems() {
         return items;
     }
 
+    /**
+     * @return list of defined {@link TotalItem}s
+     */
+    public List<TotalItem> getTotals() {
+        return totals;
+    }
+
     @JsonIgnore
     VisualizationAttribute getOnlyAttribute() {
         if (getItems() != null && getItems().size() == 1) {
@@ -67,15 +92,18 @@ VisualizationAttribute getOnlyAttribute() {
 
     @Override
     public boolean equals(Object o) {
-        if (this == o) return true;
-        if (o == null || getClass() != o.getClass()) return false;
+        if (this == o)
+            return true;
+        if (o == null || getClass() != o.getClass())
+            return false;
         Bucket bucket = (Bucket) o;
-        return Objects.equals(localIdentifier, bucket.localIdentifier) &&
-                Objects.equals(items, bucket.items);
+        return Objects.equals(localIdentifier, bucket.localIdentifier)
+                && Objects.equals(items, bucket.items)
+                && Objects.equals(totals, bucket.totals);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(localIdentifier, items);
+        return Objects.hash(localIdentifier, items, totals);
     }
 }

gooddata-java-model/src/main/java/com/gooddata/sdk/model/md/visualization/VisualizationObject.java

@@ -24,6 +24,7 @@
 import com.gooddata.sdk.model.executeafm.Execution;
 import com.gooddata.sdk.model.executeafm.afm.filter.ExtendedFilter;
 import com.gooddata.sdk.model.executeafm.resultspec.ResultSpec;
+import com.gooddata.sdk.model.executeafm.resultspec.TotalItem;
 import com.gooddata.sdk.model.md.AbstractObj;
 import com.gooddata.sdk.model.md.Meta;
 import com.gooddata.sdk.model.md.Queryable;
@@ -77,6 +78,14 @@ public List<Measure> getMeasures() {
         return content.getMeasures();
     }
 
+    /**
+     * @return all totals from all buckets in visualization object
+     */
+    @JsonIgnore
+    public List<TotalItem> getTotals() {
+        return content.getTotals();
+    }
+
     /**
      * Get measure by local identifier or null if not found
      * @param localIdentifier of measure
@@ -391,6 +400,14 @@ public List<Measure> getMeasures() {
                     .collect(toList());
         }
 
+        @JsonIgnore
+        public List<TotalItem> getTotals() {
+            return buckets.stream()
+                    .filter(bucket -> bucket.getTotals() != null)
+                    .flatMap(bucket -> bucket.getTotals().stream())
+                    .collect(toList());
+        }
+
         @JsonIgnore
         public String getVisualizationClassUri() {
             return visualizationClass.getUri();

gooddata-java-model/src/test/groovy/com/gooddata/sdk/model/md/visualization/BucketTest.groovy

@@ -6,6 +6,8 @@
 package com.gooddata.sdk.model.md.visualization
 
 import com.gooddata.sdk.model.executeafm.UriObjQualifier
+import com.gooddata.sdk.model.executeafm.resultspec.TotalItem
+import com.gooddata.sdk.model.md.report.Total
 import nl.jqno.equalsverifier.EqualsVerifier
 import org.apache.commons.lang3.SerializationUtils
 import spock.lang.Shared
@@ -18,6 +20,7 @@ import static spock.util.matcher.HamcrestSupport.that
 class BucketTest extends Specification {
     private static final String NO_ITEMS_BUCKET = "md/visualization/noItemsBucket.json"
     private static final String MIXED_BUCKET = "md/visualization/mixedBucket.json"
+    private static final String MIXED_BUCKET_WITH_TOTALS = "md/visualization/mixedBucketWithTotals.json"
     private static final String ATTRIBUTE_BUCKET = "md/visualization/attributeBucket.json"
     private static final String MEASURE_BUCKET = "md/visualization/measureBucket.json"
     private static final String MULTIPLE_ATTRIBUTES_BUCKET = "md/visualization/multipleAttributesBucket.json"
@@ -32,19 +35,41 @@ class BucketTest extends Specification {
         that new Bucket("noItems", new ArrayList<BucketItem>()), jsonEquals(noItemsBucket)
     }
 
-    @SuppressWarnings("GrDeprecatedAPIUsage")
     def "should serialize full"() {
         expect:
-        that new Bucket("attributeBucket", [
-                new VisualizationAttribute(new UriObjQualifier("/uri/to/displayForm"), "attribute", "Attribute Alias"),
-                new Measure(
-                        new VOSimpleMeasureDefinition(new UriObjQualifier("/uri/to/measure"), "sum", false, []),
-                        "measure",
-                        "Measure Alias",
-                        "Measure",
-                        null
-                )
-        ]), jsonEquals(mixedBucket)
+        that new Bucket(
+                "attributeBucket",
+                [
+                        new VisualizationAttribute(new UriObjQualifier("/uri/to/displayForm"), "attribute", "Attribute Alias"),
+                        new Measure(
+                                new VOSimpleMeasureDefinition(new UriObjQualifier("/uri/to/measure"), "sum", false, []),
+                                "measure",
+                                "Measure Alias",
+                                "Measure",
+                                null
+                        )
+                ] as List<BucketItem>
+        ), jsonEquals(mixedBucket)
+    }
+
+    def "should serialize full with totals"() {
+        expect:
+        that new Bucket(
+                "attributeBucket",
+                [
+                        new VisualizationAttribute(new UriObjQualifier("/uri/to/displayForm"), "attribute", "Attribute Alias"),
+                        new Measure(
+                                new VOSimpleMeasureDefinition(new UriObjQualifier("/uri/to/measure"), "sum", false, []),
+                                "measure",
+                                "Measure Alias",
+                                "Measure",
+                                null
+                        )
+                ] as List<BucketItem>,
+                [
+                        new TotalItem("measure", Total.NAT, "attribute")
+                ]
+        ), jsonEquals(readObjectFromResource("/$MIXED_BUCKET_WITH_TOTALS", Bucket.class))
     }
 
     def "should return only attribute from bucket"() {

gooddata-java-model/src/test/resources/md/visualization/mixedBucketWithTotals.json

@@ -0,0 +1,37 @@
+{
+  "localIdentifier": "attributeBucket",
+  "items": [
+    {
+      "visualizationAttribute": {
+        "localIdentifier": "attribute",
+        "displayForm": {
+          "uri": "/uri/to/displayForm"
+        },
+        "alias": "Attribute Alias"
+      }
+    }, {
+      "measure": {
+        "localIdentifier": "measure",
+        "title": "Measure",
+        "alias": "Measure Alias",
+        "definition": {
+          "measureDefinition": {
+            "item": {
+              "uri": "/uri/to/measure"
+            },
+            "aggregation": "sum",
+            "computeRatio": false,
+            "filters": []
+          }
+        }
+      }
+    }
+  ],
+  "totals": [
+    {
+      "measureIdentifier": "measure",
+      "type": "nat",
+      "attributeIdentifier": "attribute"
+    }
+  ]
+}