Package org.fcrepo.migration.validator.report

Class HtmlReportHandler

java.lang.Object

org.fcrepo.migration.validator.report.HtmlReportHandler

All Implemented Interfaces:

ReportHandler

public class HtmlReportHandler
extends Object
implements ReportHandler

This class is responsible for writing the HTML to disk for a given validation report

Since:

2020-12-16

Author:

awoods

Constructor Summary

Constructors

Constructor	Description
HtmlReportHandler(Path outputDir)	Constructor

Method Summary

Modifier and Type	Method	Description
void	beginReport()	A hook indicating the start of a result processing run
void	endReport()	A hook indicating the end of a result processing run
String	objectLevelReport(ObjectValidationResults objectValidationResults)	This method write the HTML report for a single object
String	repositoryLevelReport(ObjectValidationResults objectValidationResults)	A hook for processing a repository level validation report
String	validationSummary(ValidationResultsSummary validationSummary)	This method writes the HTML summary of the entire validation run

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlReportHandler

public HtmlReportHandler(Path outputDir)

Constructor

Parameters:

outputDir - to which the HTML files are written

Method Detail

beginReport

public void beginReport()

Description copied from interface: ReportHandler

A hook indicating the start of a result processing run

Specified by:

beginReport in interface ReportHandler

objectLevelReport

public String objectLevelReport(ObjectValidationResults objectValidationResults)

This method write the HTML report for a single object

Specified by:

objectLevelReport in interface ReportHandler

Parameters:

objectValidationResults - An individual object validation report

Returns:

filename of HTML object report

repositoryLevelReport

public String repositoryLevelReport(ObjectValidationResults objectValidationResults)

Description copied from interface: ReportHandler

A hook for processing a repository level validation report

Specified by:

repositoryLevelReport in interface ReportHandler

Parameters:

objectValidationResults - An individual validation report

Returns:

filename of repository report

validationSummary

public String validationSummary(ValidationResultsSummary validationSummary)

This method writes the HTML summary of the entire validation run

Specified by:

validationSummary in interface ReportHandler

Parameters:

validationSummary - of this validation run

Returns:

filename of full report

endReport

public void endReport()

Description copied from interface: ReportHandler

A hook indicating the end of a result processing run

Specified by:

endReport in interface ReportHandler