efxtools.sample.application
Class Experimenter

java.lang.Object
  extended by efxtools.sample.application.Experimenter

public class Experimenter
extends java.lang.Object

This class allows to configure and run an experiment for the filtering framework and to print the performance results of this experiment afterwards. An application can create an object of this class and then call the corresponding methods.

Author:
Author of EfXTools

Constructor Summary
Experimenter(java.lang.String dataPath, java.lang.String cpePath, java.lang.String aePath, java.lang.String queryString, java.lang.String queryName, int repetitions, boolean doFiltering, int[] relationTypes)
          The constructor configures the experiment based on the given paths, the given query, the given number of repetitions and the indicator for whether to do filtering.
 
Method Summary
 void finish()
          Destroys the applied analysis engine and collection processing engine.
 void printPerformanceResults()
          Prints the rounded performance results of this experiment using the given name of the query for the title.
 void runExperiment()
          Runs the experiment.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Experimenter

public Experimenter(java.lang.String dataPath,
                    java.lang.String cpePath,
                    java.lang.String aePath,
                    java.lang.String queryString,
                    java.lang.String queryName,
                    int repetitions,
                    boolean doFiltering,
                    int[] relationTypes)
             throws java.lang.Exception
The constructor configures the experiment based on the given paths, the given query, the given number of repetitions and the indicator for whether to do filtering.

Parameters:
dataPath - The path of directory of the dataset to be processed
cpePath - The path of the collection processing engine descriptor
aePath - The path of the analysis engine processor
queryString - The query as a string
queryName - The name of the query used for printing
repetitions - The number of repetitions
doFiltering - Whether to do filtering
relationTypes - The relation types to be printed
Throws:
java.lang.Exception - Thrown if I/O problems occur
Method Detail

runExperiment

public void runExperiment()
                   throws java.lang.Exception
Runs the experiment.

Throws:
java.lang.Exception - Thrown if analysis or collection processing problems occur

finish

public void finish()
Destroys the applied analysis engine and collection processing engine.


printPerformanceResults

public void printPerformanceResults()
Prints the rounded performance results of this experiment using the given name of the query for the title.