Add grouped export of results, currently only supported by the ScriptFrontend through --group-scopes

Author: Kiskae

src/main/java/nl/rug/jbi/jsm/Bootstrap.java

@@ -57,6 +57,7 @@ public static void main(final String[] args) throws IOException {
             final Set<String> input = Sets.newHashSet();
             final Set<String> libraries = Sets.newHashSet();
             final Set<String> output = Sets.newHashSet();
+            boolean groupExportScopes = false;
 
             Set<String> selectedSet = Sets.newHashSet();
 
@@ -67,6 +68,8 @@ public static void main(final String[] args) throws IOException {
                     selectedSet = libraries;
                 } else if ("--out".equalsIgnoreCase(arg)) {
                     selectedSet = output;
+                } else if ("--group-scopes".equalsIgnoreCase(arg)) {
+                    groupExportScopes = true;
                 } else {
                     selectedSet.add(arg);
                 }
@@ -75,7 +78,7 @@ public static void main(final String[] args) throws IOException {
             checkArgument(!input.isEmpty(), "Scriptable mode requires a specified input. (--in)");
             checkArgument(!output.isEmpty(), "Scriptable mode requires a specified output. (--out)");
 
-            frontend = new ScriptFrontend(core, input, libraries, output);
+            frontend = new ScriptFrontend(core, input, libraries, output, groupExportScopes);
         } else {
             //GUI mode
             frontend = new GUIFrontend(core);

src/main/java/nl/rug/jbi/jsm/frontend/ScriptFrontend.java

@@ -33,6 +33,7 @@ public class ScriptFrontend implements Frontend {
 
     private final Set<String> input;
     private final Set<String> libraries;
+    private final boolean groupExportScopes;
 
     private final Table<String, Class, Object> resultsClass = HashBasedTable.create();
     private final Table<String, Class, Object> resultsPackage = HashBasedTable.create();
@@ -53,11 +54,13 @@ public ScriptFrontend(
             final JSMCore core,
             final Set<String> input,
             final Set<String> libraries,
-            final Set<String> output
+            final Set<String> output,
+            final boolean groupExportScopes
     ) throws IOException {
         this.core = core;
         this.input = input;
         this.libraries = libraries;
+        this.groupExportScopes = groupExportScopes;
         this.exporter = getOutputWriter(output);
 
         logger.info("Exporting to {}", this.exporter);
@@ -66,10 +69,15 @@ public ScriptFrontend(
     private static void exportData(
             final ResultsExporter exporter,
             final Table<String, Class, Object> results,
-            final MetricScope scope
+            final MetricScope scope,
+            final boolean groupExportScopes
     ) throws IOException {
-        for (final Map.Entry<Class, Map<String, Object>> entry : results.columnMap().entrySet()) {
-            exporter.exportData(entry.getKey(), scope, entry.getValue());
+        if (groupExportScopes) {
+            exporter.exportDataCollection(scope, results);
+        } else {
+            for (final Map.Entry<Class, Map<String, Object>> entry : results.columnMap().entrySet()) {
+                exporter.exportData(entry.getKey(), scope, entry.getValue());
+            }
         }
     }
 
@@ -157,9 +165,9 @@ public synchronized void processResult(List<MetricResult> resultList) {
     public void signalDone() {
         logger.info("Processing finished, exporting results");
         try {
-            exportData(this.exporter, this.resultsClass, MetricScope.CLASS);
-            exportData(this.exporter, this.resultsPackage, MetricScope.PACKAGE);
-            exportData(this.exporter, this.resultsCollection, MetricScope.COLLECTION);
+            exportData(this.exporter, this.resultsClass, MetricScope.CLASS, this.groupExportScopes);
+            exportData(this.exporter, this.resultsPackage, MetricScope.PACKAGE, this.groupExportScopes);
+            exportData(this.exporter, this.resultsCollection, MetricScope.COLLECTION, this.groupExportScopes);
 
             this.exporter.close();
         } catch (IOException e) {

src/main/java/nl/rug/jbi/jsm/util/ResultsExporter.java

@@ -3,14 +3,16 @@
 import au.com.bytecode.opencsv.CSVWriter;
 import com.google.common.base.Function;
 import com.google.common.base.Objects;
-import com.google.common.collect.FluentIterable;
+import com.google.common.collect.*;
 import nl.rug.jbi.jsm.core.calculator.MetricScope;
 
 import java.io.Closeable;
 import java.io.File;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.text.NumberFormat;
+import java.util.Iterator;
+import java.util.List;
 import java.util.Map;
 
 import static com.google.common.base.Preconditions.checkArgument;
@@ -96,7 +98,8 @@ private File getFileForName(final String identifier, final boolean strict) throw
      * @param results     Map with results for the given metric and scope.
      * @throws IOException If it gets thrown by the underlying CSVWriter
      */
-    public void exportData(final Class metricClass, final MetricScope scope, final Map<String, Object> results) throws IOException {
+    public void exportData(final Class metricClass, final MetricScope scope, final Map<String, Object> results)
+            throws IOException {
         checkArgument(metricClass != null);
         assert metricClass != null;
         checkArgument(scope != null);
@@ -132,10 +135,84 @@ public String[] apply(Map.Entry<String, Object> entry) {
                             .toList()
             );
         } finally {
-            writer.close();
+            try {
+                writer.close();
+            } catch (IOException ignored) {
+                //Prevent finally block from overriding exceptions
+            }
+        }
+    }
+
+
+    /**
+     * Exports a data set collection, creates a file to contain the results, writes the filename to the mapping file
+     * and then write all the data from the given table to that file.
+     *
+     * @param scope   Scope of the results getting exported.
+     * @param results Map with results for the given scope.
+     * @throws IOException If it gets thrown by the underlying CSVWriter
+     */
+    public void exportDataCollection(final MetricScope scope, final Table<String, Class, Object> results)
+            throws IOException {
+        checkArgument(scope != null);
+        assert scope != null;
+        checkArgument(results != null);
+        assert results != null;
+
+        final File metricOutput = getFileForName(scope.toString(), false);
+
+        //Output mappings
+        final String outputFileName = metricOutput.toString();
+        for (final Class c : results.columnKeySet()) {
+            this.mappingWriter.writeNext(new String[]{c.getName(), scope.toString(), outputFileName});
+        }
+        this.mappingWriter.flush();
+
+        //Write results
+        final CSVWriter writer = new CSVWriter(new FileWriter(metricOutput));
+        try {
+            //Output headers
+            final List<String> headers = Lists.newLinkedList();
+            headers.add("Identifier");
+            headers.addAll(Collections2.transform(results.columnKeySet(), new Function<Class, String>() {
+                @Override
+                public String apply(Class aClass) {
+                    return aClass.getSimpleName();
+                }
+            }));
+            writer.writeNext(headers.toArray(new String[headers.size()]));
+
+            //Output data
+            final ImmutableList<String[]> mappedDataSet = FluentIterable.from(results.rowMap().entrySet())
+                    .transform(new Function<Map.Entry<String, Map<Class, Object>>, String[]>() {
+                        @Override
+                        public String[] apply(Map.Entry<String, Map<Class, Object>> entry) {
+                            final String[] ret = new String[1 + entry.getValue().size()];
+                            ret[0] = entry.getKey();
+
+                            final Iterator<Object> it = entry.getValue().values().iterator();
+                            int count = 1;
+                            while (it.hasNext()) {
+                                ret[count++] = printObject(it.next(), ResultsExporter.this.nf);
+                            }
+
+                            return ret;
+                        }
+                    })
+                    .toList();
+            writer.writeAll(mappedDataSet);
+        } finally {
+            try {
+                writer.close();
+            } catch (IOException ignored) {
+                //Prevent finally block from overriding exceptions
+            }
         }
     }
 
+    /**
+     * @return Relative location of the 'mapping' file
+     */
     public String getMappingFileName() {
         return this.mappingFileName;
     }