From 5b98e7d39356414083bdec98026c11c2bf078b49 Mon Sep 17 00:00:00 2001 From: Alexander Vogt Date: Sun, 15 Sep 2024 08:38:04 +0200 Subject: [PATCH] update section on report file generation --- docs/6.-Report-File-Generation.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/6.-Report-File-Generation.md b/docs/6.-Report-File-Generation.md index 3753993d6..3d1fd24d6 100644 --- a/docs/6.-Report-File-Generation.md +++ b/docs/6.-Report-File-Generation.md @@ -32,6 +32,11 @@ result.zip │ submission2-submission....json │ submission2-submissionN.json │ ... +│ +└───basecode +│ └───submissionId1.json +│ └───submissionId2.json +│ ... ``` The report zip contains @@ -41,20 +46,21 @@ The report zip contains - The `overview.json` encapsulates the main information from a JPlagResult such as base directory path, language, min- and max-metric, etc. The `overview.json` provides data to the `OverviewView.vue` that is first displayed after the report is dropped into the viewer. Corresponds to the Java record `OverviewReport`. - submissionFileIndex.json - - The `submissionFileIndex.json` stores a list of all files in the submission for each submission id. + - The `submissionFileIndex.json` stores a list of all files in the submission for each submission id. This file is also used to track the tokens per file. It is represented by a Map from the submission id to an instance of `SubmissionFile`. - options.json - - This File contains all options given to JPlag either over the CLI or programmatically + - This File contains all options given to JPlag either over the CLI or programmatically. It is represented diretly by the `JPlagOptions` class. - submissions - - This folder contains all files of all submissions JPlag was run with. For each submission the `submissions` folder contains a subfolder with the name of the corresponding submission id. A subfolder for a submission contains all files of said submission. These files are displayed in the `ComparisonView.vue` - comparison files - - For each submission pair submission1 submission2 with ids submissionId1 and submissionId2, the report contains either submissionId1-submissionId2.json or submissionId2-submissionId1.json. This file contains information the comparison between the two submissions, such as the similarity and concrete matches. Corresponds to the Java record `ComparisonReport`. +- base code + - Each JSON file in the `basecode` folder contains the data where the provided basecode was found in each submission. Each submission has its own file. If no basecode was provided, each file contains an empty array of matches. Each JSON file corresponds to an array the Java record `BaseCodeMatch`. + ## Submission ids ### Report Viewer @@ -89,5 +95,5 @@ Task: Adding the number of tokens in a match, which has to be displayed in the M 2. Modify the existing component `ComparisonReportWriter.java` to additionally extract the number of tokens in a match from the `JPlagResult.java` and save it in the Match DTO 3. Add `tokens: number` to `Match.ts` -4. Edit `ComparisonFactory.ts` to get the number of tokens from the JSON report file. [report-viewer] -5. Edit `MatchTable.vue` to display the tokens number in the `ComparisonView.vue`. +4. Edit `ComparisonFactory.ts` to get the number of tokens from the JSON report file. +5. Edit `MatchList.vue` to display the tokens number in the `ComparisonView.vue`. \ No newline at end of file