JawsMako::IPDFValidator Class Reference

A class for validating PDF documents against published PDF standards such as PDF/X. More...

#include <validate.h>

Inheritance diagram for JawsMako::IPDFValidator:

Classes
class	CContentError
	A class describing validation errors present in a particular location on a page. More...
class	CGeneralError
	A class describing validation errors found in a PDF that are not tied to a location on a page. More...
class	CPageErrors
	A collection of all the errors associated with a page. More...

Public Types
enum	ePDFValidateVersion
	Supported validation standards.

Public Member Functions
virtual bool	validate (const IInputStreamPtr &pdfStream, CGeneralErrorVect &globalErrors, CPageErrorsVect &pageErrors)=0
	Perform validation on an entire PDF stream.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static JAWSMAKO_API IPDFValidatorPtr	create (const IJawsMakoPtr &jawsMako, ePDFValidateVersion version)
	Create an IPDFValidator instance that validates against the given version.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

A class for validating PDF documents against published PDF standards such as PDF/X.

Member Function Documentation

validate()

virtual bool JawsMako::IPDFValidator::validate ( const IInputStreamPtr & pdfStream, CGeneralErrorVect & globalErrors, CPageErrorsVect & pageErrors )

pure virtual

Perform validation on an entire PDF stream.

    Please note that currently not all errors are caught by this validator.
    In particular the following will not trigger failure:
    - Common errors in PDF content that are worked around by Mako due to
      their prevalence in the field.
    - Issues with Halftone dictionaries.
    - Correctness of OPI information, including embedded files (PDF/X-1-2001 only)
    - Correctness of XMP Metadata information
    - Whether or not an output intent exists in a standard registry.
    - Internal ICC profile structure.
    - Default Transfer functions (TR/TR2) in some rare situations.
    - Correctness of TrapNet annotations.
    - Contents of embedded files (however embedded files are prohibited in most PDF
      standards).
    - Actions in outlines that simply reference a destination (GoTo).
    - With the exception of transparency, features that are not present in the target
      version of the PDF specification are not flagged as errors.

Parameters

pdfStream	The PDF stream.
globalErrors	A reference to receive the list of global errors (that is, errors not attached to a particular page).
pageErrors	A reference to receive the list of page errors (that is, errors attributable to a given page). The page errors will be a vector where the vector entry 0 is for the first page and so forth.

Returns

bool True if no errors were found, false otherwise.

---

The documentation for this class was generated from the following file:

• validate.h