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

Class EntityResultFile

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable, IResultFile

@Entity(name="ResultFile")
public class EntityResultFile
extends java.lang.Object
implements IResultFile, java.io.Serializable

IResultFile object for base storage implementation

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
void	addFileScore(ISourceFile file, float score)	Adds an aggregate score from all tasks of the instance file against another file
IResultTask	addTaskResult(ITask task)	Adds a task (an individual detector run) to the file results
ISourceFile	getFile()	Get the file this instance represents
float	getFileScore(ISourceFile file)	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)
java.util.Map<ISourceFile,java.lang.Float>	getFileScores()	Returns the full map of stored file vs instance file aggregate score from all tasks
float	getOverallScore()	Gets the overall aggregate score for all tasks and other files for the instance file
java.util.List<IResultTask>	getTaskResults()	Returns the list of IResultTask stored for this file
void	setOverallScore(float score)	Sets the overall aggregate score for the file

Methods inherited from class java.lang.Object

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

Method Detail

addFileScore

public void addFileScore(ISourceFile file,
                         float score)

Description copied from interface: IResultFile

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

Specified by:

addFileScore in interface IResultFile

Parameters:

file - file score is against

score - score value

addTaskResult

public IResultTask addTaskResult(ITask task)

Description copied from interface: IResultFile

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

Specified by:

addTaskResult in interface IResultFile

Parameters:

task - task instance to add

Returns:

task results instance

getFile

public ISourceFile getFile()

Description copied from interface: IResultFile

Get the file this instance represents

Specified by:

getFile in interface IResultFile

Returns:

file instance

getFileScore

public float getFileScore(ISourceFile file)

Description copied from interface: 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)

Specified by:

getFileScore in interface IResultFile

Parameters:

file - file score is against

Returns:

score value stored

getFileScores

public java.util.Map<ISourceFile,java.lang.Float> getFileScores()

Description copied from interface: IResultFile

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

Specified by:

getFileScores in interface IResultFile

Returns:

map of scores

getOverallScore

public float getOverallScore()

Description copied from interface: IResultFile

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

Specified by:

getOverallScore in interface IResultFile

Returns:

score

setOverallScore

public void setOverallScore(float score)

Description copied from interface: IResultFile

Sets the overall aggregate score for the file

Specified by:

setOverallScore in interface IResultFile

Parameters:

score - aggregate score value

getTaskResults

public java.util.List<IResultTask> getTaskResults()

Description copied from interface: IResultFile

Returns the list of IResultTask stored for this file

Specified by:

getTaskResults in interface IResultFile

Returns:

list of tasks