Package uk.ac.warwick.dcs.sherlock.engine.report

Class ReportGenerator

java.lang.Object

uk.ac.warwick.dcs.sherlock.engine.report.ReportGenerator

All Implemented Interfaces:

IReportGenerator<SubmissionMatchGroup>

public class ReportGenerator
extends java.lang.Object
implements IReportGenerator<SubmissionMatchGroup>

Method Summary

Modifier and Type	Method	Description
java.util.List<SubmissionMatchGroup>	generateSubmissionComparison(java.util.List<ISubmission> submissions, java.util.List<? extends ICodeBlockGroup> codeBlockGroups)	Compare two submissions and find all the instances of detected plagiarism between all files within them.
ITuple<java.util.List<SubmissionMatchGroup>,java.lang.String>	generateSubmissionReport(ISubmission submission, java.util.List<? extends ICodeBlockGroup> codeBlockGroups, float subScore)	Generate a report for a single submission, containing all matches for all files within it, and creating a summary in the process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

generateSubmissionComparison

public java.util.List<SubmissionMatchGroup> generateSubmissionComparison(java.util.List<ISubmission> submissions,
                                                                         java.util.List<? extends ICodeBlockGroup> codeBlockGroups)

Description copied from interface: IReportGenerator

Compare two submissions and find all the instances of detected plagiarism between all files within them.

Specified by:

generateSubmissionComparison in interface IReportGenerator<SubmissionMatchGroup>

Parameters:

submissions - The submissions to compare (should be a list of two submissions only; any submissions beyond the first two are ignored)

codeBlockGroups - The ICodeBlockGroups that contain at least one file from either submission.

Returns:

a list of SubmissionMatchGroup objects, which each contain a list of SubmissionMatches and a score for the corresponding IResultTask.

generateSubmissionReport

public ITuple<java.util.List<SubmissionMatchGroup>,java.lang.String> generateSubmissionReport(ISubmission submission,
                                                                                                    java.util.List<? extends ICodeBlockGroup> codeBlockGroups,
                                                                                                    float subScore)

Description copied from interface: IReportGenerator

Generate a report for a single submission, containing all matches for all files within it, and creating a summary in the process.

Specified by:

generateSubmissionReport in interface IReportGenerator<SubmissionMatchGroup>

Parameters:

submission - The submission to generate the report for.

codeBlockGroups - The ICodeBlockGroups that contain at least one file from the submission.

subScore - The overall score for this submission.

Returns:

a tuple containing a list of SubmissionMatchGroup objects, which each contain a list of SubmissionMatches and a score for the corresponding IResultTask. The tuple also contains a string which serves as a summary of the report.