Package crypto.reporting

Class CSVSummaryReporter

java.lang.Object

crypto.analysis.CrySLAnalysisListener

crypto.reporting.ErrorMarkerListener

crypto.reporting.Reporter

crypto.reporting.CSVSummaryReporter

All Implemented Interfaces:

ICrySLPerformanceListener, ICrySLResultsListener

public class CSVSummaryReporter
extends Reporter

This class extends the class Reporter by generating a summary of the analysis and write it into a csv file. Compared to the CSVReporter this reporter will not output any information about the concrete errors found in the analysis. The summary will only contain the number of error types and in which classes from the rule set the errors were found.

Field Summary

Fields inherited from class crypto.reporting.Reporter

analysisWatch, dataflowReachableMethods, objects, statistics

Fields inherited from class crypto.reporting.ErrorMarkerListener

errorMarkerCount, errorMarkers, secureObjects

Constructor Summary

Constructors

Constructor	Description
CSVSummaryReporter(String reportDir, String softwareId, List<CrySLRule> rules, long callGraphConstructionTime, boolean includeStatistics)	Subclass of Reporter.

Method Summary

Modifier and Type	Method	Description
void	handleAnalysisResults()	This method is called after the analysis is finished and all statistics have been computed.
void	reportError(AbstractError error)

Methods inherited from class crypto.reporting.Reporter

afterAnalysis, beforeAnalysis, discoveredSeed, getObjects, getOutputFolder, getRules, getStatistics, includeStatistics, onSeedFinished

Methods inherited from class crypto.reporting.ErrorMarkerListener

addProgress, afterConstraintCheck, afterPredicateCheck, beforeConstraintCheck, beforePredicateCheck, boomerangQueryFinished, boomerangQueryStarted, checkedConstraints, collectedValues, ensuredPredicates, filterQuotes, onSecureObjectFound, onSeedTimeout, seedStarted

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVSummaryReporter

public CSVSummaryReporter(String reportDir,
                          String softwareId,
                          List<CrySLRule> rules,
                          long callGraphConstructionTime,
                          boolean includeStatistics)

Subclass of Reporter. Creates an instance of CSVSummaryReporter, which can be used to create a csv file containing a summary of the analysis.

Parameters:

reportDir - A String path giving the location of the report directory. The reportPath should end without an ending file separator.

softwareId - A String for the analyzed software.

rules - A List of CrySLRule containing the rules the program is analyzed with.

callGraphConstructionTime - The time in milliseconds for the construction of the callgraph.

includeStatistics - Set this value to true, if the analysis report should contain some analysis statistics (e.g. the callgraph construction time). If this value is set to false, no statistics will be output.

Method Detail

handleAnalysisResults

public void handleAnalysisResults()

Description copied from class: Reporter

This method is called after the analysis is finished and all statistics have been computed. A subclass can override this method to extend the actions after the analysis, e.g. creating an analysis report and write it into a file.

Specified by:

handleAnalysisResults in class Reporter

reportError

public void reportError(AbstractError error)

Specified by:

reportError in interface ICrySLResultsListener

Overrides:

reportError in class ErrorMarkerListener