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

Class SubmissionMatchGroup

java.lang.Object

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

All Implemented Interfaces:

ISubmissionMatchGroup<SubmissionMatch>

public class SubmissionMatchGroup
extends java.lang.Object
implements ISubmissionMatchGroup<SubmissionMatch>

Object to store SubmissionMatches; every SubmissionMatch within one SubmissionMatchGroup should share the same DetectionType.

Constructor Summary

Constructors

Constructor	Description
SubmissionMatchGroup(java.util.List<SubmissionMatch> matches, java.lang.String reason)	Create a new SubmissionMatchGroup

Method Summary

Modifier and Type	Method	Description
void	addMatch(SubmissionMatch match)	Add a SubmissionMatch to the list (used by ReportGenerator)
java.util.List<SubmissionMatch>	getMatches()	Get the matches
java.lang.String	getReason()	Get the descriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

SubmissionMatchGroup

public SubmissionMatchGroup(java.util.List<SubmissionMatch> matches,
                            java.lang.String reason)

Create a new SubmissionMatchGroup

Parameters:

matches - A list of all SubmissionMatch objects that were generated based off of a single IResultTask.

reason - A string that describes why these matches were flagged for plagiarism.

Method Detail

addMatch

public void addMatch(SubmissionMatch match)

Add a SubmissionMatch to the list (used by ReportGenerator)

Specified by:

addMatch in interface ISubmissionMatchGroup<SubmissionMatch>

Parameters:

match - the SubmissionMatch to be added

getMatches

public java.util.List<SubmissionMatch> getMatches()

Get the matches

Specified by:

getMatches in interface ISubmissionMatchGroup<SubmissionMatch>

Returns:

The stored list of SubmissionMatch objects.

getReason

public java.lang.String getReason()

Get the descriptor

Specified by:

getReason in interface ISubmissionMatchGroup<SubmissionMatch>

Returns:

The type of plagiarism that was detected for these matches.