Package de.uni_mannheim.informatik.dws.melt.matching_eval.evaluator

Class Evaluator

java.lang.Object
de.uni_mannheim.informatik.dws.melt.matching_eval.evaluator.Evaluator
Direct Known Subclasses:
DashboardBuilder, EvaluatorAlignmentAnalyzer, EvaluatorBasic, EvaluatorCopyResults, EvaluatorCSV, EvaluatorMcNemarSignificance, EvaluatorPipeline, EvaluatorRank, EvaluatorRankGroup, EvaluatorRelationTypePrediction, ResultsPageHTML, ResultsPageLatex
public abstract class Evaluator extends Object
Abstract class for all default evaluators.
Author:
Sven Hertling, Jan Portisch

  • Field Details

    • LOGGER

      private static final org.slf4j.Logger LOGGER
      Default Logger

    • resultsDirectory

      private static File resultsDirectory
      The directory where the results shall be written to.

    • results

      protected ExecutionResultSet results
      Set of the individual instances of ExecutionResult for which an evaluation will be performed.

  • Constructor Details

    • Evaluator

      public Evaluator(ExecutionResultSet results)
      Constructor.
      Parameters:
      results - The results of the matching process.

  • Method Details

    • setDefaultResultsDirectory

      public static void setDefaultResultsDirectory(File directory)
      Set the defaults results directory.
      Parameters:
      directory - The directory where the results shall be written to.

    • getDefaultResultsDirectory

      public static File getDefaultResultsDirectory()
      Returns the default results directory.
      Returns:
      the default results directory

    • writeToDirectory

      public void writeToDirectory()
      Perform an evaluation and persist the results of the evaluator in the default directory.

    • getDirectoryWithCurrentTime

      public static File getDirectoryWithCurrentTime()

    • writeToDirectory

      public void writeToDirectory(File baseDirectory)
      Perform an evaluation and persist the results of the evaluator in the given directory.
      Parameters:
      baseDirectory - The directory which shall be used to place the evaluation files. The directory will be created if it does not exist.

    • writeResultsToDirectory

      protected abstract void writeResultsToDirectory(File baseDirectory)

    • writeToDirectory

      public void writeToDirectory(String baseDirectoryPath)
      Perform an evaluation and persist the results of the evaluator in the default directory.
      Parameters:
      baseDirectoryPath - The directory path which shall be used to place the evaluation files. The directory will be created if it does not exist.

    • checkAndCreateDirectory

      protected void checkAndCreateDirectory(File directory)
      Checks if the directory is not null, creates it and check if it is a directory. Throws an exception if something is not correct.
      Parameters:
      directory - the directory to inspect

    • getResultsDirectoryTrackTestcaseMatcher

      protected File getResultsDirectoryTrackTestcaseMatcher(File baseDirectory, ExecutionResult executionResult)
      Given a base directory and an ExecutionResult, the target directory will be returned to which results can be persisted.
      Parameters:
      baseDirectory - Base directory for evaluation results.
      executionResult - Execution result whose evaluation shall be persisted.
      Returns:
      Directory where evaluation result can be persisted.

    • getResultsDirectoryTrack

      protected File getResultsDirectoryTrack(File baseDirectory, Track track)
      Given a base directory and a test case, the target directory will be returned for aggregated results.
      Parameters:
      baseDirectory - Base directory for evaluation results.
      track - Track
      Returns:
      Directory where aggregated evaluation results can be persisted.

    • getResultsDirectoryTrackMatcher

      protected File getResultsDirectoryTrackMatcher(File baseDirectory, Track track, String matcherName)
      Given a base directory and a test case, the target directory will be returned for aggregated results.
      Parameters:
      baseDirectory - Base directory for evaluation results.
      track - Track
      matcherName - the name of ther matcher
      Returns:
      Directory where aggregated evaluation results can be persisted.

    • getResults

      public ExecutionResultSet getResults()