Introduce support for offset in PoP measure

Author: xMort

src/main/java/com/gooddata/executeafm/afm/PopMeasureDefinition.java

@@ -1,25 +1,27 @@
 /*
- * Copyright (C) 2007-2017, GoodData(R) Corporation. All rights reserved.
+ * Copyright (C) 2007-2018, GoodData(R) Corporation. All rights reserved.
  * This source code is licensed under the BSD-style license found in the
  * LICENSE.txt file in the root directory of this source tree.
  */
 package com.gooddata.executeafm.afm;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonRootName;
 import com.gooddata.executeafm.ObjQualifier;
 import com.gooddata.executeafm.UriObjQualifier;
 import com.gooddata.util.GoodDataToStringBuilder;
 
 import java.io.Serializable;
-import java.util.Objects;
 
 import static com.gooddata.executeafm.afm.PopMeasureDefinition.NAME;
 
 /**
  * Definition of so called "period over period" measure
  */
 @JsonRootName(NAME)
+@JsonInclude(JsonInclude.Include.NON_NULL)
 public class PopMeasureDefinition implements MeasureDefinition, Serializable {
 
     private static final long serialVersionUID = 1430640153994197345L;
@@ -29,21 +31,46 @@ public class PopMeasureDefinition implements MeasureDefinition, Serializable {
 
     private final ObjQualifier popAttribute;
 
+    private final Integer offset;
+
     /**
-     * Creates new definition from given measure identifier referencing another measure in {@link Afm} and given
-     * attribute qualifier (should qualify date attribute)
-     * @param measureIdentifier measure identifier
-     * @param popAttribute "period over period" date attribute
+     * Creates new definition from given measure identifier referencing another measure in {@link Afm} and given attribute qualifier (should qualify date
+     * attribute)
+     *
+     * @param measureIdentifier
+     *         measure identifier
+     * @param popAttribute
+     *         "period over period" date attribute
+     * @param offset
+     *         the number of periods the time window defined by {@code popAttribute} is offset about to the past (when value is negative) or future (when
+     *         value is positive)
      */
+    @JsonCreator
     public PopMeasureDefinition(@JsonProperty("measureIdentifier") final String measureIdentifier,
-                                @JsonProperty("popAttribute") final ObjQualifier popAttribute) {
+                                @JsonProperty("popAttribute") final ObjQualifier popAttribute,
+                                @JsonProperty("offset") final Integer offset) {
         this.measureIdentifier = measureIdentifier;
         this.popAttribute = popAttribute;
+        this.offset = offset;
+    }
+
+    /**
+     * Creates new definition from given measure identifier referencing another measure in {@link Afm} and given attribute qualifier (should qualify date
+     * attribute)
+     *
+     * @param measureIdentifier
+     *         measure identifier
+     * @param popAttribute
+     *         "period over period" date attribute
+     */
+    public PopMeasureDefinition(final String measureIdentifier,
+                                final ObjQualifier popAttribute) {
+        this(measureIdentifier, popAttribute, null);
     }
 
     @Override
     public MeasureDefinition withObjUriQualifier(final UriObjQualifier qualifier) {
-        return new PopMeasureDefinition(measureIdentifier, qualifier);
+        return new PopMeasureDefinition(measureIdentifier, qualifier, offset);
     }
 
     /**
@@ -62,6 +89,15 @@ public ObjQualifier getPopAttribute() {
         return popAttribute;
     }
 
+    /**
+     * Returns number of periods defined via {@link #popAttribute} time interval.
+     *
+     * @return positive or negative number of periods or {@code null} when offset was not defined
+     */
+    public Integer getOffset() {
+        return offset;
+    }
+
     @Override
     public ObjQualifier getObjQualifier() {
         return getPopAttribute();

src/main/java/com/gooddata/md/visualization/VOPopMeasureDefinition.java

@@ -15,6 +15,7 @@
 
 /**
  * Period over Period measure definition to be used within {@link Measure}
+ *
  * @deprecated identical with {@link com.gooddata.executeafm.afm.PopMeasureDefinition}, see https://github.com/gooddata/gooddata-java/issues/581
  */
 @Deprecated
@@ -27,12 +28,32 @@ public class VOPopMeasureDefinition extends com.gooddata.executeafm.afm.PopMeasu
 
     /**
      * Creates instance of Period over Period measure definition to be used in {@link VisualizationObject}
-     * @param measureIdentifier reference to local identifier of {@link VOSimpleMeasureDefinition} over which is PoP calculated
-     * @param popAttribute uri to attribute used for PoP
+     *
+     * @param measureIdentifier
+     *         reference to local identifier of {@link VOSimpleMeasureDefinition} over which is PoP calculated
+     * @param popAttribute
+     *         uri to attribute used for PoP
+     * @param offset
+     *         the number of periods defined via the {@code popAttribute} time interval to the past (when value is negative) or to the future (when
+     *         value is positive)
      */
     @JsonCreator
     public VOPopMeasureDefinition(@JsonProperty("measureIdentifier") final String measureIdentifier,
-                                  @JsonProperty("popAttribute") final ObjQualifier popAttribute) {
+                                  @JsonProperty("popAttribute") final ObjQualifier popAttribute,
+                                  @JsonProperty("offset") final Integer offset) {
+        super(measureIdentifier, popAttribute, offset);
+    }
+
+    /**
+     * Creates instance of Period over Period measure definition to be used in {@link VisualizationObject}
+     *
+     * @param measureIdentifier
+     *         reference to local identifier of {@link VOSimpleMeasureDefinition} over which is PoP calculated
+     * @param popAttribute
+     *         uri to attribute used for PoP
+     */
+    public VOPopMeasureDefinition(final String measureIdentifier,
+                                  final ObjQualifier popAttribute) {
         super(measureIdentifier, popAttribute);
     }
 }

src/test/groovy/com/gooddata/executeafm/afm/PopMeasureDefinitionTest.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2007-2017, GoodData(R) Corporation. All rights reserved.
+ * Copyright (C) 2007-2018, GoodData(R) Corporation. All rights reserved.
  * This source code is licensed under the BSD-style license found in the
  * LICENSE.txt file in the root directory of this source tree.
  */
@@ -17,39 +17,64 @@ import static spock.util.matcher.HamcrestSupport.that
 
 class PopMeasureDefinitionTest extends Specification {
 
-    private static final String POP_MEASURE_DEFINITION_JSON = 'executeafm/afm/popMeasureDefinition.json'
+    private static final String POP_MEASURE_JSON = 'executeafm/afm/popMeasureDefinition.json'
+    private static final String POP_MEASURE_WITH_OFFSET_JSON = 'executeafm/afm/popMeasureDefinitionWithOffset.json'
+
 
     def "should serialize"() {
         expect:
-        that new PopMeasureDefinition('mId', new UriObjQualifier('/gdc/md/projectId/obj/1')),
-                jsonEquals(resource(POP_MEASURE_DEFINITION_JSON))
+        that new PopMeasureDefinition('mId', new UriObjQualifier('/gdc/md/projectId/obj/1'), offset),
+                jsonEquals(resource(expectedJsonMeasureDefinition))
+
+        where:
+        offset | expectedJsonMeasureDefinition
+        null   | POP_MEASURE_JSON
+        -2     | POP_MEASURE_WITH_OFFSET_JSON
     }
 
     def "should deserialize"() {
         when:
-        PopMeasureDefinition measure = readObjectFromResource("/$POP_MEASURE_DEFINITION_JSON", PopMeasureDefinition)
+        PopMeasureDefinition measure = readObjectFromResource("/$jsonMeasureDefinition", PopMeasureDefinition)
 
         then:
         measure.measureIdentifier == 'mId'
-        (measure.popAttribute  as UriObjQualifier).uri == '/gdc/md/projectId/obj/1'
+        (measure.popAttribute as UriObjQualifier).uri == '/gdc/md/projectId/obj/1'
         measure.isAdHoc()
         measure.toString()
+        measure.offset == expectedOffset
+
+        where:
+        jsonMeasureDefinition        | expectedOffset
+        POP_MEASURE_JSON             | null
+        POP_MEASURE_WITH_OFFSET_JSON | -2
     }
 
     def "should copy"() {
         when:
-        def measure = new PopMeasureDefinition("mid", new IdentifierObjQualifier("id"))
+        def measure = new PopMeasureDefinition("mId", new IdentifierObjQualifier("id"), inputOffset)
         def copy = measure.withObjUriQualifier(new UriObjQualifier("uri"))
 
         then:
+        copy.measureIdentifier == 'mId'
         copy.objQualifier.uri == 'uri'
+        copy.offset == expectedOffset
+
+        where:
+        inputOffset | expectedOffset
+        null        | null
+        -2          | -2
     }
 
     def "test serializable"() {
-        PopMeasureDefinition measureDefinition = readObjectFromResource("/$POP_MEASURE_DEFINITION_JSON", PopMeasureDefinition)
+        when:
+        PopMeasureDefinition measureDefinition = readObjectFromResource("/$jsonMeasureDefinition", PopMeasureDefinition)
         PopMeasureDefinition deserialized = SerializationUtils.roundtrip(measureDefinition)
 
-        expect:
+        then:
         that deserialized, jsonEquals(measureDefinition)
+
+        where:
+        jsonMeasureDefinition << [POP_MEASURE_JSON, POP_MEASURE_WITH_OFFSET_JSON]
     }
+
 }

src/test/resources/executeafm/afm/popMeasureDefinition.json

@@ -5,4 +5,4 @@
       "uri": "/gdc/md/projectId/obj/1"
     }
   }
-}
+}

src/test/resources/executeafm/afm/popMeasureDefinitionWithOffset.json

@@ -0,0 +1,9 @@
+{
+  "popMeasure": {
+    "measureIdentifier": "mId",
+    "popAttribute": {
+      "uri": "/gdc/md/projectId/obj/1"
+    },
+    "offset": -2
+  }
+}