[192-webreport] added JsonProperty annotations, removed underscore naming

jplag/src/main/java/de/jplag/reportingV2/jsonfactory/JsonFactory.java

@@ -45,7 +45,7 @@ public class JsonFactory {
             ObjectMapper mapper = new ObjectMapper();
             mapper.writeValue(Path.of(folderPath, "overview.json").toFile(), jPlagReport.getOverviewReport());
             for (ComparisonReport r : jPlagReport.getComparisons()) {
-                String name = r.getFirst_submission_id().concat("-").concat(r.getSecond_submission_id()).concat(".json");
+                String name = r.getFirstSubmissionId().concat("-").concat(r.getSecondSubmissionId()).concat(".json");
                 mapper.writeValue(Path.of(folderPath, name).toFile(), r);
             }
         } catch (IOException e) {

jplag/src/main/java/de/jplag/reportingV2/reportobject/ReportObjectFactory.java

@@ -37,20 +37,20 @@ public class ReportObjectFactory {
 
         // New update in JPlagOption. Not a single root dir but a list. Needs re-thinking and
         // implementation also in report model.
-        overviewReport.setSubmission_folder_path(result.getOptions().getRootDirectoryNames().get(0));
+        overviewReport.setSubmissionFolderPath(result.getOptions().getRootDirectoryNames().get(0));
 
         String baseCodePath = result.getOptions().hasBaseCode() ? result.getOptions().getBaseCodeSubmissionName().orElse("") : "";
-        overviewReport.setBase_code_folder_path(baseCodePath);
+        overviewReport.setBaseCodeFolderPath(baseCodePath);
 
         overviewReport.setLanguage(result.getOptions().getLanguage().getName());
-        overviewReport.setFile_extensions(List.of(result.getOptions().getFileSuffixes()));
-        overviewReport.setSubmission_ids(extractSubmissionNames(comparisons));
-        overviewReport.setFailed_submission_names(List.of());  // No number of failed submissions
-        overviewReport.setExcluded_files(result.getOptions().getExcludedFiles());
-        overviewReport.setMatch_sensitivity(result.getOptions().getMinimumTokenMatch());
-        overviewReport.setDate_of_execution(getDate());
-        overviewReport.setExecution_time(result.getDuration());
-        overviewReport.setComparison_names(getComparisonNames(comparisons));
+        overviewReport.setFileExtensions(List.of(result.getOptions().getFileSuffixes()));
+        overviewReport.setSubmissionIds(extractSubmissionNames(comparisons));
+        overviewReport.setFailedSubmissionNames(List.of());  // No number of failed submissions
+        overviewReport.setExcludedFiles(result.getOptions().getExcludedFiles());
+        overviewReport.setMatchSensitivity(result.getOptions().getMinimumTokenMatch());
+        overviewReport.setDateOfExecution(getDate());
+        overviewReport.setExecutionTime(result.getDuration());
+        overviewReport.setComparisonNames(getComparisonNames(comparisons));
         overviewReport.setMetrics(getMetrics(result));
         overviewReport.setClusters(getClusters(result));
 

jplag/src/main/java/de/jplag/reportingV2/reportobject/model/Cluster.java

@@ -1,20 +1,28 @@
 package de.jplag.reportingV2.reportobject.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import java.util.List;
 
 public class Cluster {
-    private final float average_similarity;
+
+    @JsonProperty("average_similarity")
+    private final float averageSimilarity;
+
+    @JsonProperty("strength")
     private final float strength;
+
+    @JsonProperty("members")
     private final List<String> members;
 
-    public Cluster(float average_similarity, float strength, List<String> members) {
-        this.average_similarity = average_similarity;
+    public Cluster(float averageSimilarity, float strength, List<String> members) {
+        this.averageSimilarity = averageSimilarity;
         this.strength = strength;
         this.members = List.copyOf(members);
     }
 
-    public float getAverage_similarity() {
-        return average_similarity;
+    public float getAverageSimilarity() {
+        return averageSimilarity;
     }
 
     public float getStrength() {

jplag/src/main/java/de/jplag/reportingV2/reportobject/model/ComparisonReport.java

@@ -1,45 +1,58 @@
 package de.jplag.reportingV2.reportobject.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import java.util.List;
 
 public class ComparisonReport {
 
-    private final String first_submission_id;
-    private final String second_submission_id;
-    private final float match_percentage;
-    private final List<FilesOfSubmission> files_of_first_submission;
-    private final List<FilesOfSubmission> files_of_second_submission;
+    @JsonProperty("first_submission_id")
+    private final String firstSubmissionId;
+
+    @JsonProperty("second_submission_id")
+    private final String secondSubmissionId;
+
+    @JsonProperty("match_percentage")
+    private final float matchPercentage;
+
+    @JsonProperty("files_of_first_submission")
+    private final List<FilesOfSubmission> filesOfFirstSubmission;
+
+    @JsonProperty("files_of_second_submission")
+    private final List<FilesOfSubmission> filesOfSecondSubmission;
+
+    @JsonProperty("matches")
     private final List<Match> matches;
 
-    public ComparisonReport(String first_submission_id, String second_submission_id, float match_percentage,
-            List<FilesOfSubmission> files_of_first_submission, List<FilesOfSubmission> files_of_second_submission, List<Match> matches) {
+    public ComparisonReport(String firstSubmissionId, String secondSubmissionId, float matchPercentage,
+                            List<FilesOfSubmission> filesOfFirstSubmission, List<FilesOfSubmission> filesOfSecondSubmission, List<Match> matches) {
 
-        this.first_submission_id = first_submission_id;
-        this.second_submission_id = second_submission_id;
-        this.match_percentage = match_percentage;
-        this.files_of_first_submission = List.copyOf(files_of_first_submission);
-        this.files_of_second_submission = List.copyOf(files_of_second_submission);
+        this.firstSubmissionId = firstSubmissionId;
+        this.secondSubmissionId = secondSubmissionId;
+        this.matchPercentage = matchPercentage;
+        this.filesOfFirstSubmission = List.copyOf(filesOfFirstSubmission);
+        this.filesOfSecondSubmission = List.copyOf(filesOfSecondSubmission);
         this.matches = matches;
     }
 
-    public String getFirst_submission_id() {
-        return first_submission_id;
+    public String getFirstSubmissionId() {
+        return firstSubmissionId;
     }
 
-    public String getSecond_submission_id() {
-        return second_submission_id;
+    public String getSecondSubmissionId() {
+        return secondSubmissionId;
     }
 
-    public float getMatch_percentage() {
-        return match_percentage;
+    public float getMatchPercentage() {
+        return matchPercentage;
     }
 
-    public List<FilesOfSubmission> getFiles_of_first_submission() {
-        return files_of_first_submission;
+    public List<FilesOfSubmission> getFilesOfFirstSubmission() {
+        return filesOfFirstSubmission;
     }
 
-    public List<FilesOfSubmission> getFiles_of_second_submission() {
-        return files_of_second_submission;
+    public List<FilesOfSubmission> getFilesOfSecondSubmission() {
+        return filesOfSecondSubmission;
     }
 
     public List<Match> getMatches() {

jplag/src/main/java/de/jplag/reportingV2/reportobject/model/FilesOfSubmission.java

@@ -1,19 +1,24 @@
 package de.jplag.reportingV2.reportobject.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import java.util.List;
 
 public class FilesOfSubmission {
 
-    private final String file_name;
+    @JsonProperty("file_name")
+    private final String fileName;
+
+    @JsonProperty("lines")
     private final List<String> lines;
 
-    public FilesOfSubmission(String file_name, List<String> file_code) {
-        this.file_name = file_name;
+    public FilesOfSubmission(String fileName, List<String> file_code) {
+        this.fileName = fileName;
         this.lines = List.copyOf(file_code);
     }
 
-    public String getFile_name() {
-        return file_name;
+    public String getFileName() {
+        return fileName;
     }
 
     public List<String> getLines() {

jplag/src/main/java/de/jplag/reportingV2/reportobject/model/Match.java

@@ -1,48 +1,63 @@
 package de.jplag.reportingV2.reportobject.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 public class Match {
 
-    private final String first_file_name;
-    private final String second_file_name;
-    private final int start_in_first;
-    private final int end_in_first;
-    private final int start_in_second;
-    private final int end_in_second;
+    @JsonProperty("first_file_name")
+    private final String firstFileName;
+
+    @JsonProperty("second_file_name")
+    private final String secondFileName;
+
+    @JsonProperty("start_in_first")
+    private final int startInFirst;
+
+    @JsonProperty("end_in_first")
+    private final int endInFirst;
+
+    @JsonProperty("start_in_second")
+    private final int startInSecond;
+
+    @JsonProperty("end_in_second")
+    private final int endInSecond;
+
+    @JsonProperty("tokens")
     private final int tokens;
 
-    public Match(String first_file_name, String second_file_name, int start_in_first, int end_in_first, int start_in_second, int end_in_second,
-            int tokens) {
-        this.first_file_name = first_file_name;
-        this.second_file_name = second_file_name;
-        this.start_in_first = start_in_first;
-        this.end_in_first = end_in_first;
-        this.start_in_second = start_in_second;
-        this.end_in_second = end_in_second;
+    public Match(String firstFileName, String secondFileName, int startInFirst, int endInFirst, int startInSecond, int endInSecond,
+                 int tokens) {
+        this.firstFileName = firstFileName;
+        this.secondFileName = secondFileName;
+        this.startInFirst = startInFirst;
+        this.endInFirst = endInFirst;
+        this.startInSecond = startInSecond;
+        this.endInSecond = endInSecond;
         this.tokens = tokens;
     }
 
-    public String getFirst_file_name() {
-        return first_file_name;
+    public String getFirstFileName() {
+        return firstFileName;
     }
 
-    public String getSecond_file_name() {
-        return second_file_name;
+    public String getSecondFileName() {
+        return secondFileName;
     }
 
-    public int getStart_in_first() {
-        return start_in_first;
+    public int getStartInFirst() {
+        return startInFirst;
     }
 
-    public int getEnd_in_first() {
-        return end_in_first;
+    public int getEndInFirst() {
+        return endInFirst;
     }
 
-    public int getStart_in_second() {
-        return start_in_second;
+    public int getStartInSecond() {
+        return startInSecond;
     }
 
-    public int getEnd_in_second() {
-        return end_in_second;
+    public int getEndInSecond() {
+        return endInSecond;
     }
 
     public int getTokens() {

jplag/src/main/java/de/jplag/reportingV2/reportobject/model/Metric.java

@@ -1,11 +1,21 @@
 package de.jplag.reportingV2.reportobject.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import java.util.List;
 
 public class Metric {
+
+    @JsonProperty("name")
     private final String name;
+
+    @JsonProperty("threshold")
     private final float threshold;
+
+    @JsonProperty("distribution")
     private final List<Integer> distribution;
+
+    @JsonProperty("topComparisons")
     private final List<TopComparison> topComparisons;
 
     public Metric(String name, float threshold, List<Integer> distribution, List<TopComparison> topComparisons) {

jplag/src/main/java/de/jplag/reportingV2/reportobject/model/OverviewReport.java

@@ -1,35 +1,62 @@
 package de.jplag.reportingV2.reportobject.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import java.util.List;
 import java.util.Set;
 
 public class OverviewReport {
 
-    private String submission_folder_path;
-    private String base_code_folder_path;
+    @JsonProperty("submission_folder_path")
+    private String submissionFolderPath;
+
+    @JsonProperty("base_code_folder_path")
+    private String baseCodeFolderPath;
+
+    @JsonProperty("language")
     private String language;
-    private List<String> file_extensions;
-    private List<String> submission_ids;
-    private List<String> failed_submission_names;
-    private Set<String> excluded_files;
-    private int match_sensitivity;
-    private String date_of_execution;
-    private long execution_time;
-    private List<String> comparison_names;
+
+    @JsonProperty("file_extensions")
+    private List<String> fileExtensions;
+
+    @JsonProperty("submission_ids")
+    private List<String> submissionIds;
+
+    @JsonProperty("failed_submission_names")
+    private List<String> failedSubmissionNames;
+
+    @JsonProperty("excluded_files")
+    private Set<String> excludedFiles;
+
+    @JsonProperty("match_sensitivity")
+    private int matchSensitivity;
+
+    @JsonProperty("date_of_execution")
+    private String dateOfExecution;
+
+    @JsonProperty("execution_time")
+    private long executionTime;
+
+    @JsonProperty("comparison_names")
+    private List<String> comparisonNames;
+
+    @JsonProperty("metrics")
     private List<Metric> metrics;
+
+    @JsonProperty("clusters")
     private List<Cluster> clusters;
 
     public OverviewReport() {
-        submission_folder_path = "";
-        base_code_folder_path = "";
+        submissionFolderPath = "";
+        baseCodeFolderPath = "";
         language = "";
-        file_extensions = List.of();
-        submission_ids = List.of();
-        failed_submission_names = List.of();
-        excluded_files = Set.of();
-        match_sensitivity = 0;
-        date_of_execution = "";
-        execution_time = 0;
+        fileExtensions = List.of();
+        submissionIds = List.of();
+        failedSubmissionNames = List.of();
+        excludedFiles = Set.of();
+        matchSensitivity = 0;
+        dateOfExecution = "";
+        executionTime = 0;
         clusters = List.of();
     }
 
@@ -37,48 +64,48 @@ public class OverviewReport {
      * GETTERS
      *******************************/
 
-    public String getSubmission_folder_path() {
-        return submission_folder_path;
+    public String getSubmissionFolderPath() {
+        return submissionFolderPath;
     }
 
-    public String getBase_code_folder_path() {
-        return base_code_folder_path;
+    public String getBaseCodeFolderPath() {
+        return baseCodeFolderPath;
     }
 
     public String getLanguage() {
         return language;
     }
 
-    public List<String> getFile_extensions() {
-        return file_extensions;
+    public List<String> getFileExtensions() {
+        return fileExtensions;
     }
 
-    public List<String> getSubmission_ids() {
-        return submission_ids;
+    public List<String> getSubmissionIds() {
+        return submissionIds;
     }
 
-    public List<String> getFailed_submission_names() {
-        return failed_submission_names;
+    public List<String> getFailedSubmissionNames() {
+        return failedSubmissionNames;
     }
 
-    public Set<String> getExcluded_files() {
-        return excluded_files;
+    public Set<String> getExcludedFiles() {
+        return excludedFiles;
     }
 
-    public int getMatch_sensitivity() {
-        return match_sensitivity;
+    public int getMatchSensitivity() {
+        return matchSensitivity;
     }
 
-    public String getDate_of_execution() {
-        return date_of_execution;
+    public String getDateOfExecution() {
+        return dateOfExecution;
     }
 
-    public long getExecution_time() {
-        return execution_time;
+    public long getExecutionTime() {
+        return executionTime;
     }
 
-    public List<String> getComparison_names() {
-        return comparison_names;
+    public List<String> getComparisonNames() {
+        return comparisonNames;
     }
 
     public List<Metric> getMetrics() {
@@ -93,48 +120,48 @@ public class OverviewReport {
      * SETTERS
      *******************************/
 
-    public void setSubmission_folder_path(String submission_folder_path) {
-        this.submission_folder_path = submission_folder_path;
+    public void setSubmissionFolderPath(String submissionFolderPath) {
+        this.submissionFolderPath = submissionFolderPath;
     }
 
-    public void setBase_code_folder_path(String base_code_folder_path) {
-        this.base_code_folder_path = base_code_folder_path;
+    public void setBaseCodeFolderPath(String baseCodeFolderPath) {
+        this.baseCodeFolderPath = baseCodeFolderPath;
     }
 
     public void setLanguage(String language) {
         this.language = language;
     }
 
-    public void setFile_extensions(List<String> file_extensions) {
-        this.file_extensions = List.copyOf(file_extensions);
+    public void setFileExtensions(List<String> fileExtensions) {
+        this.fileExtensions = List.copyOf(fileExtensions);
     }
 
-    public void setSubmission_ids(List<String> submission_ids) {
-        this.submission_ids = List.copyOf(submission_ids);
+    public void setSubmissionIds(List<String> submissionIds) {
+        this.submissionIds = List.copyOf(submissionIds);
     }
 
-    public void setFailed_submission_names(List<String> failed_submission_names) {
-        this.failed_submission_names = List.copyOf(failed_submission_names);
+    public void setFailedSubmissionNames(List<String> failedSubmissionNames) {
+        this.failedSubmissionNames = List.copyOf(failedSubmissionNames);
     }
 
-    public void setExcluded_files(Set<String> excluded_files) {
-        this.excluded_files = Set.copyOf(excluded_files);
+    public void setExcludedFiles(Set<String> excludedFiles) {
+        this.excludedFiles = Set.copyOf(excludedFiles);
     }
 
-    public void setMatch_sensitivity(int match_sensitivity) {
-        this.match_sensitivity = match_sensitivity;
+    public void setMatchSensitivity(int matchSensitivity) {
+        this.matchSensitivity = matchSensitivity;
     }
 
-    public void setDate_of_execution(String date_of_execution) {
-        this.date_of_execution = date_of_execution;
+    public void setDateOfExecution(String dateOfExecution) {
+        this.dateOfExecution = dateOfExecution;
     }
 
-    public void setExecution_time(long execution_time) {
-        this.execution_time = execution_time;
+    public void setExecutionTime(long executionTime) {
+        this.executionTime = executionTime;
     }
 
-    public void setComparison_names(List<String> comparison_names) {
-        this.comparison_names = List.copyOf(comparison_names);
+    public void setComparisonNames(List<String> comparisonNames) {
+        this.comparisonNames = List.copyOf(comparisonNames);
     }
 
     public void setMetrics(List<Metric> metrics) {

jplag/src/main/java/de/jplag/reportingV2/reportobject/model/TopComparison.java

@@ -1,27 +1,34 @@
 package de.jplag.reportingV2.reportobject.model;
 
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 public class TopComparison {
 
-    private final String first_submission;
-    private final String second_submission;
-    private final float match_percentage;
+    @JsonProperty("first_submission")
+    private final String firstSubmission;
+
+    @JsonProperty("second_submission")
+    private final String secondSubmission;
+
+    @JsonProperty("match_percentage")
+    private final float matchPercentage;
 
-    public TopComparison(String first_submission, String second_submission, float match_percentage) {
-        this.first_submission = first_submission;
-        this.second_submission = second_submission;
-        this.match_percentage = match_percentage;
+    public TopComparison(String firstSubmission, String secondSubmission, float matchPercentage) {
+        this.firstSubmission = firstSubmission;
+        this.secondSubmission = secondSubmission;
+        this.matchPercentage = matchPercentage;
     }
 
-    public String getFirst_submission() {
-        return first_submission;
+    public String getFirstSubmission() {
+        return firstSubmission;
     }
 
-    public String getSecond_submission() {
-        return second_submission;
+    public String getSecondSubmission() {
+        return secondSubmission;
     }
 
-    public float getMatch_percentage() {
-        return match_percentage;
+    public float getMatchPercentage() {
+        return matchPercentage;
     }
 
 }