make AFM and ResultSpec conversion methods in VisualizationConverter public

Author: peter-plochan

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

@@ -18,16 +18,11 @@
 import com.gooddata.executeafm.afm.NegativeAttributeFilter;
 import com.gooddata.executeafm.afm.PositiveAttributeFilter;
 import com.gooddata.executeafm.afm.SimpleMeasureDefinition;
-import com.gooddata.executeafm.resultspec.AttributeSortItem;
 import com.gooddata.executeafm.resultspec.Dimension;
-import com.gooddata.executeafm.resultspec.Direction;
-import com.gooddata.executeafm.resultspec.MeasureLocatorItem;
-import com.gooddata.executeafm.resultspec.MeasureSortItem;
 import com.gooddata.executeafm.resultspec.ResultSpec;
 import com.gooddata.executeafm.resultspec.SortItem;
 
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.function.Function;
 import java.util.stream.Collectors;
@@ -47,35 +42,49 @@ public abstract class VisualizationConverter {
     private static final ObjectMapper MAPPER = new ObjectMapper();
 
     /**
-     * Generate Execution from Visualization object. Currently {@link ResultSpec}'s {@link Dimension}s can be generated
-     * for table and four types of chart: bar, column, line and pie.
+     * Generate Execution from Visualization object.
      *
      * @param visualizationObject which will be converted to {@link Execution}
      * @param visualizationClassGetter {@link Function} for fetching VisualizationClass, which is necessary for correct generation of {@link ResultSpec}
      * @return {@link Execution} object
+     *
+     * @see #convertToAfm(VisualizationObject)
+     * @see #convertToResultSpec(VisualizationObject, Function)
      */
     public static Execution convertToExecution(final VisualizationObject visualizationObject, final Function<String, VisualizationClass> visualizationClassGetter) {
-        VisualizationClass visualizationClass = notNull(visualizationClassGetter).apply(notNull(visualizationObject).getVisualizationClassUri());
-
-        ResultSpec resultSpec = convertToResultSpec(visualizationObject, visualizationClass.getVisualizationType());
+        ResultSpec resultSpec = convertToResultSpec(visualizationObject, visualizationClassGetter);
         Afm afm = convertToAfm(visualizationObject);
         return new Execution(afm, resultSpec);
     }
 
-    static Afm convertToAfm(final VisualizationObject visualizationObject) {
+    /**
+     * Generate Afm from Visualization object.
+     *
+     * @param visualizationObject which will be converted to {@link Execution}
+     * @return {@link Afm} object
+     */
+    public static Afm convertToAfm(final VisualizationObject visualizationObject) {
         final List<AttributeItem> attributes = convertAttributes(visualizationObject.getAttributes());
         final List<CompatibilityFilter> filters = convertFilters(visualizationObject.getFilters());
         final List<MeasureItem> measures = convertMeasures(visualizationObject.getMeasures());
 
         return new Afm(attributes, filters, measures, null);
     }
 
-    static ResultSpec convertToResultSpec(final VisualizationObject visualizationObject,
-                                          final VisualizationType visualizationType) {
-        notNull(visualizationObject);
-        notNull(visualizationType);
+    /**
+     * Generate ResultSpec from Visualization object. Currently {@link ResultSpec}'s {@link Dimension}s can be generated
+     * for table and four types of chart: bar, column, line and pie.
+     *
+     * @param visualizationObject which will be converted to {@link Execution}
+     * @param visualizationClassGetter {@link Function} for fetching VisualizationClass, which is necessary for correct generation of {@link ResultSpec}
+     * @return {@link Execution} object
+     */
+    public static ResultSpec convertToResultSpec(final VisualizationObject visualizationObject,
+                                          final Function<String, VisualizationClass> visualizationClassGetter) {
+        VisualizationClass visualizationClass = notNull(visualizationClassGetter).apply(notNull(visualizationObject).getVisualizationClassUri());
+
         List<SortItem> sorts = getSorting(visualizationObject);
-        List<Dimension> dimensions = getDimensions(visualizationObject, visualizationType);
+        List<Dimension> dimensions = getDimensions(visualizationObject, visualizationClass.getVisualizationType());
         return new ResultSpec(dimensions, sorts);
     }
 
@@ -206,12 +215,11 @@ private static List<CompatibilityFilter> convertFilters(final List<FilterItem> f
     }
 
     private static List<MeasureItem> convertMeasures(final List<Measure> measures) {
-        List<MeasureItem> measuresForAfm = measures.stream()
+        return measures.stream()
                 .map(VisualizationConverter::removeFormat)
                 .map(VisualizationConverter::getAfmMeasure)
                 .map(VisualizationConverter::convertMeasureFilters)
                 .collect(toList());
-        return measuresForAfm;
     }
 
     private static Measure removeFormat(final Measure measure) {

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

@@ -19,8 +19,10 @@
 import static org.apache.commons.lang3.Validate.notNull;
 
 import com.gooddata.executeafm.UriObjQualifier;
+import com.gooddata.executeafm.afm.Afm;
 import com.gooddata.executeafm.afm.FilterItem;
 import com.gooddata.executeafm.Execution;
+import com.gooddata.executeafm.resultspec.ResultSpec;
 import com.gooddata.md.AbstractObj;
 import com.gooddata.md.Meta;
 import com.gooddata.md.Queryable;
@@ -255,11 +257,30 @@ public void setVisualizationClass(UriObjQualifier uri) {
         content.setVisualizationClass(uri);
     }
 
+    /**
+     * @see VisualizationConverter#convertToExecution(VisualizationObject, Function)
+     */
     @JsonIgnore
     public Execution convertToExecution(Function<String, VisualizationClass> visualizationClassgetter) {
         return VisualizationConverter.convertToExecution(this, visualizationClassgetter);
     }
 
+    /**
+     * @see VisualizationConverter#convertToAfm(VisualizationObject)
+     */
+    @JsonIgnore
+    public Afm convertToAfm() {
+        return VisualizationConverter.convertToAfm(this);
+    }
+
+    /**
+     * @see VisualizationConverter#convertToResultSpec(VisualizationObject, Function)
+     */
+    @JsonIgnore
+    public ResultSpec convertToResultSpec(Function<String, VisualizationClass> visualizationClassgetter) {
+        return VisualizationConverter.convertToResultSpec(this, visualizationClassgetter);
+    }
+
     private Content getContent() {
         return content;
     }

…/VisualizationObjectConverterTest.groovy …zation/VisualizationConverterTest.groovysrc/test/groovy/com/gooddata/md/visualization/VisualizationObjectConverterTest.groovy renamed to src/test/groovy/com/gooddata/md/visualization/VisualizationConverterTest.groovy src/test/groovy/com/gooddata/md/visualization/VisualizationObjectConverterTest.groovy renamed to src/test/groovy/com/gooddata/md/visualization/VisualizationConverterTest.groovy

@@ -24,14 +24,16 @@ import com.gooddata.executeafm.resultspec.ResultSpec
 import com.gooddata.executeafm.resultspec.SortItem
 import spock.lang.Unroll
 
+import java.util.function.Function
+
 import static VisualizationConverter.convertToAfm
 import static VisualizationConverter.convertToResultSpec
 import static VisualizationConverter.parseSorting
 import static com.gooddata.util.ResourceUtils.readObjectFromResource
 import static net.javacrumbs.jsonunit.JsonMatchers.jsonEquals
 import static spock.util.matcher.HamcrestSupport.that
 
-class VisualizationObjectConverterTest extends Specification {
+class VisualizationConverterTest extends Specification {
     private static final String COMPLEX_VISUALIZATION = "md/visualization/complexVisualizationObject.json"
     private static final String SIMPLE_VISUALIZATION = "md/visualization/simpleVisualizationObject.json"
 
@@ -83,8 +85,9 @@ class VisualizationObjectConverterTest extends Specification {
     @Unroll
     def "should generate result spec for table with default sorting from #name"() {
         given:
+        Function getter = { vizObject -> Stub(VisualizationClass) { getVisualizationType() >> VisualizationType.TABLE } }
         VisualizationObject vo = readObjectFromResource("/$resource", VisualizationObject)
-        ResultSpec converted = convertToResultSpec(vo, VisualizationType.TABLE)
+        ResultSpec converted = convertToResultSpec(vo, getter)
 
         expect:
         that converted, jsonEquals(expected)
@@ -104,8 +107,9 @@ class VisualizationObjectConverterTest extends Specification {
     @Unroll
     def "should generate result spec for #type"() {
         given:
+        Function getter = { vizObject -> Stub(VisualizationClass) { getVisualizationType() >> VisualizationType.of(type) } }
         VisualizationObject vo = readObjectFromResource("/$resource", VisualizationObject)
-        ResultSpec converted = convertToResultSpec(vo, VisualizationType.of(type))
+        ResultSpec converted = convertToResultSpec(vo, getter)
 
         expect:
         that converted, jsonEquals(expected)