org.verapdf.pdfa

Interface VeraPDFFoundry

All Superinterfaces:

AutoCloseable, Closeable, Component

public interface VeraPDFFoundry
extends Component

The veraPDFFoundry interface provides methods for creating implementations of the classes provided by a PDF Parser and Metadata Fixer implementations.

Version:

0.1 Created 21 Sep 2016:12:37:55

Author:

Carl Wilson carlwilson AT github

Method Summary

Modifier and Type	Method and Description
PDFAValidator	createFailFastValidator(PDFAFlavour flavour, int maxFailures) Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.
PDFAValidator	createFailFastValidator(ValidationProfile profile, int maxFailures) Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.
MetadataFixer	createMetadataFixer() Obtain a new MetadataFixer instance.
PDFAParser	createParser(File pdfFile) Method that returns a PDFParser instance, parsing file passed as pdfStream parameter.
PDFAParser	createParser(File pdfFile, PDFAFlavour flavour) Method that returns a PDFParser instance, parsing file passed as pdfFile parameter.
PDFAParser	createParser(InputStream pdfStream) Method that returns a PDFParser instance, parsing the passed pdfStream parameter.
PDFAParser	createParser(InputStream pdfStream, PDFAFlavour flavour) Method that returns a PDFParser instance, parsing the passed pdfStream parameter.
PDFAValidator	createValidator(PDFAFlavour flavour, boolean logSuccess) Creates a new PDFAValidator instance that uses one of the ValidationProfiles packaged as a core library resource.
PDFAValidator	createValidator(ValidationProfile profile, boolean logSuccess) Creates a new PDFAValidator initialised with the passed profile and chosen passed test logging.
PDFAValidator	createValidator(ValidatorConfig config) Obtain a new PDFAValidator instance.
PDFAValidator	createValidator(ValidatorConfig config, PDFAFlavour flavour) Obtain a new PDFAValidator instance that uses a custom PDFAFlavour.
PDFAValidator	createValidator(ValidatorConfig config, ValidationProfile profile) Obtain a new PDFAValidator instance that uses a custom ValidationProfile instance.
PDFAFlavour	defaultFlavour()
String	getParserId()

Methods inherited from interface org.verapdf.component.Component

getDetails

Methods inherited from interface java.io.Closeable

close

Method Detail

createParser

PDFAParser createParser(InputStream pdfStream)
                 throws ModelParsingException,
                        EncryptedPdfException

Method that returns a PDFParser instance, parsing the passed pdfStream parameter. The parser or parser provider will detect the flavour of the PDF document stream and provide an appropriate parser.

Parameters:

pdfStream - InputStream for the PDF document to be parsed.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createParser

PDFAParser createParser(InputStream pdfStream,
                        PDFAFlavour flavour)
                 throws ModelParsingException,
                        EncryptedPdfException

Method that returns a PDFParser instance, parsing the passed pdfStream parameter. The caller must explicitly state the flavour of the PDF document stream.

Parameters:

pdfStream - InputStream for the PDF document to be parsed.

flavour - a PDFAFlavour instance indicating parser configuration (PDF/A part and conformance level) to be assumed when parsing the document.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createParser

PDFAParser createParser(File pdfFile,
                        PDFAFlavour flavour)
                 throws ModelParsingException,
                        EncryptedPdfException

Method that returns a PDFParser instance, parsing file passed as pdfFile parameter. The caller must explicitly state the flavour of the PDF document stream.

Parameters:

pdfFile - File with PDF document to be parsed.

flavour - a PDFAFlavour instance indicating parser configuration (PDF/A part and conformance level) to be assumed when parsing the document.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createParser

PDFAParser createParser(File pdfFile)
                 throws ModelParsingException,
                        EncryptedPdfException

Method that returns a PDFParser instance, parsing file passed as pdfStream parameter. The parser or parser provider will detect the flavour of the PDF document stream and provide an appropriate parser.

Parameters:

pdfFile - File with the PDF document to be parsed.

Returns:

a PDFAParser instance created from the supplied InputStream.

Throws:

ModelParsingException - when there's a problem parsing the PDF file

EncryptedPdfException - if the PDF to be parsed is encrypted

createValidator

PDFAValidator createValidator(ValidatorConfig config)

Obtain a new PDFAValidator instance.

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

Returns:

an appropriately configured PDFAValidator instance.

createValidator

PDFAValidator createValidator(ValidatorConfig config,
                              ValidationProfile profile)

Obtain a new PDFAValidator instance that uses a custom ValidationProfile instance.

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

profile -

Returns:

an appropriately configured PDFAValidator instance.

createValidator

PDFAValidator createValidator(ValidatorConfig config,
                              PDFAFlavour flavour)

Obtain a new PDFAValidator instance that uses a custom PDFAFlavour.

Parameters:

config - a ValidatorConfig instance used to configure the PDFAValidator

flavour - the particular PDFAFlavour to validated against.

Returns:

an appropriately configured PDFAValidator instance.

createValidator

PDFAValidator createValidator(PDFAFlavour flavour,
                              boolean logSuccess)

Creates a new PDFAValidator instance that uses one of the ValidationProfiles packaged as a core library resource. While these profiles are not guaranteed to be up to date, they are available when offline. A ProfileDirectory populated with the pre-loaded profiles can be obtained by calling Profiles#getVeraProfileDirectory().

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

Returns:

a PDFAValidator instance initialised from the passed parameters

createValidator

PDFAValidator createValidator(ValidationProfile profile,
                              boolean logSuccess)

Creates a new PDFAValidator initialised with the passed profile and chosen passed test logging.

Parameters:

profile - the ValidationProfile to be enforced by the returned PDFAValidator.

logSuccess - boolean used to configure logging of passed tests by the PDFAValidator. Pass true to log passed tests, false to only log tests that don't pass.

Returns:

a PDFAValidator instance initialised from the passed parameters

createFailFastValidator

PDFAValidator createFailFastValidator(PDFAFlavour flavour,
                                      int maxFailures)

Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.

Parameters:

flavour - the PDFAFlavour that's associated with the ValidationProfile to used to initialise the PDFAValidator.

maxFailures - an int value that configures the PDFAValidator to abort validation after maxFailures failed tests. If maxFailures is less than 1 then the PDFAValidator will complete the full validation process.

Returns:

a PDFAValidator instance initialised from the passed parameters

createFailFastValidator

PDFAValidator createFailFastValidator(ValidationProfile profile,
                                      int maxFailures)

Creates a new PDFAValidator initialised with the passed profile, requested fast failing behaviour and configured NOT to log passed checks.

Parameters:

profile - the ValidationProfile to be enforced by the returned PDFAValidator.

maxFailures - an int value that configures the PDFAValidator to abort validation after maxFailures failed tests. If maxFailures is less than 1 then the PDFAValidator will complete the full validation process.

Returns:

a PDFAValidator instance initialised from the passed parameters

createMetadataFixer

MetadataFixer createMetadataFixer()

Obtain a new MetadataFixer instance.

Returns:

a MetadataFixer instance.

defaultFlavour

PDFAFlavour defaultFlavour()

Returns:

the default PDFAFlavour set for this VeraPDFFoundry

getParserId

String getParserId()

Returns:

parser id