Package uk.ac.warwick.dcs.sherlock.api.component

Interface IResultFile

  • All Known Implementing Classes:
    EntityResultFile
    public interface IResultFile
    Stores the results of an individual file from a job, is used as child of IResultJob

    • Method Detail

      • addFileScore

        void addFileScore​(ISourceFile file,
                  float score)
        Adds an aggregate score from all tasks of the instance file against another file
        Parameters:
        file - file score is against
        score - score value

      • addTaskResult

        IResultTask addTaskResult​(ITask task)
        Adds a task (an individual detector run) to the file results
        Parameters:
        task - task instance to add
        Returns:
        task results instance

      • getFile

        ISourceFile getFile()
        Get the file this instance represents
        Returns:
        file instance

      • getFileScore

        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 addFileScore(ISourceFile, float)
        Parameters:
        file - file score is against
        Returns:
        score value stored

      • getFileScores

        java.util.Map<ISourceFile,​java.lang.Float> getFileScores()
        Returns the full map of stored file vs instance file aggregate score from all tasks
        Returns:
        map of scores

      • getOverallScore

        float getOverallScore()
        Gets the overall aggregate score for all tasks and other files for the instance file
        Returns:
        score

      • setOverallScore

        void setOverallScore​(float score)
        Sets the overall aggregate score for the file
        Parameters:
        score - aggregate score value

      • getTaskResults

        java.util.List<IResultTask> getTaskResults()
        Returns the list of IResultTask stored for this file
        Returns:
        list of tasks