Package org.verapdf.processor.reports
Class Reports
- java.lang.Object
-
- org.verapdf.processor.reports.Reports
-
public final class Reports extends Object
- Version:
- 0.1 Created 10 Nov 2016:08:12:36
- Author:
- Carl Wilson carlwilson AT github
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static BatchSummary
createBatchSummary(Components.Timer timer, ValidationBatchSummary validationSummary, FeaturesBatchSummary featureSummary, MetadataRepairBatchSummary repairSummary, int totalJobs, int failedToParse, int encrypted, int outOfMemory, int veraExceptions)
static ValidationReport
createValidationReport(ValidationResult validationResult, boolean logPassed)
static ValidationReport
createValidationReport(ValidationDetails details, String profileName, String statement, boolean isCompliant)
Creates a newValidationReport
instance from the passed parametersstatic MetadataFixerReport
fromValues(String status, int fixCount, List<String> fixes, List<String> errors)
static MetadataFixerReport
fromValues(MetadataFixerResult fixerResult)
static ValidationDetails
fromValues(ValidationResult result, boolean logPassedChecks)
Creates a newValidationDetails
instance from the passed parametersstatic ValidationDetails
fromValues(ValidationResult result, boolean logPassedChecks, int maxFailedChecks)
static ValidationReport
validationReportFromXml(String xmlSource)
Deserialise aValidationReport
from an XML string
-
-
-
Method Detail
-
createBatchSummary
public static final BatchSummary createBatchSummary(Components.Timer timer, ValidationBatchSummary validationSummary, FeaturesBatchSummary featureSummary, MetadataRepairBatchSummary repairSummary, int totalJobs, int failedToParse, int encrypted, int outOfMemory, int veraExceptions)
- Parameters:
timer
- aComponents.Timer
instance which is stopped to measure the duration of the batch processjobs
- the number of jobs in the batchfailedJobs
- the number o failed jobs in the batchvalid
- the number of valid PDF/A documents in the batchinValid
- the number of invalid PDF/A documents in the batchvalidExcep
- the number of validation jobs that threw exceptionsfeatures
- the number of feature extraction jobs run- Returns:
- a new
BatchSummary
instance created using the passed values
-
createValidationReport
public static final ValidationReport createValidationReport(ValidationDetails details, String profileName, String statement, boolean isCompliant)
Creates a newValidationReport
instance from the passed parameters- Parameters:
details
- theValidationDetails
instance to add to the reportprofileName
- the name of theValidationProfile
used to validation the PDF/Astatement
- a String statement, should indicate whether the file was valid or invalidisCompliant
- boolean value, set true if PDF/A document complied with the validation profile rules- Returns:
- a new
ValidationReport
instance
-
createValidationReport
public static final ValidationReport createValidationReport(ValidationResult validationResult, boolean logPassed)
-
validationReportFromXml
public static final ValidationReport validationReportFromXml(String xmlSource) throws JAXBException
Deserialise aValidationReport
from an XML string- Parameters:
xmlSource
- a String value which is the XML representation of theValidationReport
- Returns:
- a new
ValidationReport
instance deserialised from the source string - Throws:
JAXBException
- when the passed String is not a validValidationReport
representation
-
fromValues
public static final ValidationDetails fromValues(ValidationResult result, boolean logPassedChecks)
Creates a newValidationDetails
instance from the passed parameters- Parameters:
result
- theValidationResult
produced by the validation tasklogPassedChecks
- boolean indicating whether passed checks were logged- Returns:
- a new
ValidationDetails
instance
-
fromValues
public static final MetadataFixerReport fromValues(String status, int fixCount, List<String> fixes, List<String> errors)
-
fromValues
public static final ValidationDetails fromValues(ValidationResult result, boolean logPassedChecks, int maxFailedChecks)
-
fromValues
public static final MetadataFixerReport fromValues(MetadataFixerResult fixerResult)
-
-