org.verapdf.pdfa.results

Class ValidationResults

java.lang.Object

org.verapdf.pdfa.results.ValidationResults

public class ValidationResults
extends Object

Author:

Carl Wilson

Method Summary

Methods

Modifier and Type	Method and Description
static TestAssertion	assertionFromValues(int ordinal, RuleId ruleId, TestAssertion.Status status, String message, Location location) Creates an immutable TestAssertion instance from the passed parameter values.
static TestAssertion	defaultAssertion() Returns an immutable default instance of a TestAssertion.
static Location	defaultLocation() Returns an immutable default instance of a Location.
static ValidationResult	defaultResult() Returns an immutable default instance of a ValidationResult.
static ValidationResult	fromXml(InputStream toConvert) Converts an XML representation of a ValidationResult into a ValidationResult instance.
static ValidationResult	fromXml(Reader toConvert) Converts an XML representation of a ValidationResult into a ValidationResult instance.
static ValidationResult	fromXml(String toConvert) Converts an XML representation of a ValidationResult into a ValidationResult instance.
static String	getValidationResultSchema() Returns the JAXB generated XML schema for the ValidationProfileImpl type.
static Location	locationFromValues(String level, String context) TODO: Better explanation of level and context.
static ValidationResult	resultFromValues(PDFAFlavour flavour, Set<TestAssertion> assertions)
static ValidationResult	resultFromValues(PDFAFlavour flavour, Set<TestAssertion> assertions, boolean isCompliant)
static ValidationResult	resultFromValues(PDFAFlavour flavour, Set<TestAssertion> assertions, boolean isCompliant, int totalAssertions)
static String	resultToXml(ValidationResult toConvert, Boolean prettyXml) Converts a ValidationResult instance into an XML String.
static ValidationResult	stripPassedTests(ValidationResult toStrip) Strips any TestAssertions where assertion.getStatus() == TestAssertion.Status.PASSED from toStrip and returns a new ValidationResult without the passed assertions.
static void	toXml(ValidationResult toConvert, OutputStream stream, Boolean prettyXml) Converts a ValidationResult instance into XML which is written to the passed stream.
static void	toXml(ValidationResult toConvert, Writer writer, Boolean prettyXml) Converts a ValidationResult instance into XML which is written to the passed writer.

Methods inherited from class java.lang.Object

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

Method Detail

resultFromValues

public static ValidationResult resultFromValues(PDFAFlavour flavour,
                                Set<TestAssertion> assertions,
                                boolean isCompliant)

Parameters:

flavour - a PDFAFlavour instance indicating the validation type performed

assertions - the Set of TestAssertions reported by during validation

isCompliant - a boolean that indicating whether the validated PDF/A data was compliant with the indicated flavour

Returns:

a new ValidationResult instance populated from the values

resultFromValues

public static ValidationResult resultFromValues(PDFAFlavour flavour,
                                Set<TestAssertion> assertions,
                                boolean isCompliant,
                                int totalAssertions)

Parameters:

flavour - a PDFAFlavour instance indicating the validation type performed

assertions - the Set of TestAssertions reported by during validation

isCompliant - a boolean that indicating whether the validated PDF/A data was compliant with the indicated flavour

totalAssertions -

Returns:

a new ValidationResult instance populated from the values

resultFromValues

public static ValidationResult resultFromValues(PDFAFlavour flavour,
                                Set<TestAssertion> assertions)

Parameters:

flavour - a PDFAFlavour instance indicating the validation type performed

assertions - the Set of TestAssertions reported by during validation

Returns:

a new ValidationResult instance populated from the values

defaultResult

public static ValidationResult defaultResult()

Returns an immutable default instance of a ValidationResult. This is a static single instance, i.e. ValidationResults.defaultResult() == ValidationResults.defaultResult() is always true.

Returns:

the default ValidationResult instance

assertionFromValues

public static TestAssertion assertionFromValues(int ordinal,
                                RuleId ruleId,
                                TestAssertion.Status status,
                                String message,
                                Location location)

Creates an immutable TestAssertion instance from the passed parameter values.

Parameters:

ordinal - the integer ordinal for the instance

ruleId - the RuleId value for Rule the assertion refers to.

status - the TestAssertion.Status of the assertion.

message - any String message to be associated with the assertion.

location - a Location instance indicating the location within the PDF document where the test was performed.

Returns:

an immutable TestAssertion instance initialised using the passed values

defaultAssertion

public static TestAssertion defaultAssertion()

Returns an immutable default instance of a TestAssertion. This is a static single instance, i.e. ValidationResults.defaultAssertion() == ValidationResults.defaultAssertion() is always true.

Returns:

the default TestAssertion instance

locationFromValues

public static Location locationFromValues(String level,
                          String context)

TODO: Better explanation of level and context. Creates an immutable Location instance.

Parameters:

level - the Locations level, represented as a String

context - the Locations context, represented as a String

Returns:

and immutable Location instance initialised with the passed values.

defaultLocation

public static Location defaultLocation()

Returns an immutable default instance of a Location. This is a static single instance, i.e. ValidationResults.defaultLocation() == ValidationResults.defaultLocation() is always true.

Returns:

the default Location instance

resultToXml

public static String resultToXml(ValidationResult toConvert,
                 Boolean prettyXml)
                          throws JAXBException,
                                 IOException

Converts a ValidationResult instance into an XML String. The returned String can be de-serialised from XML to a ValidationResult instance by passing it to the fromXml(String) method.

Parameters:

toConvert - a ValidationResult instance to covert to XML

prettyXml - controls formatting of the returned XML, Boolean.TRUE requests pretty formatting, e.g. new lines and indentation, Boolean.FALSE indicates no formatting is required.

Returns:

the XML representation of the ValidationResult passed as toConvert.

Throws:

JAXBException - this occurs if there's a problem converting the passed type to XML

IOException - if a problem occurs writing the converted result to a String.

fromXml

public static ValidationResult fromXml(String toConvert)
                                throws JAXBException

Converts an XML representation of a ValidationResult into a ValidationResult instance.

Parameters:

toConvert - a String holding an XML serialisation of a ValidationResult.

Returns:

an immutable ValidationResult instance initialised using the passed XML String

Throws:

JAXBException - when there's an error converting the XML

toXml

public static void toXml(ValidationResult toConvert,
         OutputStream stream,
         Boolean prettyXml)
                  throws JAXBException

Converts a ValidationResult instance into XML which is written to the passed stream.

Parameters:

toConvert - a ValidationResult instance to covert to XML

stream - an OutputStream, the destination where the XML representation of the ValidationResult will be written.

prettyXml - controls formatting of the returned XML, Boolean.TRUE requests pretty formatting, e.g. new lines and indentation, Boolean.FALSE indicates no formatting is required.

Throws:

JAXBException - this occurs if there's a problem converting the passed type to XML

fromXml

public static ValidationResult fromXml(InputStream toConvert)
                                throws JAXBException

Converts an XML representation of a ValidationResult into a ValidationResult instance.

Parameters:

toConvert - an ImputStream holding an XML serialisation of a ValidationResult.

Returns:

an immutable ValidationResult instance initialised using the contents of the passed InputStream toConvert.

Throws:

JAXBException - when there's an error converting the XML

toXml

public static void toXml(ValidationResult toConvert,
         Writer writer,
         Boolean prettyXml)
                  throws JAXBException

Converts a ValidationResult instance into XML which is written to the passed writer.

Parameters:

toConvert - a ValidationResult instance to covert to XML

writer - an Writer instance, the destination where the XML representation of the ValidationResult will be written.

prettyXml - controls formatting of the returned XML, Boolean.TRUE requests pretty formatting, e.g. new lines and indentation, Boolean.FALSE indicates no formatting is required.

Throws:

JAXBException - this occurs if there's a problem converting the passed type to XML

fromXml

public static ValidationResult fromXml(Reader toConvert)
                                throws JAXBException

Converts an XML representation of a ValidationResult into a ValidationResult instance.

Parameters:

toConvert - a Reader instance, holding an XML serialisation of a ValidationResult.

Returns:

an immutable ValidationResult instance initialised using the contents of the passed InputStream toConvert.

Throws:

JAXBException - when there's an error converting the XML

getValidationResultSchema

public static String getValidationResultSchema()
                                        throws JAXBException,
                                               IOException

Returns the JAXB generated XML schema for the ValidationProfileImpl type.

Returns:

the String representation of the schema

Throws:

JAXBException - if there's a problem marshaling the schema

IOException - if there's a problem outputting the result

stripPassedTests

public static ValidationResult stripPassedTests(ValidationResult toStrip)

Strips any TestAssertions where assertion.getStatus() == TestAssertion.Status.PASSED from toStrip and returns a new ValidationResult without the passed assertions.

Parameters:

toStrip - a ValidationResult to clone without passed TestAssertions

Returns:

a ValidationResult instance identical to toStrip, but without passed TestAssertions.