Interface IReportManager<T extends ISubmissionMatchGroup,S extends ISubmissionSummary>
-
- All Known Implementing Classes:
ReportManager
public interface IReportManager<T extends ISubmissionMatchGroup,S extends ISubmissionSummary>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<S>GetMatchingSubmissions()To be called by the web report pages.java.util.List<T>GetSubmissionComparison(java.util.List<ISubmission> submissions)Compares two submissions, finds all the matches in files they contain between them, and returns all relevant information about them.ITuple<java.util.List<T>,java.lang.String>GetSubmissionReport(ISubmission submission)Generate a report for a single submission, containing all matches for all files within it, and a summary of the report as a string.
-
-
-
Method Detail
-
GetMatchingSubmissions
java.util.List<S> GetMatchingSubmissions()
To be called by the web report pages. Gets a list of submission summaries.- Returns:
- a list of the matching SubmissionSummaries, each containing their ids, overall scores, and a list of the submissions that they were matched with.
-
GetSubmissionComparison
java.util.List<T> GetSubmissionComparison(java.util.List<ISubmission> submissions)
Compares two submissions, finds all the matches in files they contain between them, and returns all relevant information about them.- Parameters:
submissions- The submissions to compare (should be a list of two submissions only; any submissions beyond the first two are ignored)- Returns:
- A list of SubmissionMatchGroup objects which contain lists of SubmissionMatch objects; each have ids of the two matching files, a score for the match, a reason from the DetectionType, and the line numbers in each file where the match occurs.
-
GetSubmissionReport
ITuple<java.util.List<T>,java.lang.String> GetSubmissionReport(ISubmission submission)
Generate a report for a single submission, containing all matches for all files within it, and a summary of the report as a string.- Parameters:
submission- The submission to generate the report for.- Returns:
- A tuple. The key contains a list of SubmissionMatchGroup objects which contain lists of SubmissionMatch objects; each have objects which contain ids of the two matching files, a score for the match, a reason from the DetectionType, and the line numbers in each file where the match occurs. The value is the report summary.
-
-