A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages

A

AbstractModelTaskRawResult - Class in uk.ac.warwick.dcs.sherlock.api.model.postprocessing

Raw results storage class, acts a stored cache.

AbstractModelTaskRawResult() - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.AbstractModelTaskRawResult

Account - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.db

The account database table

Account() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

Account(String, String, String) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

AccountController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account

The controller that deals with account settings pages

AccountController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

AccountEmailForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form for changing an account email

AccountEmailForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

AccountEmailForm(Account) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

AccountForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form for creating a new sub-account

AccountForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

AccountForm(Account) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

AccountNameForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form for changing an account name

AccountNameForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountNameForm

AccountNameForm(Account) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountNameForm

AccountNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown when the account is not found on the admin settings page

AccountNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.AccountNotFound

AccountOwner - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown when a user attempts to modify their own account through the admin account settings page

AccountOwner(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.AccountOwner

AccountPasswordForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form for changing an account password

AccountPasswordForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

AccountRepository - Interface in uk.ac.warwick.dcs.sherlock.module.web.data.repositories

The database repository storing the account details

AccountWrapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

Somehow if you use form binding to set a variable with the same name as a variable in the Account object, the variable in the ModelAttribute("account") instance of the Account object is overwritten.

AccountWrapper() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

AccountWrapper(Account) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

ACTIVE - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

add(NgramMatch) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.scoring.NGramScorer

Adds files and their score info to the group data structure.

addCodeBlock(ISourceFile, float, List<ITuple<Integer, Integer>>) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

Adds a code block to the group

addCodeBlock(ISourceFile, float, List<ITuple<Integer, Integer>>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

addCodeBlock(ISourceFile, float, ITuple<Integer, Integer>) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

Adds a code block to the group

addCodeBlock(ISourceFile, float, ITuple<Integer, Integer>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

addContainingBlock(Collection<ICodeBlockGroup>) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Adds a collection of code block groups found using the tasks detector which all contain the file

addContainingBlock(Collection<ICodeBlockGroup>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

addContainingBlock(ICodeBlockGroup) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Adds a code block group found using the tasks detector which contains the file

addContainingBlock(ICodeBlockGroup) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

addDefaultDetectionTypes() - Static method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Default types included with the API

addDetector(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Add a detector to the job, a job for each detector will be created when the job is prepared

addDetector(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

addFile(ISourceFile) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultJob

Adds a file to the result set

addFile(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultJob

addFileScore(ISourceFile, float) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Adds an aggregate score from all tasks of the instance file against another file

addFileScore(ISourceFile, float) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Adds a score from the task of the instance file against another file

addFileScore(ISourceFile, float) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

addFileScore(ISourceFile, float) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

addGet(Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.TemplatesController

Handles GET requests to the add template page

addGet(Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.WorkspacesController

Handles GET requests to the add workspace page

addGet(Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.AdminController

Handles GET requests to the add account page

addGroup() - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Creates a new ICodeBlockGroup instance, adds it to the results list and returns it

addInterceptors(InterceptorRegistry) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.MvcConfig

Adds the above interceptor bean to the application’s interceptor registry

addIsAjax(Model, HttpServletRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Adds an "is ajax" boolean to the attributes of all requests

addIsPrinting(Model, HttpServletRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Adds an "is printing" boolean to the attribute of all requests

addJsUrl(Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Sets the javascript url to the standard version when running the webdev profile and the minified in all other cases

addMatch(T) - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatchGroup

Add a SubmissionMatch to the list (used by ReportGenerator)

addMatch(SubmissionMatch) - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchGroup

Add a SubmissionMatch to the list (used by ReportGenerator)

AddMatch(FileMatch) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.LineMapper

Fills the temp map with line numbers where matched code blocks start.

AddMatchingSubmissions(List<? extends ITuple<Long, Float>>) - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionSummary

Adds new submissions to the matchingSubmissions list that this submission had plagiarism detected between.

addMessage(Model, HttpServletRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Adds the msg parameter to the attributes of all requests

addModelDataItem(ModelDataItem) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

addModelDataItem(ModelDataItem) - Method in interface uk.ac.warwick.dcs.sherlock.engine.executor.work.IWorkTask

addPost(TemplateForm, BindingResult, AccountWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.TemplatesController

Handles POST requests to the add template page

addPost(WorkspaceForm, BindingResult, AccountWrapper, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.WorkspacesController

Handles POST requests to the add workspace page

addPost(AccountWrapper, AccountForm, BindingResult, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.AdminController

Handles POST requests to the add account page, creating a new account with a random password if validation succeeds

addPreProcessedLines(String, List<IndexedString>) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.ModelDataItem

Adds a mapping for a preprocessing strategy

addScoredBlock(ISourceFile, ICodeBlockGroup) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.scoring.NGramScorer

Adds a block for the current file to the current groups output data structure along with its score.

addSubmissions(SubmissionsForm) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Add submissions to this workspace

addTaskResult(ITask) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Adds a task (an individual detector run) to the file results

addTaskResult(ITask) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

addTo(float) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

AdjustableParameter - Annotation Type in uk.ac.warwick.dcs.sherlock.api.annotation

Annotation to define a parameter as adjustable by the UI.

AdjustableParameterObj - Class in uk.ac.warwick.dcs.sherlock.api.annotation

An object to wrap an adjustable parameter annotation with other information commonly required when working with it

AdjustableParameterObj(AdjustableParameter, Field, boolean) - Constructor for class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

AdminController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin

The controller that deals with the admin settings pages

AdminController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.AdminController

afterStartup() - Method in class uk.ac.warwick.dcs.sherlock.launch.SherlockServer

aggregateScores(Collection<Float>) - Static method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.ExecutorUtils

does average of list

AnnotationLoader - Class in uk.ac.warwick.dcs.sherlock.engine

Responsible for all classloading and reflection

AtomicFloat - Class in uk.ac.warwick.dcs.sherlock.engine.executor.common

Implementation of an AtomicFloat class, using intBitsToFloat to get and floatToIntBits to set

AtomicFloat() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

AtomicFloat(float) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

AttributesControllerAdvice - Class in uk.ac.warwick.dcs.sherlock.module.web.controlleradvice

Declares ModelAttributes for all controllers

AttributesControllerAdvice() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

B

BaseExecutor - Class in uk.ac.warwick.dcs.sherlock.engine.executor

Basic executor implementation

BaseExecutor() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

BaseStorage - Class in uk.ac.warwick.dcs.sherlock.engine.storage

Basic storage implementation

BaseStorage() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

BaseStorageFilesystem - Class in uk.ac.warwick.dcs.sherlock.engine.storage

Handles file system access stuff, encryption etc

BaseStorageFilesystem() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorageFilesystem

buildFieldReference(Field) - Static method in class uk.ac.warwick.dcs.sherlock.api.util.SherlockHelper

Builds the reference string of a field by prepending the declaring class name

buildWorkers(List<ModelDataItem>) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.Detector

Builds a set of workers on a passed dataset, these workers are executed in parallel to produce the algorithm result

buildWorkers(List<ModelDataItem>) - Method in interface uk.ac.warwick.dcs.sherlock.api.model.detection.IDetector

Builds a set of workers on a passed dataset, these workers are executed in parallel to produce the algorithm result

buildWorkers(List<ModelDataItem>) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetector

Builds a set of workers on a passed dataset, these workers are executed in parallel to produce the algorithm result

C

calculateProgressIncrement(int) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

call() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

cancelJob(IJob) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

Cancels the execution of a job

cancelJob(IJob) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

cancelJob(IJobStatus) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

Cancels the execution of a job

cancelJob(IJobStatus) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

checkLineFinished(List<IndexedString>, StringBuilder, int, Token) - Static method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardStringifier

Method to check if a line has been finished, if it has it adds the line to the output and moves onto the next

checkLoaded() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Checks that the Spring server has finished initialising and throws an error if a user attempts to load a page before it has finished

checkSize(int, ArrayList<NgramMatch>) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.scoring.NGramScorer

Check if the set of files is enough to be considered "common".

classloader - Static variable in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

cleanGroups() - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Remove empty groups from the list, or ones with an unknown detection type

CLIENT - uk.ac.warwick.dcs.sherlock.api.util.Side

clone() - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

clone() - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

close() - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Shutdown the database

close() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

close() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

close() - Method in class uk.ac.warwick.dcs.sherlock.module.client.Splash

CodeBlock - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.internal

Code blocks used by the results section of the website

CodeBlock(int, int) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.CodeBlock

Initialise this code block without a match

CodeBlock(int, int, int) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.CodeBlock

Initialise this code block with a match

colours - Static variable in class uk.ac.warwick.dcs.sherlock.module.web.data.results.ResultsHelper

Array of colours for the get colour method

COMMENT - uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification.channels

CommentExtractor - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

CommentExtractor() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.CommentExtractor

CommentRemover - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

CommentRemover() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.CommentRemover

common - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NgramMatch

Used to allow skipping during score methods if the math is considered common.

compare(ArrayList<NGramDetector.Ngram>, ArrayList<NGramDetector.Ngram>) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector

Compare 2 lists of N-grams and return a similarity metric

compareAndSet(float, float) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

CompareSameSubmission - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the user tries to compare a submission against itself

CompareSameSubmission(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.CompareSameSubmission

compareTo(ISubmission) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

compareTo(IJobStatus) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

compareTo(IJobStatus) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

comparisonGet(WorkspaceWrapper, JobResultsData, long, long, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests for the compare submission page

COMPLETE - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

compute() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.work.WorkDetect

compute() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.work.WorkPreProcessFile

compute() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.work.WorkPreProcessFiles

configuration - Static variable in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

Configuration - Class in uk.ac.warwick.dcs.sherlock.engine

Mapping for the configuration file

Configuration() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.Configuration

configure(SpringApplicationBuilder) - Method in class uk.ac.warwick.dcs.sherlock.launch.SherlockServer

configure(AuthenticationManagerBuilder) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.SecurityConfig

Configures the web security by configuring the authentication manager to use the custom user details service that links into the datbase

configure(HttpSecurity) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.SecurityConfig

Configures the http security to prevent unauthorised requests to the account/admin pages as well as enable the login/logout pages

confirmPassword - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

confirmPassword - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.PasswordForm

copy(AccountWrapper, TemplateRepository, TDetectorRepository, TParameterRepository) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Make a copy the template

copyPost(AccountWrapper, TemplateWrapper) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles POST requests to the copy template page

createJob() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

Creates a new job instance

createJob() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

createNewResult() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Return a new JobResult instance

createNewResult() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

createQuery(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

createQuery(String, Class<X>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

createWorkspace(String, String) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Create a new IWorkspace instance

createWorkspace(String, String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

CustomUserDetailsService - Class in uk.ac.warwick.dcs.sherlock.module.web.services

The custom user details service which fetches the account and their roles from the database from the authentication session information

CustomUserDetailsService() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.services.CustomUserDetailsService

D

DashboardController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard

The controller that deals with the dashboard homepage

DashboardController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.DashboardController

dataSource() - Method in class uk.ac.warwick.dcs.sherlock.launch.SherlockServer

DEFAULT - uk.ac.warwick.dcs.sherlock.engine.executor.common.Priority

DEFAULT - uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification.channels

defaultValue() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameter

default value the parameter takes

delete(TemplateRepository) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Delete the template

delete(WorkspaceRepository) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Delete the workspace

deleteFileGet(ISubmission, long, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.SubmissionController

Handles GET requests to the delete file page

deleteFilePost(WorkspaceWrapper, ISubmission, long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.SubmissionController

Handles POST requests to the delete file page

deleteGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles GET requests to the delete template page

deleteGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests to the delete results page

deleteGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.SubmissionController

Handles GET requests to the delete submission page

deleteGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles GET requests to the delete workspace page

deleteGet(Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.SubaccountController

Handles GET requests to the delete account page

deletePost(PasswordForm, BindingResult, AccountWrapper, AccountWrapper, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.SubaccountController

Handles POST requests to the delete account page

deletePost(TemplateWrapper) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles POST requests to the delete template page

deletePost(WorkspaceWrapper) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles POST requests to the delete workspace page

deletePost(WorkspaceWrapper, ISubmission) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.SubmissionController

Handles POST requests to the delete submission page

deletePost(WorkspaceWrapper, JobResultsData) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests to the delete results page

description() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameter

Optional, detailed description of what the parameter does

detailsGetFragment(long, TemplateWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles GET requests to the template details page

detailsGetFragment(long, WorkspaceWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles the GET request to the workspace details fragment

detailsPostFragment(long, TemplateWrapper, boolean, TemplateForm, BindingResult, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles POST requests to the details template page

detailsPostFragment(long, WorkspaceWrapper, boolean, WorkspaceForm, BindingResult, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles POST requests to the workspace details fragment

DetectionType - Class in uk.ac.warwick.dcs.sherlock.api.model.detection

Class to specify an individual detection type, these are used to mark detected blocks, so that verbose reports can be generated

DetectionType(String, String, String, double) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Detector<T extends DetectorWorker> - Class in uk.ac.warwick.dcs.sherlock.api.model.detection

Abstract implementation of the IDetector interface, this should be used as the base to construct all detectors

Supports adjustable parameters see AdjustableParameter

Detector(String, String, PreProcessingStrategy...) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.Detector

IDetector implementation with description

Detector(String, PreProcessingStrategy...) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.Detector

IDetector implementation without description

DetectorController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template

The controller that deals with the template detector pages

DetectorController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.DetectorController

DetectorNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown when the detector was not found

DetectorNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.DetectorNotFound

detectors - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

detectorsGetFragment(long, TemplateWrapper, boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles GET requests to the template detectors page

detectorsGetFragment(Model, boolean, String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.TemplatesController

Handles GET requests to the detectors list page, which lists the detectors available for the specified language

DetectorWorker<K extends AbstractModelTaskRawResult> - Class in uk.ac.warwick.dcs.sherlock.api.model.detection

Top level interface workers are required to implement

DetectorWorker(IDetector) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectorWorker

Constructor for workers

DetectorWrapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

The wrapper that manages database detectors

DetectorWrapper() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Empty initialiser

DetectorWrapper(long, Account, TDetectorRepository) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Initialise the wrapper by trying to find a detector that is either owned by the account or is public

DetectorWrapper(TDetector, boolean) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Initialise the wrapper with a template that has already been loaded

dismissJob(IJob) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

removes a finished job from the list of statuses

dismissJob(IJob) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

dismissJob(IJobStatus) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

removes a finished job from the list of statuses

dismissJob(IJobStatus) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

dismissPost(long, long, JobResultsData) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class uk.ac.warwick.dcs.sherlock.module.web.filters.HeaderFilter

Adds the URI of the request as a new "sherlock-url" header variable in the http response.

doubleValue() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

duplicate - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

E

email - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

email - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

emailGetFragment(Model, boolean, AccountWrapper) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

Handles GET requests to the email fragment of the account page

emailPostFragment(boolean, AccountWrapper, AccountEmailForm, BindingResult, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

Handles the POST requests to the email fragment on the accounts page

EmbeddedDatabase - Class in uk.ac.warwick.dcs.sherlock.engine.storage

Database access stuff

EmbeddedDatabase() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

engine - Static variable in class uk.ac.warwick.dcs.sherlock.launch.SherlockServer

EngineDetectorWrapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

The wrapper that manages engine detectors

EngineDetectorWrapper(Class<? extends IDetector>) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Initialise the wrapper class using the detector entity

EntityArchive - Class in uk.ac.warwick.dcs.sherlock.engine.storage

ISubmission object for base storage implementation

EntityArchive() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

EntityArchive(String) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

EntityCodeBlock - Class in uk.ac.warwick.dcs.sherlock.engine.storage

ICodeBlock object for base storage implementation

EntityCodeBlockGroup - Class in uk.ac.warwick.dcs.sherlock.engine.storage

ICodeBlockGroup object for base storage implementation

EntityCodeBlockGroup() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

EntityFile - Class in uk.ac.warwick.dcs.sherlock.engine.storage

ISourceFile object for base storage implementation

EntityFile(EntityArchive, String, String, Timestamp, long, int, int) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

EntityJob - Class in uk.ac.warwick.dcs.sherlock.engine.storage

IJob object for base storage implementation

EntityJob() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

EntityJob(EntityWorkspace) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

EntityResultFile - Class in uk.ac.warwick.dcs.sherlock.engine.storage

IResultFile object for base storage implementation

EntityResultJob - Class in uk.ac.warwick.dcs.sherlock.engine.storage

IResultJob object for base storage implementation

EntityResultTask - Class in uk.ac.warwick.dcs.sherlock.engine.storage

IResultTask object for base storage implementation

EntityTask - Class in uk.ac.warwick.dcs.sherlock.engine.storage

ITask object for base storage implementation

EntityTask() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

EntityTask(EntityJob, Class<? extends IDetector>) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

EntityWorkspace - Class in uk.ac.warwick.dcs.sherlock.engine.storage

IWorkspace object for base storage implementation

EntityWorkspace() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

EntityWorkspace(String, String) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

equals(Object) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.CodeBlock

Compare this code block against another object to see if they match

equals(ISourceFile) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

File equality check

equals(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

equals(ISubmission) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

submission equality check

equals(ISubmission) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

equals(ITuple) - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

equals(ITuple) - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

equals(NgramMatch) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NgramMatch

Checks if the two stored blocks are the same.

EventBus - Class in uk.ac.warwick.dcs.sherlock.api.event

Static wrapper for the event bus (IEventBus implementation).

EventBus() - Constructor for class uk.ac.warwick.dcs.sherlock.api.event.EventBus

EventHandler - Annotation Type in uk.ac.warwick.dcs.sherlock.api.annotation

Marks a method as an event handler.

EventInitialisation - Class in uk.ac.warwick.dcs.sherlock.api.event

Event for the initialisation step of startup.

EventInitialisation() - Constructor for class uk.ac.warwick.dcs.sherlock.api.event.EventInitialisation

EventPostInitialisation - Class in uk.ac.warwick.dcs.sherlock.api.event

Event for the post initialisation step of startup.

EventPostInitialisation() - Constructor for class uk.ac.warwick.dcs.sherlock.api.event.EventPostInitialisation

EventPreInitialisation - Class in uk.ac.warwick.dcs.sherlock.api.event

Event for the pre initialisation step of startup.

EventPreInitialisation() - Constructor for class uk.ac.warwick.dcs.sherlock.api.event.EventPreInitialisation

EventPublishResults - Class in uk.ac.warwick.dcs.sherlock.api.event

Not Used!!! Maybe Future work

EventPublishResults(String) - Constructor for class uk.ac.warwick.dcs.sherlock.api.event.EventPublishResults

ExceptionControllerAdvice - Class in uk.ac.warwick.dcs.sherlock.module.web.controlleradvice

Handles exceptions thrown by all of the controllers

ExceptionControllerAdvice() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.ExceptionControllerAdvice

execute() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectorWorker

Do work and create the results

execute() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector.NGramDetectorWorker

execute() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.VariableNameDetectorWorker

executeUpdate(Query) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

executor - Static variable in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

ExecutorUtils - Class in uk.ac.warwick.dcs.sherlock.engine.executor.common

Various executor utilities

ExecutorUtils() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.common.ExecutorUtils

F

file_list - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.scoring.NGramScorer

file1 - Variable in class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetectorWorker

file2 - Variable in class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetectorWorker

fileGet(ISubmission, long, boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.SubmissionController

Handles GET requests to the view file page

FileMapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.results

Maps a set of files to the "line mapper" object which links each plagiarised line to a match

FileMapper(Map<String, List<FileMatch>>) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.results.FileMapper

Initialise the file mapper

FileMatch - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.internal

Stores the details of a match between two files

FileMatch(SubmissionMatch) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Initialise this match

filePresent(ISourceFile) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

Tests whether a passed file is included in the group

filePresent(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

files - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NgramMatch

The two files with matching sections.

files - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

FileUploadFailed - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the file failed to upload when adding a submission

FileUploadFailed(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.FileUploadFailed

Fill() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.LineMapper

This function needs to be called after all the matches have been added using the "addMatch" method, it will then fill in the gaps from the start line number to the end line number for each code block.

findByAccount(Account) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.WorkspaceRepository

Finds all workspaces owned by the supplied account

findByAccount(Account, WorkspaceRepository) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Gets the list of workspaces owned by the current user

findByAccountAndPublic(Account) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.TemplateRepository

Finds all templates that are owned by the account or are public

findByAccountAndPublic(Account, TemplateRepository) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Get the list of templates that are public or owned by the user

findByAccountAndPublicAndLanguage(Account, String) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.TemplateRepository

Finds all templates of a specific language that are owned by the account or are public

findByAccountAndPublicAndLanguage(Account, TemplateRepository, String) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Get the list of templates that are public, owned by the user and filter by the language supplied

findByEmail(String) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.AccountRepository

Find the account with the supplied email

findByIdAndAccount(long, Account) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.WorkspaceRepository

Finds a workspace with the supplied id and owned by the supplied account

findByIdAndPublic(long, Account) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.TemplateRepository

Finds the template with the id supplied only if it is owned by the account supplied or is public

findByNameAndTemplate(String, Template) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.TDetectorRepository

Finds the detector with the supplied name that is linked to the supplied template

findByTDetector(TDetector) - Method in interface uk.ac.warwick.dcs.sherlock.module.web.data.repositories.TParameterRepository

Finds all the parameters that are linked to the supplied detector

finishJob() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

floatValue() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

G

generateRandomPassword() - Static method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.SecurityConfig

Generates a random password for new accounts or when an admin changes the password on an account

generateSubmissionComparison(List<ISubmission>, List<? extends ICodeBlockGroup>) - Method in interface uk.ac.warwick.dcs.sherlock.api.report.IReportGenerator

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

generateSubmissionComparison(List<ISubmission>, List<? extends ICodeBlockGroup>) - Method in class uk.ac.warwick.dcs.sherlock.engine.report.ReportGenerator

generateSubmissionReport(ISubmission, List<? extends ICodeBlockGroup>, float) - Method in interface uk.ac.warwick.dcs.sherlock.api.report.IReportGenerator

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

generateSubmissionReport(ISubmission, List<? extends ICodeBlockGroup>, float) - Method in class uk.ac.warwick.dcs.sherlock.engine.report.ReportGenerator

get() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

getAbstractPairwiseDetectorWorker(ModelDataItem, ModelDataItem) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetector

Fetches a new instance of the worker for this implementation

getAccount() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

getAccount() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

getAccount() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getAccount(Model, Authentication) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Gets the account of the currently logged in user using the authentication details and adds it to the model attributes

getAdvancedPostProcessorForLanguage(Class<? extends IAdvancedPreProcessorGroup>, String) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Fetches a tuple containing the correct AdvancedPreProcessor and Lexer implementations for this group/language combination

getAdvancedPostProcessorForLanguage(Class<? extends IAdvancedPreProcessorGroup>, String) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Fetches a tuple containing the correct AdvancedPreProcessor and Lexer implementations for this group/language combination

getAdvancedPostProcessorForLanguage(Class<? extends IAdvancedPreProcessorGroup>, String) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Fetches a tuple containing the correct AdvancedPreProcessor and Lexer implementations for this group/language combination

getAllFiles() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Returns a list of all files, across all levels of this submission

getAllFiles() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getAllJobStatuses() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

Returns a list of all active, queued or recently finished job statuses

getAllJobStatuses() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

getAndSet(float) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

getArchiveId() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

Get the id for the immediate parent submission, this may not be the top level submission seen by the user

getArchiveId() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getBlockScore() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlock

getBlockScore() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlock

getChannelNames() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.ILexerSpecification

getChannelNames() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification

getClassName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Get the detector class name

getCodeBlock(ISourceFile) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

return the block of code for a specific file

getCodeBlock(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

getCodeBlockGroupClass() - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Fetches the class of ICodeBlockGroup used in this IStorageWrapper implementation

getCodeBlockGroupClass() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

getCodeBlocks() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

getCodeBlocks() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

getCodeBlocks(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Get the list of code blocks for a file

getColour() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Get the highlight CSS colour

getColour(int) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.ResultsHelper

Fetches a colour code for a match from the colour list above, or randomly generates one if the index is out of bounds

getComment() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

getComment() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

getConfirmPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

getConfirmPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.PasswordForm

getContact() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.WebmasterProperties

Get the contact name

getContainedDirectories() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Returns a list of sub-directories on this level of the submission structure

getContainedDirectories() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getContainedFiles() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Returns a list of files on this level of the submission structure

getContainedFiles() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getContainingBlocks() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Fetches the list of code block groups from the detector which feature the instance file

getContainingBlocks() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

getDatabase() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

getDataPath() - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

getDefaultValue() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

Default value the parameter takes

getDependencies() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.IGeneralPreProcessor

Specify a set of dependencies which must be present in and executed prior to this preprocessor in a PreProcessingStrategy

getDescription() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

Optional, detailed description of what the parameter does

getDescription() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.Detector

Fetches the description string for the detector

getDescription() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.detection.IDetector

Fetches the description string for the detector

getDescription() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Get the description

getDetectionType() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

getDetectionType() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

getDetectionType(String) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Fetches the DetectionType object for an identifier if it is present

getDetectionType(String) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Fetches the DetectionType object for an identifier if it is present

getDetectionType(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Fetches the DetectionType object for an identifier if it is present

getDetector() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Fetches the detector for this task

getDetector() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

getDetector() - Method in interface uk.ac.warwick.dcs.sherlock.engine.executor.work.IWorkTask

getDetector() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getDetector() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

getDetector() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the detector

getDetectorAdjustableParameters(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Get the adjustable parameters for a detector

getDetectorAdjustableParameters(Class<? extends IDetector>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

getDetectorAdjustableParameters(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Get the adjustable parameters for a detector

getDetectorDescription(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Get the description of a detector

getDetectorDescription(Class<? extends IDetector>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

getDetectorDescription(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Get the description of a detector

getDetectorDisplayName(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Get the display name of the detector

getDetectorDisplayName(Class<? extends IDetector>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

getDetectorDisplayName(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Get the display name of the detector

getDetectorLanguages(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Get the languages supported by the detector

getDetectorLanguages(Class<? extends IDetector>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

getDetectorLanguages(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Get the languages supported by the detector

getDetectorNames(String) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Get the list of detector names for a language

getDetectorParameters() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

getDetectors() - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Fetch the set of all detectors registered to Sherlock

getDetectors() - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

getDetectors() - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Fetch the set of all detectors registered to Sherlock

getDetectors() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

getDetectors() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

getDetectors() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Get the list of detector wrappers active in the template

getDetectors(String) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Returns a set of all detectors registered which support the language specified

getDetectors(String) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Returns a set of all detectors registered which support the language specified

getDetectors(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Returns a set of all detectors registered which support the language specified

getDetectors(String) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Get the list of detector wrappers for a language

getDisplayFileSize(boolean) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

Fetches the file size in String form with the correct extension

getDisplayFileSize(boolean) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getDisplayName() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

Display Name for the parameter to be displayed in the UI

getDisplayName() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Display name getter

getDisplayName() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.Detector

Fetches the display name for the detector

getDisplayName() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.detection.IDetector

Fetches the display name for the detector

getDisplayName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Get the detector display name

getDisplayName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.ParameterWrapper

Get the display name for this parameter

getDisplayName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TaskWrapper

Get the display name of the detector

getDuplicate() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

getDuration() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

fetches the current duration of the job, if job finished gives the total runtime

getDuration() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

getEmail() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SetupProperties

Get the default user's email address

getEmail() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

getEmail() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

getEmail() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

getEmail() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getEnableExternalModules() - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

getEncryptFiles() - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

getEndLine() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.CodeBlock

Get the end line number

getEngineDetector() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the engine object for this detector

getEngineId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Workspace

getEngineId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the workspace engine id

getEngineParameters() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the list of adjustable parameters for this detector

getEngineParametersMap() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the adjustable parameters for this detector as a map

getEnginePostProcessingParameters() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the list of adjustable postprocessing parameters for this detector

getEnginePostProcessingParametersMap() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

getFile() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlock

getFile() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Get the file this instance represents

getFile() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.ModelDataItem

Get the file this data item for

getFile() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatchItem

getFile() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchItem

getFile() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlock

getFile() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

getFile1() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Getter for ID of first file in comparison pair.

getFile1() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getFile1NumObjects() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getFile2() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Getter for ID of second file in comparison pair.

getFile2() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getFile2NumObjects() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getFileContents() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

getFileContents() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getFileContentsAsString() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

getFileContentsAsString() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getFileContentsAsStringList() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

getFileContentsAsStringList() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getFileCount() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Calculates the file count of this directory and all subdirectories

getFileCount() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getFileCount() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Get the number of files in this job

getFileDisplayName() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

getFileDisplayName() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getFileDisplayPath() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

getFileDisplayPath() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getFileIdentifier() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

getFileIdentifier() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getFileLines(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Get a string listing all the line numbers involved from the file

getFileResults() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultJob

Returns the list of IResultFile stored for this job

getFileResults() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultJob

getFiles() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

The ids of the files used for this job

getFiles() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

getFiles() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getFiles() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

getFiles() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

getFiles() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the workspace files

getFileScore(ISourceFile) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Gets the aggregate score from all tasks of the instance file vs the passed file, the file must have been registered using IResultFile.addFileScore(ISourceFile, float)

getFileScore(ISourceFile) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Gets the score of the instance file vs the passed file for the task, the file must have been registered using IResultTask.addFileScore(ISourceFile, float)

getFileScore(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

getFileScore(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

getFileScores() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Returns the full map of stored file vs instance file aggregate score from all tasks

getFileScores() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Returns the full map of stored file vs instance file score for the task

getFileScores() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

getFileScores() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

getFileSize() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

Fetches the file size in bytes

getFileSize() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getFilesList() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getFileTotal(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Returns the scoring total for the file passed, by default this is the total number of lines in the file.

getFormattedDuration() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

Fetches the current duration of the job as a formatted string, if job finished gives the total runtime

getFormattedDuration() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

getGroupCounts() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Get the group count map

getGroups() - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Gets the ICodeBlockGroup instances in this result

getGroups(ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Fetches a list of groups containing the passed file

getGroups(ISourceFile, ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Fetches a list of groups containing the passed files

getHash() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getHash() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getHighlightedLines() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.LineMapper

Get the list of plagiarised line numbers converted to a comma separated list e.g.

getHighlightedLines(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.FileMapper

Get the list of plagiarised line numbers converted to a comma separated list for a specific file in the map e.g.

getHighlightedLines(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the list of plagiarised line numbers converted to a comma separated list for a specific file in the map e.g.

getId() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Fetches the submission unique id

getId() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

get the id of the jobstatus

getId() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

getId() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorJob

getId() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Workspace

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Get the id of this match

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Get the submission ID

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the id of the detector

getId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the workspace web id

getIdentifier() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Unique string identifier getter

getInstanceOfCodeBlockGroup() - Static method in class uk.ac.warwick.dcs.sherlock.api.util.SherlockHelper

Constructs a new instance of the current ICodeBlockGroup implementation and returns it

getInstitution() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.WebmasterProperties

Get the name of the institution

getIsAdmin() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

getIsPublic() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

getItems() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatch

getItems() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatch

getiWorkspace() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the engine workspace entity

getJob() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Get the job this task is a child of

getJob() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorJob

getJob() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getJob() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Get the job showing the results for

getJob(IJobStatus) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

Gets the job from a job status

getJob(IJobStatus) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

getJobCompleteDismissalTime() - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

getJobs() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

getJobs() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

getJobs() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the workspace jobs

getJobStatus() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

getJobStatus() - Method in interface uk.ac.warwick.dcs.sherlock.engine.executor.work.IWorkTask

getJobStatus(IJob) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

Gets the job status for a specific job

getJobStatus(IJob) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

getJSONMap() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Convert this object to a JSON object, used by the JavaScript in the UI

getKey() - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

getKey() - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

getKey() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SecurityProperties

Gets the secret key

getLanguage() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

getLanguage() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

getLanguage() - Method in interface uk.ac.warwick.dcs.sherlock.engine.executor.work.IWorkTask

getLanguage() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

getLanguage() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

getLanguage() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

getLanguage() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

getLanguage() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the workspace language

getLanguages() - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Returns the set of registered languages

getLanguages() - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Returns the set of registered languages

getLanguages() - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Returns the set of registered languages

getLanguages() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Get the set of languages

getLatestResult() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

get the latest processed results for this job

getLatestResult() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getLexerForStrategy(PreProcessingStrategy, String) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Finds and returns a valid lexer for the preprocessing stragety, if one cannot be found returns null

getLexerForStrategy(PreProcessingStrategy, String) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Finds and returns a valid lexer for the preprocessing stragety, if one cannot be found returns null

getLexerForStrategy(PreProcessingStrategy, String) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Finds and returns a valid lexer for the preprocessing stragety, if one cannot be found returns null

getLexerSpecification() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.IGeneralPreProcessor

Specifies which channels must be present in the lexer for the preprocessor to function, this is a minimum specification, other channels may be present.

getLexerSpecification() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.CommentExtractor

getLexerSpecification() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.CommentRemover

getLexerSpecification() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.TrimWhitespaceOnly

getLineNumbers() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlock

getLineNumbers() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatchItem

getLineNumbers() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchItem

getLineNumbers() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlock

getLink() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.WebmasterProperties

Get the link to contact the institution/person

getLocalEmail() - Static method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.SecurityConfig

Get the email of the local user

getLocalPassword() - Static method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.SecurityConfig

Get the password of the local user

getLocation(int) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getLocations() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Getter for the block location indexes in the order: File1 start, File1 end, File2 start, File2 end.

getLocations() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getMap() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Get the map

getMapJSON() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the file mapper as a JSON string

getMatchedFiles() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

getMatches() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatchGroup

Get the matches

getMatches() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchGroup

Get the matches

getMatches() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the list of matches

getMatchesJSON() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the list of matches as a JSON string

getMatchId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.CodeBlock

Get the match ID linked to this block

getMatchingSubmissions() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionSummary

Retrieves the matching submission list.

getMatchingSubmissions() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionSummary

Retrieves the matching submission list.

GetMatchingSubmissions() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.IReportManager

To be called by the web report pages.

GetMatchingSubmissions() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.ReportManager

To be called by the web report pages.

getMaximumBound() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

The maximum bound for the field

getMessage() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

Returns the current status message for the job

getMessage() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

getMinimumBound() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

Minimum bound for field

getName() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

Field Name for the parameter for use in the UI backend

getName() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

The name of the submission, should uniquely identify the submission content

getName() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

getName() - Method in class uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy.GenericAdvancedPreProcessingStrategy

getName() - Method in class uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy.GenericGeneralPreProcessingStrategy

getName() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy

Fetches the reference identifier for the strategy

getName() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getName() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SetupProperties

Get the default user's username

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Get the submission name

getName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the workspace name

getNewPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

getNonEmptyLineCount() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

Count of the number of lines in the file containing characters, non empty

getNonEmptyLineCount() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getObject(int) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getObjects() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Get the list of match objects within the container.

getObjects() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getOldPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

getOldPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

getOldPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

getOverallScore() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Gets the overall aggregate score for all tasks and other files for the instance file

getOverallScore() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

getOwnerName() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Get the name of the owner

getParameter() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.ParameterWrapper

Get the database parameter entity

getParameterMapping() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Gets the mapping of the adjustable parameters for this detector run

getParameterMapping() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getParameterObj() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.ParameterWrapper

Get the adjustable parameter object

getParameters() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

getParameters() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

getParametersList() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the list of parameters for this detector

getParameterString() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TaskWrapper

Get the list of parameters as a string

getParent() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Get the parent, return null if no parent exists

getParent() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SetupProperties

Get the default user's plaintext password

getPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

getPassword() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getPersistentId() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

The unique id for the job

getPersistentId() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultJob

The unique id for the job result

getPersistentId() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

getPersistentId() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Returns the unique id for this task

getPersistentId() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

getPersistentId() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionSummary

Retrieves the submission id.

getPersistentId() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionSummary

Retrieves the submission id.

getPersistentId() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getPersistentId() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getPersistentId() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultJob

getPersistentId() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getPersistentId() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

getPersistentId() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Get hte persistent id of the job

getPoint1() - Method in class uk.ac.warwick.dcs.sherlock.api.util.PairedTuple

getPoint2() - Method in class uk.ac.warwick.dcs.sherlock.api.util.PairedTuple

getPostParameters() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

getPostprocessing() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

getPostprocessing() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

getPostProcessorAdjustableParameters(Class<? extends IPostProcessor>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Gets the adjustable parameters for a postprocessor

getPostProcessorAdjustableParameters(Class<? extends IPostProcessor>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Gets the adjustable parameters for a postprocessor

getPostProcessorAdjustableParameters(Class<? extends IPostProcessor>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Gets the adjustable parameters for a postprocessor

getPostProcessorAdjustableParametersFromDetector(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Gets the adjustable parameters for the corresponding post processor for a detector

getPostProcessorAdjustableParametersFromDetector(Class<? extends IDetector>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Gets the adjustable parameters for the corresponding post processor for a detector

getPostProcessorAdjustableParametersFromDetector(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Gets the adjustable parameters for the corresponding post processor for a detector

getPostProcessorInstance(Class<? extends AbstractModelTaskRawResult>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Get correct instance of IPostProcessor to process an AbstractModelTaskRawResult object

getPostProcessorInstance(Class<? extends AbstractModelTaskRawResult>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Fetches the correct IPostProcessor instance for the raw result type

getPostProcessorInstance(Class<? extends AbstractModelTaskRawResult>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Get correct instance of IPostProcessor to process an AbstractModelTaskRawResult object

getPreProcessedLines(String) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.ModelDataItem

get the preprocessed lines for a strategy, returns null if strategy does not exist

getPreProcessingStrategies() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

getPreProcessingStrategies() - Method in interface uk.ac.warwick.dcs.sherlock.engine.executor.work.IWorkTask

getPreProcessorClasses() - Method in class uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy.GenericAdvancedPreProcessingStrategy

getPreProcessorClasses() - Method in class uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy.GenericGeneralPreProcessingStrategy

getPreProcessorClasses() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy

Fetches the ordered preprocessor classes in a list, to be run in order

If using an advanced preprocessor, this must return a singleton list (list with 1 element)

getPreProcessors() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.Detector

Specify the preprocessors required for this detector.

getPreProcessors() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.detection.IDetector

Specify the preprocessors required for this detector.

getPriority() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

Internal priority for the job in the run queue, probably don't show to the user.

getPriority() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorJob

getProgress() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

returns the current progress estimate for the job, between 0 and 1

getProgress() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

Progress float, percentage complete between 0 and 1

getProgressInt() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

returns the current progress estimate for the job, as percentage between 0 and 100

getProgressInt() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

Progress int, percentage complete between 0 and 100

getRawResult() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectorWorker

Gets the results of the worker execution, only minimal processing should be performed in this method

getRawResult() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetectorWorker

Gets the results of the worker execution, only minimal processing should be performed in this method

getRawResults() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Returns the raw results object produced by the tasks detector

getRawResults() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getReason() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Verbose reason blocks was detected getter

getReason() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatch

getReason() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatchGroup

Get the descriptor

getReason() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatch

getReason() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchGroup

Get the descriptor

getReason() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Get the reason for this match

getReference() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

Fetches the reference string for the adjustable parameter represented by this object

getReportGenerator(IResultJob) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Returns a prepared report manager for the IResultJob, uses cached instances were possible

getReportGenerator(IResultJob) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

getResults() - Method in class uk.ac.warwick.dcs.sherlock.api.event.EventPublishResults

getResults() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.work.WorkDetect

getResultsMap() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Gets the results map

getRoles() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

getRoles() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getScore() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionMatchItem

getScore() - Method in interface uk.ac.warwick.dcs.sherlock.api.report.ISubmissionSummary

Retrieves the score.

getScore() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchItem

getScore() - Method in class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionSummary

Retrieves the score.

getScore() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Get the score for this match

getScore() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Get the submission score

getScore() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the first submission's score

getScoreGroup() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

All scores are grouped into 10 groups: 0-10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-90 or 90-100 Get the group this score belongs to.

getScoreGroup() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

All scores are grouped into 10 groups: 0-10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-90 or 90-100 Get the group this score belongs to.

getScoreGroup(float) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.ResultsHelper

All scores are grouped into 10 groups: 0-10, 10-20, 20-30, 30-40, 40-50, 50-60, 60-70, 70-80, 80-90 or 90-100 Get the group this score belongs to.

getSecureParam() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getSecureParam() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getSingle() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

getSize() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Getter for the number of matches stored in the object.

getSize() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

getSourceFile(long) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFileHelper

Fetches instance of the ISourceFile for the unique id passed

getSourceFile(long) - Static method in class uk.ac.warwick.dcs.sherlock.api.util.SherlockHelper

Fetches the instance of ISourceFile for the corresponding unique id

getSourceFile(long) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

getStartLine() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.CodeBlock

Get the start line number

getStartTime() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

returns the start time of the job

getStartTime() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

getStatus() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Returns the status of the job

getStatus() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Returns the status of the task

getStatus() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorJob

getStatus() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

getStatus() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getStatus() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getStatus() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Get the status of the job

getStep() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

The step to increment or decrement the parameter by in the UI

getStep() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

Fetches the current "step" for the job, the stage it is at

getStep() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

getStringifier() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy

Stringifier to use before passing the file to the detection algorithm, null for the default formatted code

getSubmission() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

Get the top level, "super parent", submission object, this is the submission for this file seen by the user, NOT a sub-directory

getSubmission() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getSubmission(WorkspaceWrapper, long) - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.ResultsHelper

Tries to find the submission in the workspace supplied.

getSubmission1() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the first submission

getSubmission2() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the second submission

GetSubmissionComparison(List<ISubmission>) - Method in interface uk.ac.warwick.dcs.sherlock.api.report.IReportManager

Compares two submissions, finds all the matches in files they contain between them, and returns all relevant information about them.

GetSubmissionComparison(List<ISubmission>) - Method in class uk.ac.warwick.dcs.sherlock.engine.report.ReportManager

Compares two submissions, finds all the matches in files they contain between them, and returns all relevant information about them.

getSubmissionFromName(IWorkspace, String) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Fetches a submission for the passed name if one exists, else returns null

getSubmissionFromName(IWorkspace, String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

GetSubmissionReport(ISubmission) - Method in interface uk.ac.warwick.dcs.sherlock.api.report.IReportManager

Generate a report for a single submission, containing all matches for all files within it, and a summary of the report as a string.

GetSubmissionReport(ISubmission) - Method in class uk.ac.warwick.dcs.sherlock.engine.report.ReportManager

Generate a report for a single submission, containing all matches for all files within it, and a summary of the report as a string.

getSubmissions() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

getSubmissions() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

getSubmissions() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Gets the list of submissions linked to this one

getSubmissions() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the workspace submissions

getSummary() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Get the summary for the report, replacing line breaks with html line breaks

getTask() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Get the task this objects stores results for

getTask() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorTask

getTask() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

getTaskResults() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Returns the list of IResultTask stored for this file

getTaskResults() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

getTasks() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

The list of tasks used to process this job

getTasks() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getTasks() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Get the list of tasks in the job

getTaskScore() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Fetches the overall aggregate score for the instance file for the task

getTaskScore() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

getTemplate() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

getTemplate() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Get the template

getTemplates() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

getTemplates() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getTimestamp() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Fetch the timestamp for the job creation;

getTimestamp() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getTimestamp() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getTimestamp() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

getTimestamp() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Get the time the job started

getTotalFileCount() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Returns the total count of all files in this submission

getTotalFileCount() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

getTotalLineCount() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

Count of the total number of lines in the file

getTotalLineCount() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

getUsername() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

getUsername() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountNameForm

getUsername() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getValidator() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.MvcConfig

To use the validation messages from the properties file during model validation we need to register the message source above to the local validator bean

getValue() - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

getValue() - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

getValue() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

getWaitingJobs() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

Returns a list of queued jobs

getWaitingJobs() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

getWeighting() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Getter - Weighting of the type for overall scoring, tuned to adjust the impact of each type to give a balanced overall result and report

getWorkspace() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

get the workspace containing the job

getWorkspace() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

getWorkspace() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Get the web database workspace entity

getWorkspaces() - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Get all stored workspaces

getWorkspaces() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

getWorkspaces() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

getWorkspaces() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.AccountWrapper

getWorkspaces(List<Long>) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

getWorkspaces(List<Long>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

getWrapper() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Get the engine wrapper for this detector

graphGetFragment(boolean, long, long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests to the graph fragment

groups() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.PasswordsMatch

groups() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.ValidLanguage

groups() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.ValidPassword

H

hasParent() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Does this instance have a parent submission.

hasParent() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

hasResults() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Does the task have raw results saved?

hasResults() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

HeaderFilter - Class in uk.ac.warwick.dcs.sherlock.module.web.filters

Filters all requests to add the current URL to the http response headers

HeaderFilter() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.filters.HeaderFilter

HelpController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers

The controller that deals with the help pages (help centre, terms and privacy policy)

HelpController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.HelpController

HIDDEN - uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification.channels

HIGH - uk.ac.warwick.dcs.sherlock.engine.executor.common.Priority

HomeController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers

The controller that deals with the homepage for anonymous users

HomeController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.HomeController

I

IAdvancedPreProcessor<T extends org.antlr.v4.runtime.Lexer> - Interface in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

Advanced preprocessor implementation, used to directly access and preprocess from a specific lexer

IAdvancedPreProcessorGroup - Interface in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

Interface specifically to group advanced preprocessors to a specific location on the classpath, has no formal function

ICodeBlock - Interface in uk.ac.warwick.dcs.sherlock.api.component

Interface for storing a single block of code flagged by a detector as suspected plagiarism.

ICodeBlockGroup - Interface in uk.ac.warwick.dcs.sherlock.api.component

An interface that connects multiple ICodeBlocks where plagiarism is detected between those files.

IDetector<T extends DetectorWorker> - Interface in uk.ac.warwick.dcs.sherlock.api.model.detection

Low level interface for implementing a detection algorithm.

IEvent - Interface in uk.ac.warwick.dcs.sherlock.api.event

Instance of an event to be published, can contain any information required to be useful

IEventBus - Interface in uk.ac.warwick.dcs.sherlock.api.event

Event bus interface, used to publish and subscrib to events

IEventModule - Interface in uk.ac.warwick.dcs.sherlock.api.event

An extension of IEvent for events used exclusively for module loading

IExecutor - Interface in uk.ac.warwick.dcs.sherlock.api.executor

Execution Module interface, defines an execution scheme

IGeneralPreProcessor - Interface in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

General preprocessor interface, used to filer a set of tokens from a lexer which conforms to the provided spec

IJob - Interface in uk.ac.warwick.dcs.sherlock.api.component

Interface for an object which defines a detection job.

IJobStatus - Interface in uk.ac.warwick.dcs.sherlock.api.executor

Interface defining the status information available for a job

ILexerSpecification - Interface in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

Defines a list of channel names, used to identify and catagorise tokens, specified in the lexer.

incrementProgress() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

index() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.DashboardController

Handles GET requests to the dashboard home

index(Model, HttpServletRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.HelpController

Handles requests to the help page

index(WebmasterProperties, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.HomeController

Handles requests to the homepage, loads the contact details from the web master properties and redirects to the dashboard home if the user is logged in

IndexedString - Class in uk.ac.warwick.dcs.sherlock.api.util

A Tuple of Integer and String, is typically used to associate a string with a file line number within the Sherlock API and Engine

IndexedString(int, String) - Constructor for class uk.ac.warwick.dcs.sherlock.api.util.IndexedString

indexGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.TemplatesController

Handles GET requests to the templates page

indexGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.WorkspacesController

Handles GET requests to the workspaces page

indexGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

Handles requests to the account page

indexGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.AdminController

Handles all requests to the admin page

initialisation(EventInitialisation) - Method in class uk.ac.warwick.dcs.sherlock.launch.SherlockClient

initialisation(EventInitialisation) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.ModuleModelBase

initialise() - Method in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

Initialise Sherlock!, must be called for Sherlock to work

initialize(AccountPasswordForm) - Method in class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.PasswordsMatchValidator

initialize(ValidLanguage) - Method in class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.ValidLanguageValidator

initialize(ValidPassword) - Method in class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.ValidPasswordValidator

instance - Static variable in class uk.ac.warwick.dcs.sherlock.launch.SherlockClient

INTERRUPTED - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

intValue() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

invokeWork(ForkJoinTask, Priority) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

invokeWork(ForkJoinTask, Priority) - Method in interface uk.ac.warwick.dcs.sherlock.engine.executor.common.IPriorityWorkSchedulerWrapper

Blocking execution of the work, returns when work is complete

IPostProcessor<T extends AbstractModelTaskRawResult> - Interface in uk.ac.warwick.dcs.sherlock.api.model.postprocessing

Post process the raw results into the Sherlock formal data storage structure Supports adjustable parameters see AdjustableParameter

IPreProcessor - Interface in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

Grouping interface, don't implement directly

IPriorityWorkSchedulerWrapper - Interface in uk.ac.warwick.dcs.sherlock.engine.executor.common

Interface for the Priority Work Scheduler wrapper, which owns the scheduler (BaseExecutor)

IRegistry - Interface in uk.ac.warwick.dcs.sherlock.api.registry

Interface to define API access to the registry via the static wrapper

IReportGenerator<T extends ISubmissionMatchGroup> - Interface in uk.ac.warwick.dcs.sherlock.api.report

Implementations of this interface are used by the Report Manager to generate reports for files where plagiarism is suspected (though it can be run for any file in principle).

IReportManager<T extends ISubmissionMatchGroup,S extends ISubmissionSummary> - Interface in uk.ac.warwick.dcs.sherlock.api.report

IResultFile - Interface in uk.ac.warwick.dcs.sherlock.api.component

Stores the results of an individual file from a job, is used as child of IResultJob

IResultJob - Interface in uk.ac.warwick.dcs.sherlock.api.component

Object which stores the set of results from a job execution, organised by file.

IResultTask - Interface in uk.ac.warwick.dcs.sherlock.api.component

Stores the results of an individual file for an individual task (detector), is used as child of IResultFile

isAdmin - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

isAdmin() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

isAdvanced() - Method in class uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy.GenericAdvancedPreProcessingStrategy

isAdvanced() - Method in class uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy.GenericGeneralPreProcessingStrategy

isAdvanced() - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy

Is the strategy using an IAdvancedPreProcessor instance?

isAjax(HttpServletRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Checks whether the current request is ajax or not

isEmpty() - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.AbstractModelTaskRawResult

Tests if the rawResult set should be discarded, as it contains no results data

isEmpty() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Returns true if no matches in object, false otherwise.

isEmpty() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

isFinished() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IJobStatus

returns whether the job has finished

isFinished() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

isFixed() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

Return if the parameter is fixed, ie.

isInitialised() - Method in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

is SherlockEngine initialised

isInt() - Method in class uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameterObj

is the parameter an integer parameter? (if not is a float)

isModulePresent(String) - Static method in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

Test the presence of a module at the passed classpath, should point to a class within the module

ISourceFile - Interface in uk.ac.warwick.dcs.sherlock.api.component

Interface for accessing the data from an individual source file from a submission

ISourceFileHelper - Interface in uk.ac.warwick.dcs.sherlock.api.component

Helper interface, for fetching ISourceFile instances from their unique id

isOwner() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Whether or not the template is owned by the current user

isOwner() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Whether or not the template is owned by the current user

isPopulated() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

Check whether the group covers at least two files

isPopulated() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

isPostprocessing() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

isPrepared() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Has the prepare() method been called?

isPrepared() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

isPrinting(Model, HttpServletRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.AttributesControllerAdvice

Checks whether or not the request is attempting to print

isPublic - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

isPublic() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

isPublic() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

isPublic() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Whether or not the template is public

isResultTokenised() - Method in class uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy.GenericGeneralPreProcessingStrategy

isSingle() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

IStorageWrapper - Interface in uk.ac.warwick.dcs.sherlock.api.storage

Storage module interface, defines a storage implementation, should be self contained and fully manage stored data

ISubmission - Interface in uk.ac.warwick.dcs.sherlock.api.component

Interface for accessing data from a single submission, this contains many files and might contain many child submission, which represent directories within the submission

ISubmissionMatch<T extends ISubmissionMatchItem> - Interface in uk.ac.warwick.dcs.sherlock.api.report

ISubmissionMatchGroup<T extends ISubmissionMatch> - Interface in uk.ac.warwick.dcs.sherlock.api.report

ISubmissionMatchItem - Interface in uk.ac.warwick.dcs.sherlock.api.report

ISubmissionSummary - Interface in uk.ac.warwick.dcs.sherlock.api.report

isValid(String, ConstraintValidatorContext) - Method in class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.ValidLanguageValidator

Performs the validation step by checking that the language is set and then that it is in the list of languages in the Sherlock Registry

isValid(String, ConstraintValidatorContext) - Method in class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.ValidPasswordValidator

Performs the validation step by fetching the account from the repository, encoding the supplied password and checking that against the encoded password stored in the database

isValid(AccountPasswordForm, ConstraintValidatorContext) - Method in class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.PasswordsMatchValidator

Performs the validation step to check if the two inputs are set and then that they equal

isValidInstance() - Method in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

is SherlockEngine valid

ITask - Interface in uk.ac.warwick.dcs.sherlock.api.component

Interface for object which stores an individual detector used in a detection job, including the parameter mapping for the specific task.

ITokenStringifier - Interface in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

Interface to define the final step in file preprocessing, it turns the list of tokens into a list of strings paired with their respective line numbers.

ITuple<K,V> - Interface in uk.ac.warwick.dcs.sherlock.api.util

Basic tuple interface

IWorkspace - Interface in uk.ac.warwick.dcs.sherlock.api.component

Workspace object groups, submission, jobs, results.

IWorkspaceNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the workspace is not found in the engine

IWorkspaceNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.IWorkspaceNotFound

IWorkTask - Interface in uk.ac.warwick.dcs.sherlock.engine.executor.work

Access interface for work tasks

J

JobResultsData - Class in uk.ac.warwick.dcs.sherlock.module.web.data.results

Stores all the data for the job results page

JobResultsData(IJob) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.results.JobResultsData

Initialise the data object for the supplied job

JobStatus - Class in uk.ac.warwick.dcs.sherlock.engine.executor

Basic job status implementation

JobStatus(int, Priority) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

jsonGet(JobResultsData) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

K

keyEquals(ITuple) - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

keyEquals(ITuple) - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

L

language - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

language - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

layoutDialect() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.ThymeLeafConfig

Enables layouts by adding an additional dialect to the template engine

LineMapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.results

Maps every line of a file that the system thinks is plagiarised to one or more "match ids" (stored in the code block object)

LineMapper(long) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.results.LineMapper

Initialise an empty instance of line mapper

LineMapper(long, List<FileMatch>) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.results.LineMapper

Initialise the line mapper and fill with a list of matches

lines - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NgramMatch

The line positions of both blocks.

listGetFragment(boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.AdminController

Handles GET requests to the list fragment on the admin page

listGetFragment(AccountWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.TemplatesController

Handles GET requests to the template list page

listGetFragment(AccountWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.WorkspacesController

Handles GET requests to the workspaces list fragment

loadFile(EntityFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorageFilesystem

Loads a file from the filesystem

loadFileAsString(EntityFile) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorageFilesystem

Loads a file from the filesystem

LoadingHelpFailed - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the help.properties file was not loaded successfully

LoadingHelpFailed(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.LoadingHelpFailed

loadUserByUsername(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.services.CustomUserDetailsService

Searches for the account using the email, loads the roles associated to that account.

LocalDashboard - Class in uk.ac.warwick.dcs.sherlock.module.client

LocalDashboard() - Constructor for class uk.ac.warwick.dcs.sherlock.module.client.LocalDashboard

localeChangeInterceptor() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.MvcConfig

An interceptor bean which allows for changing the current locale on every request based on the value of the "lang" parameter appended to a request

localeResolver() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.MvcConfig

Used to determine which locale is currently being used and sets the default

logger - Static variable in class uk.ac.warwick.dcs.sherlock.engine.executor.common.ExecutorUtils

login(Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.SecurityController

Handles requests to the login page, automatically fills in the login form when running as a client

LONG_WHITESPACE - uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification.channels

longValue() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

LOW - uk.ac.warwick.dcs.sherlock.engine.executor.common.Priority

M

main(String[]) - Static method in class uk.ac.warwick.dcs.sherlock.launch.SherlockClient

main(String[]) - Static method in class uk.ac.warwick.dcs.sherlock.launch.SherlockServer

manageGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles GET requests to the manage template page

manageGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles the GET request to the manage workspace page

manageGet(AccountWrapper, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.SubaccountController

Handles GET requests to the manage account page

managePost(AccountForm, BindingResult, AccountWrapper, AccountWrapper, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.SubaccountController

Handles POST requests to the manage account page, updates the username, email and roles based on the form contents

MapperException - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown when the "addMatch" method in LineMapper is called after the "Fill" method has already ran

MapperException(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.MapperException

matchFound(ArrayList<NGramDetector.Ngram>, ArrayList<NGramDetector.Ngram>, NGramDetector.Ngram, float, int, ISourceFile, ISourceFile) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector

maxumumBound() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameter

The maximum bound for the field

MEDIUM - uk.ac.warwick.dcs.sherlock.engine.executor.common.Priority

mergePendingSubmission(ISubmission, ISubmission) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Merge two submissions into a single submission, can be used to sort out name collisions

mergePendingSubmission(ISubmission, ISubmission) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

message() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.PasswordsMatch

Defines the key of the error message in the localisation file if this validation step fails

message() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.ValidLanguage

Defines the key of the error message in the localisation file if this validation step fails

message() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.ValidPassword

Defines the key of the error message in the localisation file if this validation step fails

messageSource() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.MvcConfig

Spring delegates the message resolution to this bean and ReloadableResourceBundleMessageSource resolves messages from the resource bundle (messages.properties) for each locale

minimum_window - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector

The minimum size of a list of N-Grams before checks begin.

minimumBound() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameter

Minimum bound for field

MISSING_FILES - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

ModelDataItem - Class in uk.ac.warwick.dcs.sherlock.api.model.detection

Object to store the preprocessed data passed to the detector

ModelDataItem(ISourceFile) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.ModelDataItem

Build data item for file

ModelDataItem(ISourceFile, Map<String, List<IndexedString>>) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.ModelDataItem

Build data item for file

ModelTaskProcessedResults - Class in uk.ac.warwick.dcs.sherlock.api.model.postprocessing

Processed results for a task (for a single IDetector instance)

ModelTaskProcessedResults() - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

default constructor

ModuleModelBase - Class in uk.ac.warwick.dcs.sherlock.module.model.base

ModuleModelBase() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.ModuleModelBase

MvcConfig - Class in uk.ac.warwick.dcs.sherlock.module.web.configuration

Enables localisation support and loads the extra properties for Spring's application.properties files

MvcConfig() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.configuration.MvcConfig

N

name - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

name - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

name - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

name() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameter

Name for the parameter to be displayed in the UI

name() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.SherlockModule

The name of the module, for easy identification

nameGetFragment(Model, boolean, AccountWrapper) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

Handles GET requests to the name fragment on the account page

namePostFragment(boolean, AccountWrapper, AccountNameForm, BindingResult, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

Handles POST requests to the name fragment on the account page

networkGet(Model, HttpServletRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests to the network graph page

newGroup() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.scoring.NGramScorer

Resets/Initialises the group info storage for each match group.

newPassword - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

nextStep() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

ngram_size - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector

The character width of each N-Gram used in the detection.

NGramDetector - Class in uk.ac.warwick.dcs.sherlock.module.model.base.detection

NGramDetector() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector

Sets meta data for the detector, along with providing the API with pointers to the Worker and the Preprocessing Strategy

NGramDetector.NGramDetectorWorker - Class in uk.ac.warwick.dcs.sherlock.module.model.base.detection

The main processing method used in the detector

NGramDetectorWorker(IDetector, ModelDataItem, ModelDataItem) - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector.NGramDetectorWorker

NgramMatch - Class in uk.ac.warwick.dcs.sherlock.module.model.base.detection

Contains all data for a single matched pair.

NGramPostProcessor - Class in uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing

NGramPostProcessor() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramPostProcessor

NGramRawResult<T extends java.io.Serializable> - Class in uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing

Stores the set of match objects for a pair of inputted files.

NGramRawResult(ISourceFile, ISourceFile) - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Object constructor, saves the compared file ids, initialises interior lists as ArrayLists, and sets size to zero.

NGramScorer - Class in uk.ac.warwick.dcs.sherlock.module.model.base.scoring

NGramScorer(float) - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.scoring.NGramScorer

Object constructor.

NoFilesUploaded - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the user clicks submit on the "upload submissions" page when they selected no files

NoFilesUploaded(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.NoFilesUploaded

NOT_PREPARED - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

notAjaxRequest(NotAjaxRequest) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.ExceptionControllerAdvice

Handles requests which are only allowed to be ajax requests.

NotAjaxRequest - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the user attempts to load a page that isonly allowed to be loaded through ajax/javascript requests

NotAjaxRequest(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.NotAjaxRequest

notAuthorisedError(Model, Authentication, Exception) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.ExceptionControllerAdvice

Handles all requests which are not authorised

notFoundError(Model, Authentication, Exception) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.ExceptionControllerAdvice

Handles all "not found" errors

NotImplementedException - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown when the user tries to run a function that has not been finished

NotImplementedException(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.NotImplementedException

notInitialised(Model, Exception) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.ExceptionControllerAdvice

Handles requests which occur before Spring has finished starting up

NotTemplateOwner - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if a user attempts to modify a template that they are not the owner of

NotTemplateOwner(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.NotTemplateOwner

O

of(int, String) - Static method in class uk.ac.warwick.dcs.sherlock.api.util.IndexedString

Static constructor method

of(String, boolean, Class<? extends IGeneralPreProcessor>...) - Static method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy

A construction method for a generic preprocessing strategy

Output can be either formatted code or tokenised depending on the boolean flag value

of(String, Class<? extends IAdvancedPreProcessorGroup>) - Static method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy

A construction method for a generic preprocessing strategy

of(String, Class<? extends IGeneralPreProcessor>...) - Static method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.PreProcessingStrategy

A construction method for a generic preprocessing strategy

Output is always normal formatted code

of(K, V) - Static method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

oldPassword - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

oldPassword - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

oldPassword - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

OUTDATED - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

P

PairedTuple<W,X,Y,Z> - Class in uk.ac.warwick.dcs.sherlock.api.util

Implementation of a pair of tuples in a single object

PairedTuple(W, X, Y, Z) - Constructor for class uk.ac.warwick.dcs.sherlock.api.util.PairedTuple

PairwiseDetector<T extends PairwiseDetectorWorker> - Class in uk.ac.warwick.dcs.sherlock.api.model.detection

An abstract IDetector implementation which constructs an individual, parallel worker for each combination of files in the dataset.

PairwiseDetector(String, Class<T>, PreProcessingStrategy...) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetector

IDetector implementation which automatically builds a worker for each possible combination of the source files passed

PairwiseDetector(String, String, Class<T>, PreProcessingStrategy...) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetector

IDetector implementation which automatically builds a worker for each possible combination of the source files passed

PairwiseDetectorWorker<K extends AbstractModelTaskRawResult> - Class in uk.ac.warwick.dcs.sherlock.api.model.detection

An extension of the basic worker for standard pairwise matching, implements the basic internal data structures

PairwiseDetectorWorker(IDetector, ModelDataItem, ModelDataItem) - Constructor for class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetectorWorker

Loads data into the worker

ParameterForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form for changing parameters on a template detector

ParameterForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

ParameterForm(DetectorWrapper) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

ParameterNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the parameter is not found for the current user

ParameterNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.ParameterNotFound

parametersPost(ParameterForm, BindingResult, DetectorWrapper, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.DetectorController

Handles POST request to the detector parameter page

ParameterWrapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

The wrapper that manages template parameters

ParameterWrapper(TParameter, Map<String, AdjustableParameterObj>) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.ParameterWrapper

Initialise the wrapper class using the parameter entity

parent - Variable in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectorWorker

IDetector Instance which built this worker

parmetersGet(DetectorWrapper, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.DetectorController

Handles GET requests to the detector parameter page

passwordEncoder() - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.MvcConfig

Create a password encoder bean that uses the BCrypt strong hashing function

PasswordForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The generic confirm password form

PasswordForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.PasswordForm

passwordGet(Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.SubaccountController

Handles GET requests to the reset password page

passwordGetFragment(Model, boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

Handles GET requests to the password fragment on the account page

passwordPost(PasswordForm, BindingResult, AccountWrapper, AccountWrapper, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.SubaccountController

Handles POST requests to the reset password page

passwordPostFragment(boolean, AccountWrapper, AccountPasswordForm, BindingResult, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account.AccountController

Handles POST requests to the password fragment on the accounts page

PasswordsMatch - Annotation Type in uk.ac.warwick.dcs.sherlock.module.web.validation.annotations

Defines the annotation of the validator that checks if the new password and confirm password fields match

PasswordsMatchValidator - Class in uk.ac.warwick.dcs.sherlock.module.web.validation.validators

Form validator that checks if the new password and confirm password fields match

PasswordsMatchValidator() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.PasswordsMatchValidator

payload() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.PasswordsMatch

payload() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.ValidLanguage

payload() - Method in annotation type uk.ac.warwick.dcs.sherlock.module.web.validation.annotations.ValidPassword

PoolExecutorJob - Class in uk.ac.warwick.dcs.sherlock.engine.executor.pool

Executor which handles job wide tasks, uses 1 task executor per task

PoolExecutorJob(IPriorityWorkSchedulerWrapper, IJob, JobStatus) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorJob

PoolExecutorTask - Class in uk.ac.warwick.dcs.sherlock.engine.executor.pool

executor which handles task wide stuff

postInitialisation(EventPostInitialisation) - Method in class uk.ac.warwick.dcs.sherlock.launch.SherlockClient

preInitialisation(EventPreInitialisation) - Method in class uk.ac.warwick.dcs.sherlock.launch.SherlockClient

preInitialisation(EventPreInitialisation) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.ModuleModelBase

prepare() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Builds the tasks required for the job, it cannot be edited after this method is called

This should also save the job to the database

prepare() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

PREPARED - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

PreProcessingStrategy - Interface in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

A construct to specify a named set of preprocessing steps.

PreProcessingStrategy.GenericAdvancedPreProcessingStrategy - Class in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

Generic implementation of the PreProcessingStrategy interface for handling advanced preprocessors

PreProcessingStrategy.GenericGeneralPreProcessingStrategy - Class in uk.ac.warwick.dcs.sherlock.api.model.preprocessing

Generic implementation of the PreProcessingStrategy interface

preserveCommentLines(List<IndexedString>, StringBuilder, int, Token) - Static method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardStringifier

Method to split a comment out into its component lines if it spans more than one line to preserve the sourcefile line structure

preserveCommentLines(List<IndexedString>, StringBuilder, int, Token, Vocabulary) - Static method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardTokeniser

Priority - Enum in uk.ac.warwick.dcs.sherlock.engine.executor.common

Priority enum

PriorityWorkScheduler - Class in uk.ac.warwick.dcs.sherlock.engine.executor.common

Scheduler which does work in priority order

PriorityWorkScheduler() - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.common.PriorityWorkScheduler

PriorityWorkScheduler(Integer) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.common.PriorityWorkScheduler

PriorityWorkTask - Class in uk.ac.warwick.dcs.sherlock.engine.executor.common

Work task wrapper object

PriorityWorkTask(ForkJoinTask, Priority) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.common.PriorityWorkTask

privacy() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.HelpController

Handles requests to the privacy page

process(List<? extends Token>, Vocabulary, String) - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.IGeneralPreProcessor

Method to perform preprocessing filtering on a source file.

process(List<? extends Token>, Vocabulary, String) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.CommentExtractor

Extracts the comments from a source file

process(List<? extends Token>, Vocabulary, String) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.CommentRemover

Preprocessor to remove comments and trim whitespace from source

process(List<? extends Token>, Vocabulary, String) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.TrimWhitespaceOnly

Removes the excess whitespace from a sourcefile

process(T) - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.IAdvancedPreProcessor

Pre-process with a lexer

process(JavaLexer) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.VariableExtractorJava

processAdjustableParameters(T, Map<String, Float>) - Static method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.ExecutorUtils

Populates the adjustables in an object

processResults(List<ISourceFile>, List<T>) - Method in interface uk.ac.warwick.dcs.sherlock.api.model.postprocessing.IPostProcessor

Run the post processing and return a data item with the final results in the correct format See wiki for implementation hints use "ModelTaskProcessedResults results = new ModelTaskProcessedResults();" to create new return object

processResults(List<ISourceFile>, List<NGramRawResult>) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramPostProcessor

The main entrance method for the postprocessor.

processResults(List<ISourceFile>, List<SimpleObjectEqualityRawResult>) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityPostProcessor

processTokens(List<? extends Token>, Vocabulary) - Method in interface uk.ac.warwick.dcs.sherlock.api.model.preprocessing.ITokenStringifier

Transform list of tokens into a list of indexed strings, where each string is a line of the original file, and the index of the string is the line number

processTokens(List<? extends Token>, Vocabulary) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardStringifier

Stringifies a file in the form of a list of tokens

processTokens(List<? extends Token>, Vocabulary) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardTokeniser

Tokenises a file in the form of a list of tokens

publishEvent(IEvent) - Static method in class uk.ac.warwick.dcs.sherlock.api.event.EventBus

Publish an event to the bus

publishEvent(IEvent) - Method in interface uk.ac.warwick.dcs.sherlock.api.event.IEventBus

Publish an event to the bus

put(T, int, int) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Method to store a matched block where both file blocks are a single line.

put(T, int, int) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

put(T, int, int, int, int) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Method to store a matched block.

put(T, int, int, int, int) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

Q

queueGetFragment(boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.DashboardController

queuePostFragment(boolean, long, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.DashboardController

R

randomColour() - Static method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.ResultsHelper

Generates a random HEX colour code (e.g.

refreshObject(Object) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

REGEN_RESULTS - uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

registerAdvancedPreProcessorGroup(Class<? extends IAdvancedPreProcessorGroup>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Registers a grouping for IAdvancedPreProcessor to Sherlock.

registerAdvancedPreProcessorGroup(Class<? extends IAdvancedPreProcessorGroup>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Registers a grouping for IAdvancedPreProcessor to Sherlock.

registerAdvancedPreProcessorGroup(Class<? extends IAdvancedPreProcessorGroup>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Registers a grouping for IAdvancedPreProcessor to Sherlock.

registerAdvancedPreProcessorImplementation(String, Class<? extends IAdvancedPreProcessor>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Registers an IAdvancedPreProcessor implementation to a group

registerAdvancedPreProcessorImplementation(String, Class<? extends IAdvancedPreProcessor>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Registers an IAdvancedPreProcessor implementation to a group

registerAdvancedPreProcessorImplementation(String, Class<? extends IAdvancedPreProcessor>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Registers an IAdvancedPreProcessor implementation to a group

registerDetectionType(DetectionType) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Registers a detection type

registerDetectionType(DetectionType) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Registers a detection type

registerDetectionType(DetectionType) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Registers a detection type

registerDetector(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Registers an IDetector implementation to Sherlock.

registerDetector(Class<? extends IDetector>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Registers an IDetector implementation to Sherlock

registerDetector(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Registers an IDetector implementation to Sherlock.

registerEventSubscriber(Object) - Static method in class uk.ac.warwick.dcs.sherlock.api.event.EventBus

Attempts to register an object as an event subscriber, all methods with @EventHandler annotation will be registered

registerEventSubscriber(Object) - Method in interface uk.ac.warwick.dcs.sherlock.api.event.IEventBus

Attempts to register an object as an event subscriber, all methods with @EventHandler annotation will be registered

registerGeneralPreProcessor(Class<? extends IGeneralPreProcessor>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Registers an IGeneralPreProcessor implementation to Sherlock

registerGeneralPreProcessor(Class<? extends IGeneralPreProcessor>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Registers an IGeneralPreProcessor implementation to Sherlock

registerGeneralPreProcessor(Class<? extends IGeneralPreProcessor>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Registers an IGeneralPreProcessor implementation to Sherlock

registerLanguage(String, Class<? extends Lexer>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Register a lexer to the language of the name passed, creating the language if the name is not recognised

registerLanguage(String, Class<? extends Lexer>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Register a lexer to the language of the name passed, creating the language if the name is not recognised

registerLanguage(String, Class<? extends Lexer>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Register a lexer to the language of the name passed, creating the language if the name is not recognised

registerPostProcessor(Class<? extends IPostProcessor>, Class<? extends AbstractModelTaskRawResult>) - Method in interface uk.ac.warwick.dcs.sherlock.api.registry.IRegistry

Registers an IPostProcessor implementation to Sherlock, associates it with the AbstractModelTaskRawResult types it will process

registerPostProcessor(Class<? extends IPostProcessor>, Class<? extends AbstractModelTaskRawResult>) - Static method in class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

Associates an IPostProcessor with a result type [AbstractModelTaskRawResult]

registerPostProcessor(Class<? extends IPostProcessor>, Class<? extends AbstractModelTaskRawResult>) - Method in class uk.ac.warwick.dcs.sherlock.engine.Registry

Registers an IPostProcessor implementation to Sherlock, associates it with the AbstractModelTaskRawResult types it will process

Registry - Class in uk.ac.warwick.dcs.sherlock.engine

Registry implementation, verifies and registers external and internal model components, languages, detection types.

remove() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Delete the job, all tasks and results.

remove() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultJob

Remove this instance, and any children, from storage

remove() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISourceFile

Remove the file

remove() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ISubmission

Remove the submission from the database, cannot be recovered.

remove() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

Remove the workspace, and all of the files and results associated, cannot be undone

remove() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

remove() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

remove() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

remove() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultJob

remove() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

removeDetector(Class<? extends IDetector>) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Removes a detector from the job

removeDetector(Class<? extends IDetector>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

removeGroup(ICodeBlockGroup) - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Remove a group from the list of groups

removeObject(Object) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

removeObject(Object...) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

removePendingSubmission(ISubmission) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Forget and remove a pending submission, and cleans up after it

removePendingSubmission(ISubmission) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

ReportGenerator - Class in uk.ac.warwick.dcs.sherlock.engine.report

reportGet(WorkspaceWrapper, JobResultsData, long, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests to the report submission page

ReportManager - Class in uk.ac.warwick.dcs.sherlock.engine.report

A class to handle report generation in general (does not generate fileReportMap itself).

ReportManager(IResultJob) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.report.ReportManager

Initialises the report manager with a set of results.

rerunGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests to the rerun page

rerunPost(long, long, JobResultsData) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles POST requests to the rerun page

resetParameter(AdjustableParameterObj) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Sets the passed adjustable parameter to its default value

resetParameter(AdjustableParameterObj) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

result - Variable in class uk.ac.warwick.dcs.sherlock.api.model.detection.PairwiseDetectorWorker

ResultJobUnsupportedException - Exception in uk.ac.warwick.dcs.sherlock.api.exception

ResultJobUnsupportedException(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.api.exception.ResultJobUnsupportedException

ResultsController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace

The controller that deals with the workspace results pages

ResultsController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

resultsGetFragment(long, WorkspaceWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles GET requests to the results fragment

ResultsHelper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.results

Functions used by multiple classes involved with displaying the analysis results to the user

ResultsHelper() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.results.ResultsHelper

ResultsNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the job id is not found for the current workspace

ResultsNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.ResultsNotFound

Role - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.db

The database table storing the roles assigned to each account

Role() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

Role(String, Account) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

RoleRepository - Interface in uk.ac.warwick.dcs.sherlock.module.web.data.repositories

The database repository storing the roles for each accound

run() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.pool.PoolExecutorJob

runGetFragment(long, WorkspaceWrapper, AccountWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles GET requests to the run analysis fragment

runPostFragment(long, long, WorkspaceWrapper, AccountWrapper, boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles POST requests to the run analysis fragment

runQuery(String, Class<X>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

runTemplate(TemplateWrapper) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Runs a template on a workspace

runtimeError(Model, Exception) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.ExceptionControllerAdvice

Handles all generic/unknown errors

S

scheduleJob(PriorityWorkTask) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.PriorityWorkScheduler

score(ISourceFile, ISourceFile, List<ICodeBlockGroup>) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.scoring.NGramScorer

Deprecated.

SecurityConfig - Class in uk.ac.warwick.dcs.sherlock.module.web.configuration

Sets up both the web and http security to prevent unauthorised access to account/admin pages

SecurityConfig() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.configuration.SecurityConfig

SecurityController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers

The controller that deals with the login page

SecurityController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.SecurityController

SecurityProperties - Class in uk.ac.warwick.dcs.sherlock.module.web.configuration.properties

The security settings to fetch from the application properties file

SecurityProperties() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SecurityProperties

SERVER - uk.ac.warwick.dcs.sherlock.api.util.Side

set(float) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.AtomicFloat

set(WorkspaceForm) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Update the workspace using the workspace form

setAccount(Account) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

setAccount(Account) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

setAdmin(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

setClassName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Set the detector class name

setComment(String) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

Set the comment string for this block

setComment(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

setComplete() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Used to set task complete if no results are found

setComplete() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

setConfirmPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

setConfirmPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.PasswordForm

setContact(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.WebmasterProperties

Set the contact name attribute in the config file

setDataPath(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

setDescription(String) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.Detector

Sets the user facing description

setDescription(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Set the description

setDetectionType(String) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

Set the detection type for this block

setDetectionType(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

setDetector(TDetector) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

setDetector(TDetector) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Set the detector

setDetectors(List<String>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

setDetectors(Set<TDetector>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

setDisplayName(String) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Display name setter

setDisplayName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Set the detector display name

setDuplicate(int) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

setEmail(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SetupProperties

Set the default user's email address attribute in the config file

setEmail(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

setEmail(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

setEmail(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

setEnableExternalModules(Boolean) - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

setEncryptFiles(Boolean) - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

setEngineId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Workspace

setFiles(MultipartFile[]) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

setFileTotals(Map<ISourceFile, Integer>) - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.ModelTaskProcessedResults

Set the file to integer map for the scoring totals, which are used to calculate the percentage of a file taken by each block, for example this is set to the number of variables in a file for the variable detector to score against this.

setHash(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

setHash(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

setId(int) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Set the id for this match, also updates the colour

setId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

setId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

setId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

setId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

setId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

setId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Workspace

setId(long) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Set the submission ID

setIdentifier(String) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Unique string identifier setter

setInstitution(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.WebmasterProperties

Set the institution name attribute in the config file

setIsAdmin(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

setIsPublic(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

setJobCompleteDismissalTime(int) - Method in class uk.ac.warwick.dcs.sherlock.engine.Configuration

setKey(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SecurityProperties

Sets the secret key attribute in the config file

setKey(K) - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

setKey(K) - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

setLanguage(String) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

setLanguage(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

setLanguage(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

setLanguage(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

setLanguage(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

setLanguage(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Set the workspace language

setLanguages(Set<String>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.EngineDetectorWrapper

Set the languages

setLink(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.WebmasterProperties

Set the contact link attribute in the config file

setMessage(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

setName(String) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IWorkspace

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityWorkspace

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SetupProperties

Set the default user's username attribute in the config file

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Role

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Set the submission name

setName(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Set the workspace name

setNewPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

setOldPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountEmailForm

setOldPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountForm

setOldPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountPasswordForm

setOverallScore(float) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultFile

Sets the overall aggregate score for the file

setOverallScore(float) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultFile

setOverrideModulesPath(String) - Static method in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

Set the module override location

setOwner(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Update the isOwned property

setParameter(AdjustableParameterObj, float) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Sets the passed adjustable parameter to the passed value

Will return false if the AdjustableParameter is invalid

setParameter(AdjustableParameterObj, float) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

setParameter(TParameter) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.ParameterWrapper

Set the database parameter entity for this wrapper

setParameterObj(AdjustableParameterObj) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.ParameterWrapper

Set the adjustable parameter object

setParameters(Map<String, Float>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

setParameters(Set<TParameter>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

setPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SetupProperties

Set the default user's plaintext password attribute in the config file

setPassword(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

setPostprocessing(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

setPostprocessing(Map<String, Float>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

setPublic(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

setPublic(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

setRawResults(List<AbstractModelTaskRawResult>) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ITask

Sets the raw results to be stored and processed

setRawResults(List<AbstractModelTaskRawResult>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

setReady() - Method in class uk.ac.warwick.dcs.sherlock.module.client.LocalDashboard

setReason(String) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Verbose reason block was detected setter

setRoles(Set<Role>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

setScore(float) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Set the submission score

setScore(int) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Set the submission score

setSecureParam(byte[]) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

setSecureParam(byte[]) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityTask

setSingle(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

setStatus(WorkStatus) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IJob

Sets the status of the job

setStatus(WorkStatus) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityJob

setStep(int) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

setSubmissionArchive(EntityWorkspace) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityArchive

setTaskScore(float) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultTask

Sets the overall aggregate score for the instance file for the task

setTaskScore(float) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultTask

setTemplate(Template) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

setTemplate(Template) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Set the template

setTemplates(Set<Template>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

SetupProperties - Class in uk.ac.warwick.dcs.sherlock.module.web.configuration.properties

The settings used to setup sherlock on first boot to fetch from the application properties file

SetupProperties() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.SetupProperties

setUsername(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

setUsername(String) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountNameForm

setValue(float) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

setValue(V) - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

setValue(V) - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

setWeighting(float) - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Setter - Weighting of the type for overall scoring, tuned to adjust the impact of each type to give a balanced overall result and report

setWorkspaces(Set<Workspace>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Account

SherlockClient - Class in uk.ac.warwick.dcs.sherlock.launch

SherlockClient() - Constructor for class uk.ac.warwick.dcs.sherlock.launch.SherlockClient

SherlockEngine - Class in uk.ac.warwick.dcs.sherlock.engine

Main engine class, creates a new instance of Sherlock

SherlockEngine(Side) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

Initial setup

SherlockHelper - Class in uk.ac.warwick.dcs.sherlock.api.util

Static helper functions and access to various engine functions which do not fit elsewhere in the api

SherlockHelper() - Constructor for class uk.ac.warwick.dcs.sherlock.api.util.SherlockHelper

SherlockModule - Annotation Type in uk.ac.warwick.dcs.sherlock.api.annotation

Annotation to mark a module which should be register to the Sherlock engine on startup

SherlockModule.Instance - Annotation Type in uk.ac.warwick.dcs.sherlock.api.annotation

Annotation for an instance variable if required by the module code

Create a variable with the type of the module class, and use this annotation, it will be populated with created instance of the module.

SherlockRegistry - Class in uk.ac.warwick.dcs.sherlock.api.registry

Static access wrapper for the internal registry, should be used on initialisation to add components into the engine

SherlockRegistry() - Constructor for class uk.ac.warwick.dcs.sherlock.api.registry.SherlockRegistry

SherlockServer - Class in uk.ac.warwick.dcs.sherlock.launch

SherlockServer() - Constructor for class uk.ac.warwick.dcs.sherlock.launch.SherlockServer

shutdown() - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

shutsdown the executor

shutdown() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

shutdown() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.common.PriorityWorkScheduler

side - Static variable in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

side() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.EventHandler

Is SherlockEngine running locally (Side.CLIENT) or on a server (Side.SERVER)

side() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.SherlockModule

Is SherlockEngine running locally (Side.CLIENT) or on a server (Side.SERVER)

Side - Enum in uk.ac.warwick.dcs.sherlock.api.util

Sherlock running on a local client, a server.

similarity - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NgramMatch

The similarity between the section of both files.

SimpleObjectEqualityPostProcessor - Class in uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing

SimpleObjectEqualityPostProcessor() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityPostProcessor

SimpleObjectEqualityRawResult<T extends java.io.Serializable> - Class in uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing

SimpleObjectEqualityRawResult(ISourceFile, ISourceFile, int, int) - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

single - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

SourceFileNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the source file is not found in the current submission

SourceFileNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.SourceFileNotFound

Splash - Class in uk.ac.warwick.dcs.sherlock.module.client

Splash() - Constructor for class uk.ac.warwick.dcs.sherlock.module.client.Splash

SpringNotInitialised - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown when Spring hasn't finished loading but a user attempts to load a page

SpringNotInitialised(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.SpringNotInitialised

StandardLexerSpecification - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

Provides a specification for a basic lexer for preprocessing

StandardLexerSpecification() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification

StandardLexerSpecification.channels - Enum in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

reference enum

StandardStringifier - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

StandardStringifier() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardStringifier

StandardTokeniser - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

StandardTokeniser() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardTokeniser

startJob() - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.JobStatus

statisticsGetFragment(boolean, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.DashboardController

step() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.AdjustableParameter

The step to increment or decrement the parameter by in the UI

storage - Static variable in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

store() - Method in interface uk.ac.warwick.dcs.sherlock.api.component.IResultJob

Write this instance, and its children, to storage

store() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityResultJob

storeCodeBlockGroups(List<ICodeBlockGroup>) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Stores the passed code block groups to the database

storeCodeBlockGroups(List<ICodeBlockGroup>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

storeFile(IWorkspace, String, byte[]) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Store file

storeFile(IWorkspace, String, byte[]) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

storeFile(IWorkspace, String, byte[], boolean) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

Store file

storeFile(IWorkspace, String, byte[], boolean) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

storeFile(EntityFile, byte[]) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorageFilesystem

Stores a file on the filesystem

storeObject(Object) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

storeObject(Object...) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EmbeddedDatabase

storeTaskRawResults(EntityTask) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorageFilesystem

Stores a tasks raw results on the filesystem

SubaccountController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin

The controller that deals with all the admin sub-account pages

SubaccountController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin.SubaccountController

SubmissionController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace

The controller that deals with the workspace submission pages

SubmissionController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.SubmissionController

submissionIdPresent(long) - Method in interface uk.ac.warwick.dcs.sherlock.api.component.ICodeBlockGroup

Tests whether any files in the group belong to the specified submission

submissionIdPresent(long) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityCodeBlockGroup

SubmissionMatch - Class in uk.ac.warwick.dcs.sherlock.engine.report

Object to be sent to web report pages, detailing a particular match between files in different submissions.

SubmissionMatch(String, List<SubmissionMatchItem>) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatch

Initialise a new SubmissionMatch object.

SubmissionMatchGroup - Class in uk.ac.warwick.dcs.sherlock.engine.report

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

SubmissionMatchGroup(List<SubmissionMatch>, String) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchGroup

Create a new SubmissionMatchGroup

SubmissionMatchItem - Class in uk.ac.warwick.dcs.sherlock.engine.report

Stored by SubmissionMatch to ensure data for a given file remains together.

SubmissionMatchItem(ISourceFile, float, List<ITuple<Integer, Integer>>) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionMatchItem

Initialise a new SubmissionMatchItem.

SubmissionNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the submission is not found in the current workspace

SubmissionNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.SubmissionNotFound

SubmissionResultsData - Class in uk.ac.warwick.dcs.sherlock.module.web.data.results

Stores all the data for the compare submissions page or the submission report page

SubmissionResultsData(IJob, ISubmission) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Initialise the report data object

SubmissionResultsData(IJob, ISubmission, ISubmission) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.results.SubmissionResultsData

Initialise the comparison data object

SubmissionScore - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.internal

Stores the submission name, id and score to display on the results section of the website

SubmissionScore(long, String, float) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Initialise the submission score object

SubmissionScore(long, String, int) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.SubmissionScore

Initialise the submission score object

SubmissionsForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form to upload submission(s)

SubmissionsForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

SubmissionsForm(MultipartFile[], boolean) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.SubmissionsForm

submissionsGetFragment(long, boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles the GET requests for the submissions list fragment

SubmissionSummary - Class in uk.ac.warwick.dcs.sherlock.engine.report

SubmissionSummary(long, float) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.report.SubmissionSummary

Initialises the SubmissionSummary object.

SubmissionUnsupportedException - Exception in uk.ac.warwick.dcs.sherlock.api.exception

SubmissionUnsupportedException(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.api.exception.SubmissionUnsupportedException

submitJob(IJob) - Method in interface uk.ac.warwick.dcs.sherlock.api.executor.IExecutor

submits a job to this executor

submitJob(IJob) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

submitWork(PriorityWorkTask) - Method in class uk.ac.warwick.dcs.sherlock.engine.executor.BaseExecutor

submitWork(PriorityWorkTask) - Method in interface uk.ac.warwick.dcs.sherlock.engine.executor.common.IPriorityWorkSchedulerWrapper

Non-blocking, submit the task to the work executor

T

TaskWrapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

The wrapper that manages the task

TaskWrapper(ITask) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TaskWrapper

Initialise the wrapper using the task supplied

TDetector - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.db

The database table storing detectors assigned to a template

TDetector() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

TDetector(String, Template) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TDetector

TDetectorRepository - Interface in uk.ac.warwick.dcs.sherlock.module.web.data.repositories

The database repository storing the detectors for each job template

Template - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.db

The database table storing job templates

Template() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Template

TemplateContainsNoDetectors - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the user attempts to run a template when there are no detectors

TemplateContainsNoDetectors(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.TemplateContainsNoDetectors

TemplateController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template

The controller that deals with the manage template pages

TemplateController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

templateDetailsGetFragment(boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template.TemplateController

Handles GET requests to the template details fragment

TemplateForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form to add/modify templates

TemplateForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

TemplateForm(String) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

TemplateForm(TemplateWrapper) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.TemplateForm

TemplateNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the template is not found for the current user

TemplateNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.TemplateNotFound

TemplateRepository - Interface in uk.ac.warwick.dcs.sherlock.module.web.data.repositories

The database repository storing the job templates

TemplatesController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard

The controller that deals with the templates pages

TemplatesController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.TemplatesController

TemplateWrapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

The wrapper that manages the job templates

TemplateWrapper(long, Account, TemplateRepository) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Initialise the template wrapper using an id to find one in the database

TemplateWrapper(Template, Account) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Initialise the template wrapper using an existing template

TemplateWrapper(TemplateForm, Account, TemplateRepository, TDetectorRepository) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Initialise the wrapper using the form to create a new template

terms() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.HelpController

Handles requests to the terms page

testType(AbstractModelTaskRawResult) - Method in class uk.ac.warwick.dcs.sherlock.api.model.postprocessing.AbstractModelTaskRawResult

Check that this object is of the same exact type as the baseline, including check any generic types are equal

testType(AbstractModelTaskRawResult) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Verifies that the inputted RawResult type is the same type as the current object.

testType(AbstractModelTaskRawResult) - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

threshold - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.detection.NGramDetector

The threshold on the similarity value over which something is considered suspicious.

threshold - Variable in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramPostProcessor

Threshold determining when to ignore large sets of matches.

ThymeLeafConfig - Class in uk.ac.warwick.dcs.sherlock.module.web.configuration

Additional config settings for the thymeleaf template engine

ThymeLeafConfig() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.configuration.ThymeLeafConfig

toJSON() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.FileMatch

Convert this object to a JSON object, used by the JavaScript in the UI

toJSON() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.FileMapper

Convert this object to a JSON object, used by the JavaScript in the UI

toJSON() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.results.LineMapper

Convert this object to a JSON object, used by the JavaScript in the UI

toLineNumList() - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.internal.CodeBlock

Generate a list of line numbers between the start and end line numbers (inclusive)

toString() - Method in class uk.ac.warwick.dcs.sherlock.api.model.detection.DetectionType

Constructs string representation of this type

toString() - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

toString() - Method in class uk.ac.warwick.dcs.sherlock.api.util.PairedTuple

toString() - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

toString() - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.EntityFile

toString() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.NGramRawResult

Returns the string form of the list of stored objects along with their locations in their respective files.

toString() - Method in class uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing.SimpleObjectEqualityRawResult

TParameter - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.db

The database table storing parameters for a template detector

TParameter() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

TParameter(String, float, boolean, TDetector) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.TParameter

TParameterRepository - Interface in uk.ac.warwick.dcs.sherlock.module.web.data.repositories

The database repository that stores the parameters for each detector

TrimWhitespaceOnly - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

TrimWhitespaceOnly() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.TrimWhitespaceOnly

Tuple<K,V> - Class in uk.ac.warwick.dcs.sherlock.api.util

Basic tuple implementation

Tuple() - Constructor for class uk.ac.warwick.dcs.sherlock.api.util.Tuple

Tuple(K, V) - Constructor for class uk.ac.warwick.dcs.sherlock.api.util.Tuple

U

uk.ac.warwick.dcs.sherlock.api.annotation - package uk.ac.warwick.dcs.sherlock.api.annotation

uk.ac.warwick.dcs.sherlock.api.component - package uk.ac.warwick.dcs.sherlock.api.component

uk.ac.warwick.dcs.sherlock.api.event - package uk.ac.warwick.dcs.sherlock.api.event

uk.ac.warwick.dcs.sherlock.api.exception - package uk.ac.warwick.dcs.sherlock.api.exception

uk.ac.warwick.dcs.sherlock.api.executor - package uk.ac.warwick.dcs.sherlock.api.executor

uk.ac.warwick.dcs.sherlock.api.model.detection - package uk.ac.warwick.dcs.sherlock.api.model.detection

uk.ac.warwick.dcs.sherlock.api.model.postprocessing - package uk.ac.warwick.dcs.sherlock.api.model.postprocessing

uk.ac.warwick.dcs.sherlock.api.model.preprocessing - package uk.ac.warwick.dcs.sherlock.api.model.preprocessing

uk.ac.warwick.dcs.sherlock.api.registry - package uk.ac.warwick.dcs.sherlock.api.registry

uk.ac.warwick.dcs.sherlock.api.report - package uk.ac.warwick.dcs.sherlock.api.report

uk.ac.warwick.dcs.sherlock.api.storage - package uk.ac.warwick.dcs.sherlock.api.storage

uk.ac.warwick.dcs.sherlock.api.util - package uk.ac.warwick.dcs.sherlock.api.util

uk.ac.warwick.dcs.sherlock.engine - package uk.ac.warwick.dcs.sherlock.engine

uk.ac.warwick.dcs.sherlock.engine.executor - package uk.ac.warwick.dcs.sherlock.engine.executor

uk.ac.warwick.dcs.sherlock.engine.executor.common - package uk.ac.warwick.dcs.sherlock.engine.executor.common

uk.ac.warwick.dcs.sherlock.engine.executor.pool - package uk.ac.warwick.dcs.sherlock.engine.executor.pool

uk.ac.warwick.dcs.sherlock.engine.executor.work - package uk.ac.warwick.dcs.sherlock.engine.executor.work

uk.ac.warwick.dcs.sherlock.engine.report - package uk.ac.warwick.dcs.sherlock.engine.report

uk.ac.warwick.dcs.sherlock.engine.storage - package uk.ac.warwick.dcs.sherlock.engine.storage

uk.ac.warwick.dcs.sherlock.launch - package uk.ac.warwick.dcs.sherlock.launch

uk.ac.warwick.dcs.sherlock.module.client - package uk.ac.warwick.dcs.sherlock.module.client

uk.ac.warwick.dcs.sherlock.module.model.base - package uk.ac.warwick.dcs.sherlock.module.model.base

uk.ac.warwick.dcs.sherlock.module.model.base.detection - package uk.ac.warwick.dcs.sherlock.module.model.base.detection

uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing - package uk.ac.warwick.dcs.sherlock.module.model.base.postprocessing

uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing - package uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

uk.ac.warwick.dcs.sherlock.module.model.base.scoring - package uk.ac.warwick.dcs.sherlock.module.model.base.scoring

uk.ac.warwick.dcs.sherlock.module.web.configuration - package uk.ac.warwick.dcs.sherlock.module.web.configuration

uk.ac.warwick.dcs.sherlock.module.web.configuration.properties - package uk.ac.warwick.dcs.sherlock.module.web.configuration.properties

uk.ac.warwick.dcs.sherlock.module.web.controlleradvice - package uk.ac.warwick.dcs.sherlock.module.web.controlleradvice

uk.ac.warwick.dcs.sherlock.module.web.controllers - package uk.ac.warwick.dcs.sherlock.module.web.controllers

uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard - package uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard

uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template - package uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.template

uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace - package uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace

uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account - package uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.account

uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin - package uk.ac.warwick.dcs.sherlock.module.web.controllers.settings.admin

uk.ac.warwick.dcs.sherlock.module.web.data.models.db - package uk.ac.warwick.dcs.sherlock.module.web.data.models.db

uk.ac.warwick.dcs.sherlock.module.web.data.models.forms - package uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

uk.ac.warwick.dcs.sherlock.module.web.data.models.internal - package uk.ac.warwick.dcs.sherlock.module.web.data.models.internal

uk.ac.warwick.dcs.sherlock.module.web.data.repositories - package uk.ac.warwick.dcs.sherlock.module.web.data.repositories

uk.ac.warwick.dcs.sherlock.module.web.data.results - package uk.ac.warwick.dcs.sherlock.module.web.data.results

uk.ac.warwick.dcs.sherlock.module.web.data.wrappers - package uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

uk.ac.warwick.dcs.sherlock.module.web.exceptions - package uk.ac.warwick.dcs.sherlock.module.web.exceptions

uk.ac.warwick.dcs.sherlock.module.web.filters - package uk.ac.warwick.dcs.sherlock.module.web.filters

uk.ac.warwick.dcs.sherlock.module.web.services - package uk.ac.warwick.dcs.sherlock.module.web.services

uk.ac.warwick.dcs.sherlock.module.web.validation.annotations - package uk.ac.warwick.dcs.sherlock.module.web.validation.annotations

uk.ac.warwick.dcs.sherlock.module.web.validation.validators - package uk.ac.warwick.dcs.sherlock.module.web.validation.validators

UNKNOWN - uk.ac.warwick.dcs.sherlock.api.util.Side

UnknownDetectionTypeException - Exception in uk.ac.warwick.dcs.sherlock.api.exception

UnknownDetectionTypeException(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.api.exception.UnknownDetectionTypeException

update(TemplateForm, TemplateRepository, TDetectorRepository) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.TemplateWrapper

Update the template using the form supplied

updateParameters(ParameterForm, TParameterRepository) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.DetectorWrapper

Update the parameters for this detector

uploadGetFragment() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles GET requests to the upload submissions page

uploadPostFragment(long, WorkspaceWrapper, boolean, SubmissionsForm, BindingResult, Model) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

Handles POST requests to the upload submissions page

uploadSizeExceededError(Model, Authentication, Exception) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controlleradvice.ExceptionControllerAdvice

Handles all requests where the user tried to upload files that are larger than allowed

username - Variable in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.AccountNameForm

V

valid(Side) - Method in enum uk.ac.warwick.dcs.sherlock.api.util.Side

validate(BindingResult, List<AdjustableParameterObj>, boolean) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

Loops through all of the parameters in the form to check the following: - That the parameter exists for the detector - That the min bound, max bound and step restrictions are respected If any conditions are not met, add errors to the binding result object

validate(BindingResult, List<AdjustableParameterObj>, List<AdjustableParameterObj>) - Method in class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.ParameterForm

validateFileStore(List<EntityFile>, List<EntityTask>) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorageFilesystem

Checks the filestore, ensures files are accounted for and that no extra files are present

ValidLanguage - Annotation Type in uk.ac.warwick.dcs.sherlock.module.web.validation.annotations

Defines the annotation of the validator that checks if the language supplied exists in the sherlock engine

ValidLanguageValidator - Class in uk.ac.warwick.dcs.sherlock.module.web.validation.validators

Form validator that checks if the language supplied is valid (i.e.

ValidLanguageValidator() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.ValidLanguageValidator

ValidPassword - Annotation Type in uk.ac.warwick.dcs.sherlock.module.web.validation.annotations

Defines the annotation of the validator that checks if the password supplies matches the password of the current user

ValidPasswordValidator - Class in uk.ac.warwick.dcs.sherlock.module.web.validation.validators

Form validator that checks if the password supplied matches that of the current user

ValidPasswordValidator() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.validation.validators.ValidPasswordValidator

valueEquals(ITuple) - Method in interface uk.ac.warwick.dcs.sherlock.api.util.ITuple

valueEquals(ITuple) - Method in class uk.ac.warwick.dcs.sherlock.api.util.Tuple

valueOf(String) - Static method in enum uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.warwick.dcs.sherlock.api.util.Side

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.warwick.dcs.sherlock.engine.executor.common.Priority

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification.channels

Returns the enum constant of this type with the specified name.

values() - Static method in enum uk.ac.warwick.dcs.sherlock.api.component.WorkStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.warwick.dcs.sherlock.api.util.Side

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.warwick.dcs.sherlock.engine.executor.common.Priority

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification.channels

Returns an array containing the constants of this enum type, in the order they are declared.

VariableExtractor - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

VariableExtractor() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.VariableExtractor

VariableExtractorJava - Class in uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing

VariableExtractorJava() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.VariableExtractorJava

VariableNameDetector - Class in uk.ac.warwick.dcs.sherlock.module.model.base.detection

VariableNameDetector() - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.detection.VariableNameDetector

VariableNameDetectorWorker - Class in uk.ac.warwick.dcs.sherlock.module.model.base.detection

VariableNameDetectorWorker(IDetector, ModelDataItem, ModelDataItem) - Constructor for class uk.ac.warwick.dcs.sherlock.module.model.base.detection.VariableNameDetectorWorker

version - Static variable in class uk.ac.warwick.dcs.sherlock.engine.SherlockEngine

version() - Method in annotation type uk.ac.warwick.dcs.sherlock.api.annotation.SherlockModule

Version string for the module, help users track whether they are up to date

viewGet() - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.SubmissionController

Handles GET requests to the view submission page

viewGet(Model, JobResultsData) - Method in class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.ResultsController

Handles GET requests to the results page

W

WebmasterProperties - Class in uk.ac.warwick.dcs.sherlock.module.web.configuration.properties

The details of the people running the current instance of Sherlock to fetch from the application properties file

WebmasterProperties() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.configuration.properties.WebmasterProperties

WHITESPACE - uk.ac.warwick.dcs.sherlock.module.model.base.preprocessing.StandardLexerSpecification.channels

WorkDetect - Class in uk.ac.warwick.dcs.sherlock.engine.executor.work

Recursive task to run detectors

WorkDetect(JobStatus, List<DetectorWorker>, int) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.work.WorkDetect

WorkPreProcessFile - Class in uk.ac.warwick.dcs.sherlock.engine.executor.work

Recursive task to preprocess a list of files for a single task

WorkPreProcessFiles - Class in uk.ac.warwick.dcs.sherlock.engine.executor.work

recursive task to preprocess a list of tasks for a list of files

WorkPreProcessFiles(List<IWorkTask>, List<ISourceFile>) - Constructor for class uk.ac.warwick.dcs.sherlock.engine.executor.work.WorkPreProcessFiles

Workspace - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.db

The database table storing the workspaces owned by each account

Workspace() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Workspace

Workspace(Account) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Workspace

Workspace(Account, long) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.db.Workspace

WorkspaceController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace

The controller that deals with the manage workspace pages

WorkspaceController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.workspace.WorkspaceController

WorkspaceForm - Class in uk.ac.warwick.dcs.sherlock.module.web.data.models.forms

The form to add/modify workspaces

WorkspaceForm() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

WorkspaceForm(WorkspaceWrapper) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.models.forms.WorkspaceForm

WorkspaceNotFound - Exception in uk.ac.warwick.dcs.sherlock.module.web.exceptions

Thrown if the workspace is not found for the current user

WorkspaceNotFound(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.module.web.exceptions.WorkspaceNotFound

WorkspaceRepository - Interface in uk.ac.warwick.dcs.sherlock.module.web.data.repositories

The database repository storing all workspaces

WorkspacesController - Class in uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard

The controller that deals with the workspaces page

WorkspacesController() - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.controllers.dashboard.WorkspacesController

WorkspaceUnsupportedException - Exception in uk.ac.warwick.dcs.sherlock.api.exception

WorkspaceUnsupportedException(String) - Constructor for exception uk.ac.warwick.dcs.sherlock.api.exception.WorkspaceUnsupportedException

WorkspaceWrapper - Class in uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

The wrapper that manages the workspaces

WorkspaceWrapper(long, Account, WorkspaceRepository) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Initialise the workspace wrapper using an id to find one in the database

WorkspaceWrapper(Workspace) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Initialise the workspace wrapper using an existing workspace

WorkspaceWrapper(WorkspaceForm, Account, WorkspaceRepository) - Constructor for class uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

Initialise the workspace wrapper using the workspace form to create a new workspace

WorkStatus - Enum in uk.ac.warwick.dcs.sherlock.api.component

writePendingSubmission(ISubmission) - Method in interface uk.ac.warwick.dcs.sherlock.api.storage.IStorageWrapper

If the submission clashes with an already existing submission, it will be set as pending

writePendingSubmission(ISubmission) - Method in class uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes All Packages