Major elimination of duplicate code in the various Scatter*.java classes.

Author: davewichers

plugin/src/main/java/org/owasp/benchmarkutils/score/report/ScatterHome.java

@@ -24,18 +24,14 @@
 import java.security.SecureRandom;
 import java.text.DecimalFormat;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
-import java.util.Map.Entry;
 import java.util.Set;
 import org.jfree.chart.ChartFactory;
 import org.jfree.chart.JFreeChart;
 import org.jfree.chart.annotations.XYLineAnnotation;
-import org.jfree.chart.annotations.XYTextAnnotation;
 import org.jfree.chart.plot.PlotOrientation;
 import org.jfree.chart.plot.XYPlot;
-import org.jfree.chart.ui.TextAnchor;
 import org.jfree.data.xy.XYDataItem;
 import org.jfree.data.xy.XYSeries;
 import org.jfree.data.xy.XYSeriesCollection;
@@ -44,9 +40,9 @@
 import org.owasp.benchmarkutils.score.ToolResults;
 
 public class ScatterHome extends ScatterPlot {
-    private static char averageLabel;
-    private double afr = 0;
-    private double atr = 0;
+
+    private double commercialAveFPR = 0; // The average FPR for commercial tools.
+    private double commercialAveTPR = 0; // The average TPR. These are range 0-1.
     private final String focus;
     static final char INITIAL_LABEL = 'A';
 
@@ -101,23 +97,23 @@ private JFreeChart display(String title, Set<Tool> tools) {
         }
 
         for (double d : averageCommercialFalseRates) {
-            afr += d;
+            this.commercialAveFPR += d;
         }
-        afr = afr / averageCommercialFalseRates.size();
+        this.commercialAveFPR = this.commercialAveFPR / averageCommercialFalseRates.size();
 
         for (double d : averageCommercialTrueRates) {
-            atr += d;
+            this.commercialAveTPR += d;
         }
-        atr = atr / averageCommercialTrueRates.size();
+        this.commercialAveTPR = this.commercialAveTPR / averageCommercialTrueRates.size();
 
         if (commercialToolCount > 1
                 || (BenchmarkScore.showAveOnlyMode && commercialToolCount == 1)) {
-            series.add(afr * 100, atr * 100);
+            series.add(commercialAveFPR * 100, commercialAveTPR * 100);
         }
 
         dataset.addSeries(series);
 
-        chart =
+        this.chart =
                 ChartFactory.createScatterPlot(
                         title,
                         "False Positive Rate",
@@ -127,15 +123,19 @@ private JFreeChart display(String title, Set<Tool> tools) {
                         true,
                         true,
                         false);
-        theme.apply(chart);
-        initializePlot(chart);
+        theme.apply(this.chart);
+        initializePlot(this.chart);
 
-        XYPlot xyplot = chart.getXYPlot();
+        XYPlot xyplot = this.chart.getXYPlot();
         addGenerationDate(xyplot);
 
+        // List the Key value (i.e., A, B, C) next to each plot point.
         makeDataLabels(tools, xyplot);
+        // List all the tools on the right, along with their scores
         makeLegend(tools, 103, 100.5, dataset, xyplot);
 
+        // Create the dashed lines from the baseline 0 axis line to the plotted score dot on the
+        // chart for each tool plotted
         for (XYDataItem item : (List<XYDataItem>) series.getItems()) {
             double x = item.getX().doubleValue();
             double y = item.getY().doubleValue();
@@ -144,39 +144,19 @@ private JFreeChart display(String title, Set<Tool> tools) {
             xyplot.addAnnotation(score);
         }
 
-        return chart;
+        return this.chart;
     }
 
+    /**
+     * Add the letter, from the key on the right, next to the plot point on the chart for for each
+     * tool to the supplied xyplot.
+     *
+     * @param tools - THe set of tool results.
+     * @param xyplot - The chart to make the Data labels on.
+     */
     private void makeDataLabels(Set<Tool> tools, XYPlot xyplot) {
         HashMap<Point2D, String> map = makePointList(tools);
-        for (Entry<Point2D, String> e : map.entrySet()) {
-            if (e.getValue() != null) {
-                Point2D p = e.getKey();
-                String label = sort(e.getValue());
-                XYTextAnnotation annotation = new XYTextAnnotation(label, p.getX(), p.getY());
-                annotation.setTextAnchor(
-                        p.getX() < 3 ? TextAnchor.TOP_LEFT : TextAnchor.TOP_CENTER);
-                annotation.setBackgroundPaint(Color.white);
-                if (label.toCharArray()[0] == averageLabel) {
-                    annotation.setPaint(Color.magenta);
-                } else {
-                    annotation.setPaint(Color.blue);
-                }
-                annotation.setFont(theme.getRegularFont());
-                xyplot.addAnnotation(annotation);
-            }
-        }
-    }
-
-    private static String sort(String value) {
-        String[] parts = value.split(",");
-        Arrays.sort(parts);
-        StringBuilder sb = new StringBuilder();
-        for (int i = 0; i < parts.length; i++) {
-            sb.append(parts[i]);
-            if (i < parts.length - 1) sb.append(",");
-        }
-        return sb.toString();
+        addLabelsToPlotPoints(map, xyplot);
     }
 
     private static SecureRandom sr = new SecureRandom();
@@ -230,49 +210,20 @@ private HashMap<Point2D, String> makePointList(Set<Tool> tools) {
                 || (BenchmarkScore.showAveOnlyMode && commercialToolCount == 1)) {
             Point2D ap =
                     new Point2D.Double(
-                            afr * 100 + sr.nextDouble() * .000001,
-                            atr * 100 + sr.nextDouble() * .000001 - 1);
-            averageLabel = ch;
+                            commercialAveFPR * 100 + sr.nextDouble() * .000001,
+                            commercialAveTPR * 100 + sr.nextDouble() * .000001 - 1);
+            this.averageLabel = ch;
             map.put(ap, "" + ch);
         }
 
-        dedupify(map);
+        dedupifyPlotPoints(map);
         return map;
     }
 
-    private static void dedupify(HashMap<Point2D, String> map) {
-        for (Entry<Point2D, String> e1 : map.entrySet()) {
-            Entry<Point2D, String> e2 = getMatch(map, e1);
-            while (e2 != null) {
-                StringBuilder label = new StringBuilder();
-                if (e1.getValue() != null) label.append(e1.getValue());
-                if (e1.getValue() != null && e2.getValue() != null) label.append(",");
-                if (e2.getValue() != null) label.append(e2.getValue());
-                e1.setValue(label.toString());
-                e2.setValue(null);
-                e2 = getMatch(map, e1);
-            }
-        }
-    }
-
-    private static Entry<Point2D, String> getMatch(
-            HashMap<Point2D, String> map, Entry<Point2D, String> e1) {
-        for (Entry<Point2D, String> e2 : map.entrySet()) {
-            Double xd = Math.abs(e1.getKey().getX() - e2.getKey().getX());
-            Double yd = Math.abs(e1.getKey().getY() - e2.getKey().getY());
-            boolean close = xd < 1 && yd < 3;
-            if (e1 != e2 && e1.getValue() != null && e2.getValue() != null && close) {
-                return e2;
-            }
-        }
-        return null;
-    }
-
     private void makeLegend(
             Set<Tool> tools, double x, double y, XYSeriesCollection dataset, XYPlot xyplot) {
-        char ch =
-                INITIAL_LABEL; // This is the first label in the Key with all the tools processed by
-        // this scorecard
+        // The first label in the Key with all the tools processed by this scorecard
+        char ch = INITIAL_LABEL;
         int i = -2; // Used to keep track of which row in the key we are processing. Helps calculate
         // the Y axis location where to put the Key entry
 
@@ -284,13 +235,7 @@ private void makeLegend(
             if (!r.isCommercial()) {
                 // print non-commercial label if there is at least one non-commercial tool
                 if (!printedNonCommercialLabel) {
-                    XYTextAnnotation stroketext1 =
-                            new XYTextAnnotation("Non-Commercial", x, y + i * -3.3);
-                    stroketext1.setTextAnchor(TextAnchor.CENTER_LEFT);
-                    stroketext1.setBackgroundPaint(Color.white);
-                    stroketext1.setPaint(Color.black);
-                    stroketext1.setFont(theme.getRegularFont());
-                    xyplot.addAnnotation(stroketext1);
+                    addLabelToKey(xyplot, x, y, i, "Non-Commercial");
                     i++;
                     printedNonCommercialLabel = true;
                 }
@@ -299,49 +244,28 @@ private void makeLegend(
                 String label = (ch == 'I' || ch == 'i' ? ch + ":   " : ch + ": ");
                 // Another hack to make it line up better if the letter is a 'J' or 'j'
                 label = (ch == 'J' || ch == 'j' ? ch + ":  " : label);
-                double score = or.getOverallScore() * 100;
-                final DecimalFormat DF = new DecimalFormat("#0.0");
-                String TPR = DF.format(100 * or.getTruePositiveRate());
-                if (TPR.endsWith("0"))
-                    TPR = TPR.substring(0, TPR.length() - 2); // trim off .0 if it ends that way.
-                String FPR = DF.format(100 * or.getFalsePositiveRate());
-                if (FPR.endsWith("0")) FPR = FPR.substring(0, FPR.length() - 2);
-
-                final String TOOL = "\u25A0 " + label + r.getToolNameAndVersion();
-                XYTextAnnotation toolLabel = new XYTextAnnotation(TOOL, x, y + i * -3.3);
-                toolLabel.setTextAnchor(TextAnchor.CENTER_LEFT);
-                toolLabel.setBackgroundPaint(Color.white);
-                toolLabel.setPaint(Color.blue);
-                toolLabel.setFont(theme.getRegularFont());
-                xyplot.addAnnotation(toolLabel);
-                final String SCORE = Math.round(score) + "%";
-                XYTextAnnotation scoreLabel =
-                        new XYTextAnnotation(SCORE, x + COLUMN_1_OFFSET, y + i * -3.3);
-                scoreLabel.setTextAnchor(TextAnchor.CENTER_RIGHT);
-                scoreLabel.setBackgroundPaint(Color.white);
-                scoreLabel.setPaint(Color.blue);
-                scoreLabel.setFont(theme.getRegularFont());
-                xyplot.addAnnotation(scoreLabel);
-                final String CALC = "(" + TPR + "-" + FPR + ")";
-                XYTextAnnotation calcLabel =
-                        new XYTextAnnotation(CALC, x + COLUMN_2_OFFSET, y + i * -3.3);
-                calcLabel.setTextAnchor(TextAnchor.CENTER);
-                calcLabel.setBackgroundPaint(Color.white);
-                calcLabel.setPaint(Color.gray);
-                calcLabel.setFont(theme.getSmallFont());
-                xyplot.addAnnotation(calcLabel);
 
+                addEntryToKey(
+                        xyplot,
+                        Color.blue,
+                        x,
+                        y,
+                        i,
+                        label,
+                        r.getToolNameAndVersion(),
+                        or.getTruePositiveRate(),
+                        or.getFalsePositiveRate());
                 i++;
                 // Weak hack if there are more than 26 tools scored. This will only get us to 52.
                 if (ch == 'Z') ch = 'a';
                 else ch++;
             }
         }
 
-        // commercial tools
-        double totalScore = 0;
+        // commercial tools - Their averages have already been calculated
         boolean printedCommercialLabel = false;
         int commercialToolCount = 0;
+        final DecimalFormat DF = new DecimalFormat("#0.0");
 
         for (Tool r : tools) {
 
@@ -350,13 +274,7 @@ private void makeLegend(
 
                 // print commercial label if there is at least one commercial tool
                 if (!printedCommercialLabel) {
-                    XYTextAnnotation stroketext =
-                            new XYTextAnnotation("Commercial", x, y + i * -3.3);
-                    stroketext.setTextAnchor(TextAnchor.CENTER_LEFT);
-                    stroketext.setBackgroundPaint(Color.white);
-                    stroketext.setPaint(Color.black);
-                    stroketext.setFont(theme.getRegularFont());
-                    xyplot.addAnnotation(stroketext);
+                    addLabelToKey(xyplot, x, y, i, "Commercial");
                     i++;
                     printedCommercialLabel = true;
                 }
@@ -366,50 +284,25 @@ private void makeLegend(
                 String label = (ch == 'I' || ch == 'i' ? ch + ":   " : ch + ": ");
                 // Another hack to make it line up better if the letter is a 'J' or 'j'
                 label = (ch == 'J' || ch == 'j' ? ch + ":  " : label);
-                double score = or.getOverallScore() * 100;
                 if (!BenchmarkScore.showAveOnlyMode) {
-
-                    final DecimalFormat DF = new DecimalFormat("#0.0");
-                    String TPR = DF.format(100 * or.getTruePositiveRate());
-                    if (TPR.endsWith("0"))
-                        TPR =
-                                TPR.substring(
-                                        0, TPR.length() - 2); // trim off .0 if it ends that way.
-                    String FPR = DF.format(100 * or.getFalsePositiveRate());
-                    if (FPR.endsWith("0")) FPR = FPR.substring(0, FPR.length() - 2);
-
-                    final String TOOL = "\u25A0 " + label + r.getToolNameAndVersion();
-                    XYTextAnnotation toolLabel = new XYTextAnnotation(TOOL, x, y + i * -3.3);
-                    toolLabel.setTextAnchor(TextAnchor.CENTER_LEFT);
-                    toolLabel.setBackgroundPaint(Color.white);
-                    toolLabel.setPaint(Color.blue);
-                    toolLabel.setFont(theme.getRegularFont());
-                    xyplot.addAnnotation(toolLabel);
-                    final String SCORE = Math.round(score) + "%";
-                    XYTextAnnotation scoreLabel =
-                            new XYTextAnnotation(SCORE, x + COLUMN_1_OFFSET, y + i * -3.3);
-                    scoreLabel.setTextAnchor(TextAnchor.CENTER_RIGHT);
-                    scoreLabel.setBackgroundPaint(Color.white);
-                    scoreLabel.setPaint(Color.blue);
-                    scoreLabel.setFont(theme.getRegularFont());
-                    xyplot.addAnnotation(scoreLabel);
-                    final String CALC = "(" + TPR + "-" + FPR + ")";
-                    XYTextAnnotation calcLabel =
-                            new XYTextAnnotation(CALC, x + COLUMN_2_OFFSET, y + i * -3.3);
-                    calcLabel.setTextAnchor(TextAnchor.CENTER);
-                    calcLabel.setBackgroundPaint(Color.white);
-                    calcLabel.setPaint(Color.gray);
-                    calcLabel.setFont(theme.getSmallFont());
-                    xyplot.addAnnotation(calcLabel);
-
+                    addEntryToKey(
+                            xyplot,
+                            Color.blue,
+                            x,
+                            y,
+                            i,
+                            label,
+                            r.getToolNameAndVersion(),
+                            or.getTruePositiveRate(),
+                            or.getFalsePositiveRate());
                     i++;
-                    // Weak hack if there are more than 26 tools scored. This will only get us to
-                    // 52.
+                    // Weak hack if more than 26 tools scored. This will only get us to 52.
                     if (ch == 'Z') ch = 'a';
                     else ch++;
                 }
-                totalScore += score;
             }
+
+            // This highlights the tool of focus, making that plot point green. Rarely used.
             if (r.getToolName().replace(' ', '_').equalsIgnoreCase(focus)) {
                 ToolResults orc = r.getOverallResults();
                 Point2D focusPoint =
@@ -423,24 +316,20 @@ private void makeLegend(
         // commercial average
         if (commercialToolCount > 1
                 || (BenchmarkScore.showAveOnlyMode && commercialToolCount == 1)) {
-            double averageScore = totalScore / commercialToolCount;
-            XYTextAnnotation stroketext2 =
-                    new XYTextAnnotation(
-                            "\u25A0 "
-                                    + ch
-                                    + ": Commercial Average"
-                                    + " ("
-                                    + Math.round(averageScore)
-                                    + "%)",
-                            x,
-                            y + i * -3.3);
-            stroketext2.setTextAnchor(TextAnchor.CENTER_LEFT);
-            stroketext2.setBackgroundPaint(Color.white);
-            stroketext2.setPaint(Color.magenta);
-            stroketext2.setFont(theme.getRegularFont());
-            xyplot.addAnnotation(stroketext2);
-
-            Point2D averagePoint = new Point2D.Double(afr * 100, atr * 100);
+
+            addEntryToKey(
+                    xyplot,
+                    Color.magenta,
+                    x,
+                    y,
+                    i,
+                    ch + ": ",
+                    "Commercial Average",
+                    commercialAveTPR,
+                    commercialAveFPR);
+
+            Point2D averagePoint =
+                    new Point2D.Double(this.commercialAveFPR * 100, this.commercialAveTPR * 100);
             makePoint(xyplot, averagePoint, 3, Color.magenta);
         }
     }