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

Class BaseStorage

java.lang.Object

uk.ac.warwick.dcs.sherlock.engine.storage.BaseStorage

All Implemented Interfaces:

ISourceFileHelper, IStorageWrapper

public class BaseStorage
extends java.lang.Object
implements IStorageWrapper

Basic storage implementation

Constructor Summary

Constructors

Constructor	Description
BaseStorage()

Method Summary

Modifier and Type	Method	Description
void	close()	Shutdown the database
IWorkspace	createWorkspace(java.lang.String name, java.lang.String lang)	Create a new IWorkspace instance
java.lang.Class<? extends ICodeBlockGroup>	getCodeBlockGroupClass()	Fetches the class of ICodeBlockGroup used in this IStorageWrapper implementation
EmbeddedDatabase	getDatabase()
ReportManager	getReportGenerator(IResultJob resultJob)	Returns a prepared report manager for the IResultJob, uses cached instances were possible
ISourceFile	getSourceFile(long persistentId)	Fetches instance of the ISourceFile for the unique id passed
ISubmission	getSubmissionFromName(IWorkspace workspace, java.lang.String submissionName)	Fetches a submission for the passed name if one exists, else returns null
java.util.List<IWorkspace>	getWorkspaces()	Get all stored workspaces
java.util.List<IWorkspace>	getWorkspaces(java.util.List<java.lang.Long> ids)
void	mergePendingSubmission(ISubmission existing, ISubmission pending)	Merge two submissions into a single submission, can be used to sort out name collisions
void	removePendingSubmission(ISubmission pendingSubmission)	Forget and remove a pending submission, and cleans up after it
boolean	storeCodeBlockGroups(java.util.List<ICodeBlockGroup> groups)	Stores the passed code block groups to the database
java.util.List<ITuple<ISubmission,ISubmission>>	storeFile(IWorkspace workspace, java.lang.String filename, byte[] fileContent)	Store file
java.util.List<ITuple<ISubmission,ISubmission>>	storeFile(IWorkspace workspace, java.lang.String filename, byte[] fileContent, boolean archiveContainsMultipleSubmissions)	Store file
void	writePendingSubmission(ISubmission pendingSubmission)	If the submission clashes with an already existing submission, it will be set as pending

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseStorage

public BaseStorage()

Method Detail

close

public void close()

Description copied from interface: IStorageWrapper

Shutdown the database

Specified by:

close in interface IStorageWrapper

createWorkspace

public IWorkspace createWorkspace(java.lang.String name,
                                  java.lang.String lang)

Description copied from interface: IStorageWrapper

Create a new IWorkspace instance

Specified by:

createWorkspace in interface IStorageWrapper

Parameters:

name - name to create workspace under

lang - language of the workspace

Returns:

instance

getCodeBlockGroupClass

public java.lang.Class<? extends ICodeBlockGroup> getCodeBlockGroupClass()

Description copied from interface: IStorageWrapper

Fetches the class of ICodeBlockGroup used in this IStorageWrapper implementation

Specified by:

getCodeBlockGroupClass in interface IStorageWrapper

Returns:

class for ICodeBlockGroup

getReportGenerator

public ReportManager getReportGenerator(IResultJob resultJob)
                                 throws ResultJobUnsupportedException

Description copied from interface: IStorageWrapper

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

Specified by:

getReportGenerator in interface IStorageWrapper

Parameters:

resultJob - result to generate reports for

Returns:

instance of ReportManager

Throws:

ResultJobUnsupportedException - Thrown if IResultJob instance was not created by this IStorageWrapper implementation

getSourceFile

public ISourceFile getSourceFile(long persistentId)

Description copied from interface: ISourceFileHelper

Fetches instance of the ISourceFile for the unique id passed

Specified by:

getSourceFile in interface ISourceFileHelper

Parameters:

persistentId - unique id of the file

Returns:

instance

getSubmissionFromName

public ISubmission getSubmissionFromName(IWorkspace workspace,
                                         java.lang.String submissionName)
                                  throws WorkspaceUnsupportedException

Description copied from interface: IStorageWrapper

Fetches a submission for the passed name if one exists, else returns null

Specified by:

getSubmissionFromName in interface IStorageWrapper

Parameters:

workspace - workspace to search for submission

submissionName - submission name

Returns:

submission if exists, else null

Throws:

WorkspaceUnsupportedException - Thrown if IWorkspace instance was not created by this IStorageWrapper implementation

getWorkspaces

public java.util.List<IWorkspace> getWorkspaces(java.util.List<java.lang.Long> ids)

Specified by:

getWorkspaces in interface IStorageWrapper

Parameters:

ids - workspace ids to fetch

Returns:

a list of all workspaces matching the passed ids in the database

getWorkspaces

public java.util.List<IWorkspace> getWorkspaces()

Description copied from interface: IStorageWrapper

Get all stored workspaces

Specified by:

getWorkspaces in interface IStorageWrapper

Returns:

a list of all workspaces in the database

mergePendingSubmission

public void mergePendingSubmission(ISubmission existing,
                                   ISubmission pending)
                            throws SubmissionUnsupportedException

Description copied from interface: IStorageWrapper

Merge two submissions into a single submission, can be used to sort out name collisions

Specified by:

mergePendingSubmission in interface IStorageWrapper

Parameters:

existing - first submission, is left, must already exist in the database

pending - second submission, is removed after merge

Throws:

SubmissionUnsupportedException - Thrown if ISubmission instance was not created by this IStorageWrapper implementation

removePendingSubmission

public void removePendingSubmission(ISubmission pendingSubmission)
                             throws SubmissionUnsupportedException

Description copied from interface: IStorageWrapper

Forget and remove a pending submission, and cleans up after it

Specified by:

removePendingSubmission in interface IStorageWrapper

Parameters:

pendingSubmission - pending submission to forget and remove

Throws:

SubmissionUnsupportedException - Thrown if ISubmission instance was not created by this IStorageWrapper implementation

storeCodeBlockGroups

public boolean storeCodeBlockGroups(java.util.List<ICodeBlockGroup> groups)

Description copied from interface: IStorageWrapper

Stores the passed code block groups to the database

Specified by:

storeCodeBlockGroups in interface IStorageWrapper

Parameters:

groups - list of the code block groups to store

Returns:

was successful?

storeFile

public java.util.List<ITuple<ISubmission,ISubmission>> storeFile(IWorkspace workspace,
                                                                       java.lang.String filename,
                                                                       byte[] fileContent)
                                                                throws WorkspaceUnsupportedException

Description copied from interface: IStorageWrapper

Store file

Specified by:

storeFile in interface IStorageWrapper

Parameters:

workspace - workspace to upload file to

filename - filename uploaded, used as the identifier to show to the user, identifying the file or files

fileContent - raw content of the file

Returns:

list of tuples, which contain any collisions between submission names. The first element is the existing submission, the second is the new

Throws:

WorkspaceUnsupportedException - Thrown if IWorkspace instance was not created by this IStorageWrapper implementation

storeFile

public java.util.List<ITuple<ISubmission,ISubmission>> storeFile(IWorkspace workspace,
                                                                       java.lang.String filename,
                                                                       byte[] fileContent,
                                                                       boolean archiveContainsMultipleSubmissions)
                                                                throws WorkspaceUnsupportedException

Description copied from interface: IStorageWrapper

Store file

Specified by:

storeFile in interface IStorageWrapper

Parameters:

workspace - workspace to upload file to

filename - filename uploaded, used as the identifier to show to the user, identifying the file or files

fileContent - raw content of the file

archiveContainsMultipleSubmissions - are the archive top level directories separate submissions?

Returns:

list of tuples, which contain any collisions between submission names. The first element is the existing submission, the second is the new

Throws:

WorkspaceUnsupportedException - Thrown if IWorkspace instance was not created by this IStorageWrapper implementation

writePendingSubmission

public void writePendingSubmission(ISubmission pendingSubmission)
                            throws SubmissionUnsupportedException

Description copied from interface: IStorageWrapper

If the submission clashes with an already existing submission, it will be set as pending

IF a submission is pending this method will remove existing submission with the same name and write the pending submission to the database

Specified by:

writePendingSubmission in interface IStorageWrapper

Parameters:

pendingSubmission - pending submission to properly write

Throws:

SubmissionUnsupportedException - Thrown if ISubmission instance was not created by this IStorageWrapper implementation

getDatabase

public EmbeddedDatabase getDatabase()