Package uk.ac.warwick.dcs.sherlock.module.web.data.wrappers

Class WorkspaceWrapper

java.lang.Object

uk.ac.warwick.dcs.sherlock.module.web.data.wrappers.WorkspaceWrapper

public class WorkspaceWrapper
extends java.lang.Object

The wrapper that manages the workspaces

Constructor Summary

Constructors

Constructor	Description
WorkspaceWrapper(long id, Account account, WorkspaceRepository workspaceRepository)	Initialise the workspace wrapper using an id to find one in the database
WorkspaceWrapper(Workspace workspace)	Initialise the workspace wrapper using an existing workspace
WorkspaceWrapper(WorkspaceForm workspaceForm, Account account, WorkspaceRepository workspaceRepository)	Initialise the workspace wrapper using the workspace form to create a new workspace

Method Summary

Modifier and Type	Method	Description
java.util.List<ITuple<ISubmission,ISubmission>>	addSubmissions(SubmissionsForm submissionsForm)	Add submissions to this workspace
void	delete(WorkspaceRepository workspaceRepository)	Delete the workspace
static java.util.List<WorkspaceWrapper>	findByAccount(Account account, WorkspaceRepository workspaceRepository)	Gets the list of workspaces owned by the current user
long	getEngineId()	Get the workspace engine id
java.util.List<ISourceFile>	getFiles()	Get the workspace files
long	getId()	Get the workspace web id
IWorkspace	getiWorkspace()	Get the engine workspace entity
java.util.List<IJob>	getJobs()	Get the workspace jobs
java.lang.String	getLanguage()	Get the workspace language
java.lang.String	getName()	Get the workspace name
java.util.List<ISubmission>	getSubmissions()	Get the workspace submissions
Workspace	getWorkspace()	Get the web database workspace entity
long	runTemplate(TemplateWrapper templateWrapper)	Runs a template on a workspace
void	set(WorkspaceForm workspaceForm)	Update the workspace using the workspace form
void	setLanguage(java.lang.String language)	Set the workspace language
void	setName(java.lang.String name)	Set the workspace name

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceWrapper

public WorkspaceWrapper(WorkspaceForm workspaceForm,
                        Account account,
                        WorkspaceRepository workspaceRepository)

Initialise the workspace wrapper using the workspace form to create a new workspace

Parameters:

workspaceForm - the form

account - the account of the current user

workspaceRepository - the database repository

WorkspaceWrapper

public WorkspaceWrapper(Workspace workspace)
                 throws IWorkspaceNotFound

Initialise the workspace wrapper using an existing workspace

Parameters:

workspace - the workspace to manage

Throws:

IWorkspaceNotFound - if the workspace entity was not found in the engine

WorkspaceWrapper

public WorkspaceWrapper(long id,
                        Account account,
                        WorkspaceRepository workspaceRepository)
                 throws WorkspaceNotFound,
                        IWorkspaceNotFound

Initialise the workspace wrapper using an id to find one in the database

Parameters:

id - the id of the account to find

account - the account of the current user

workspaceRepository - the database repository

Throws:

WorkspaceNotFound - if the workspace was not found in the web database

IWorkspaceNotFound - if the workspace entity was not found in the engine

Method Detail

getWorkspace

public Workspace getWorkspace()

Get the web database workspace entity

Returns:

the workspace

getiWorkspace

public IWorkspace getiWorkspace()

Get the engine workspace entity

Returns:

the workspace

getId

public long getId()

Get the workspace web id

Returns:

the id

getEngineId

public long getEngineId()

Get the workspace engine id

Returns:

the id

getName

public java.lang.String getName()

Get the workspace name

Returns:

the name

getLanguage

public java.lang.String getLanguage()

Get the workspace language

Returns:

the language

getFiles

public java.util.List<ISourceFile> getFiles()

Get the workspace files

Returns:

the list of files

getSubmissions

public java.util.List<ISubmission> getSubmissions()

Get the workspace submissions

Returns:

the list of submissions

getJobs

public java.util.List<IJob> getJobs()

Get the workspace jobs

Returns:

the list of jobs

setName

public void setName(java.lang.String name)

Set the workspace name

Parameters:

name - the new name

setLanguage

public void setLanguage(java.lang.String language)

Set the workspace language

Parameters:

language - the new language

set

public void set(WorkspaceForm workspaceForm)

Update the workspace using the workspace form

Parameters:

workspaceForm - the form to use

delete

public void delete(WorkspaceRepository workspaceRepository)

Delete the workspace

Parameters:

workspaceRepository - the database repository

addSubmissions

public java.util.List<ITuple<ISubmission,ISubmission>> addSubmissions(SubmissionsForm submissionsForm)
                                                                     throws NoFilesUploaded,
                                                                            FileUploadFailed

Add submissions to this workspace

Parameters:

submissionsForm - the form to use

Throws:

NoFilesUploaded - if no files were uploaded

FileUploadFailed - if uploading the files failed

runTemplate

public long runTemplate(TemplateWrapper templateWrapper)
                 throws TemplateContainsNoDetectors,
                        java.lang.ClassNotFoundException,
                        ParameterNotFound,
                        DetectorNotFound,
                        NoFilesUploaded

Runs a template on a workspace

Parameters:

templateWrapper - the template to run

Throws:

TemplateContainsNoDetectors - if there are no detectors in the template

java.lang.ClassNotFoundException - if the detector no longer exists

ParameterNotFound - if the parameter no longer exists

DetectorNotFound - if the detector no longer exists

NoFilesUploaded - if no files were uploaded

findByAccount

public static java.util.List<WorkspaceWrapper> findByAccount(Account account,
                                                             WorkspaceRepository workspaceRepository)

Gets the list of workspaces owned by the current user

Parameters:

account - the account of the current user

workspaceRepository - the database repository

Returns:

the list of workspaces