com.itextpdf.pdfa

Class PdfADocument

java.lang.Object

com.itextpdf.kernel.pdf.PdfDocument

com.itextpdf.pdfa.PdfADocument

All Implemented Interfaces:

IEventDispatcher, Closeable, AutoCloseable

Direct Known Subclasses:

PdfAAgnosticPdfDocument

public class PdfADocument
extends PdfDocument

This class extends PdfDocument and is in charge of creating files that comply with the PDF/A standard. Client code is still responsible for making sure the file is actually PDF/A compliant: multiple steps must be undertaken (depending on the PdfAConformanceLevel) to ensure that the PDF/A standard is followed. This class will throw exceptions, mostly PdfAConformanceException, and thus refuse to output a PDF/A file if at any point the document does not adhere to the PDF/A guidelines specified by the PdfAConformanceLevel.

Field Summary

Fields

Modifier and Type	Field and Description
protected PdfAChecker	checker

Fields inherited from class com.itextpdf.kernel.pdf.PdfDocument

catalog, closed, closeReader, closeWriter, eventDispatcher, fingerPrint, flushUnusedObjects, info, isClosing, pdfVersion, properties, reader, serializeOptions, structParentIndex, structTreeRoot, tagStructureContext, trailer, writer, xmpMetadata

Constructor Summary

Constructors

Constructor and Description
PdfADocument(PdfReader reader, PdfWriter writer) Opens a PDF/A document in the stamping mode.
PdfADocument(PdfReader reader, PdfWriter writer, StampingProperties properties) Opens a PDF/A document in stamping mode.
PdfADocument(PdfWriter writer, PdfAConformanceLevel conformanceLevel, PdfOutputIntent outputIntent) Constructs a new PdfADocument for writing purposes, i.e.
PdfADocument(PdfWriter writer, PdfAConformanceLevel conformanceLevel, PdfOutputIntent outputIntent, DocumentProperties properties) Constructs a new PdfADocument for writing purposes, i.e.

Method Summary

Modifier and Type	Method and Description
protected void	addCustomMetadataExtensions(XMPMeta xmpMeta) Adds custom XMP metadata extension.
protected void	checkIsoConformance() Checks whether PDF document conforms a specific standard.
void	checkIsoConformance(Object obj, IsoKey key) Checks whether PDF document conforms a specific standard.
void	checkIsoConformance(Object obj, IsoKey key, PdfResources resources, PdfStream contentStream) Checks whether PDF document conforms a specific standard.
protected void	flushFonts() Flushes all newly added or loaded fonts.
protected void	flushObject(PdfObject pdfObject, boolean canBeInObjStm) Flush an object.
PdfAConformanceLevel	getConformanceLevel() Gets the PdfAConformanceLevel set in the constructor or in the metadata of the PdfReader.
protected IPdfPageFactory	getPageFactory() Returns the factory for creating page instances.
protected void	initTagStructureContext() Initializes tagStructureContext to track necessary information of document's tag structure.
protected void	setChecker(PdfAConformanceLevel conformanceLevel) Sets the checker that defines the requirements of the PDF/A standard depending on conformance level.
protected void	updateXmpMetadata() Updates XMP metadata.

Methods inherited from class com.itextpdf.kernel.pdf.PdfDocument

addAssociatedFile, addEventHandler, addFileAttachment, addFont, addNamedDestination, addNewPage, addNewPage, addNewPage, addNewPage, addOutputIntent, addPage, addPage, checkAndAddPage, checkAndAddPage, checkClosingStatus, checkShowTextIsoConformance, close, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, copyPagesTo, createNextIndirectReference, dispatchEvent, dispatchEvent, findFont, flushCopiedObjects, getAssociatedFiles, getCatalog, getDefaultFont, getDefaultPageSize, getDocumentFonts, getDocumentId, getDocumentIdWrapper, getDocumentInfo, getEncryptedPayloadDocument, getFingerPrint, getFirstPage, getFont, getLastPage, getModifiedDocumentId, getNextStructParentIndex, getNumberOfPages, getNumberOfPdfObjects, getOriginalDocumentId, getOutlines, getPage, getPage, getPageLabels, getPageNumber, getPageNumber, getPdfObject, getPdfVersion, getReader, getSerializeOptions, getStructTreeRoot, getTagStructureContext, getTrailer, getWriter, getXmpMetadata, getXmpMetadata, hasEventHandler, hasOutlines, initializeOutlines, isAppendMode, isClosed, isCloseReader, isCloseWriter, isFlushUnusedObjects, isTagged, listIndirectReferences, markObjectAsMustBeFlushed, markStreamAsEmbeddedFile, movePage, movePage, open, registerProduct, removeAllHandlers, removeEventHandler, removePage, removePage, setCloseReader, setCloseWriter, setDefaultPageSize, setEncryptedPayload, setFlushUnusedObjects, setSerializeOptions, setTagged, setUserProperties, setXmpMetadata, setXmpMetadata, setXmpMetadata, storeDestinationToReaddress, storeLinkAnnotation, tryInitTagStructure, updateDefaultXmpMetadata

Methods inherited from class java.lang.Object

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

Field Detail

checker

protected PdfAChecker checker

Constructor Detail

PdfADocument

public PdfADocument(PdfWriter writer,
                    PdfAConformanceLevel conformanceLevel,
                    PdfOutputIntent outputIntent)

Constructs a new PdfADocument for writing purposes, i.e. from scratch. A PDF/A file has a conformance level, and must have an explicit output intent.

Parameters:

writer - the PdfWriter object to write to

conformanceLevel - the generation and strictness level of the PDF/A that must be followed.

outputIntent - a PdfOutputIntent

PdfADocument

public PdfADocument(PdfWriter writer,
                    PdfAConformanceLevel conformanceLevel,
                    PdfOutputIntent outputIntent,
                    DocumentProperties properties)

Constructs a new PdfADocument for writing purposes, i.e. from scratch. A PDF/A file has a conformance level, and must have an explicit output intent.

Parameters:

writer - the PdfWriter object to write to

conformanceLevel - the generation and strictness level of the PDF/A that must be followed.

outputIntent - a PdfOutputIntent

properties - a DocumentProperties

PdfADocument

public PdfADocument(PdfReader reader,
                    PdfWriter writer)

Opens a PDF/A document in the stamping mode.

Parameters:

reader - PDF reader.

writer - PDF writer.

PdfADocument

public PdfADocument(PdfReader reader,
                    PdfWriter writer,
                    StampingProperties properties)

Opens a PDF/A document in stamping mode.

Parameters:

reader - PDF reader.

writer - PDF writer.

properties - properties of the stamping process

Method Detail

checkIsoConformance

public void checkIsoConformance(Object obj,
                                IsoKey key)

Description copied from class: PdfDocument

Checks whether PDF document conforms a specific standard. Shall be override.

Overrides:

checkIsoConformance in class PdfDocument

Parameters:

obj - An object to conform.

key - type of object to conform.

checkIsoConformance

public void checkIsoConformance(Object obj,
                                IsoKey key,
                                PdfResources resources,
                                PdfStream contentStream)

Description copied from class: PdfDocument

Checks whether PDF document conforms a specific standard. Shall be override.

Overrides:

checkIsoConformance in class PdfDocument

Parameters:

obj - an object to conform.

key - type of object to conform.

resources - PdfResources associated with an object to check.

contentStream - current content stream

getConformanceLevel

public PdfAConformanceLevel getConformanceLevel()

Gets the PdfAConformanceLevel set in the constructor or in the metadata of the PdfReader.

Returns:

a PdfAConformanceLevel

addCustomMetadataExtensions

protected void addCustomMetadataExtensions(XMPMeta xmpMeta)

Description copied from class: PdfDocument

Adds custom XMP metadata extension. Useful for PDF/UA, ZUGFeRD, etc.

Overrides:

addCustomMetadataExtensions in class PdfDocument

Parameters:

xmpMeta - XMPMeta to add custom metadata to.

updateXmpMetadata

protected void updateXmpMetadata()

Description copied from class: PdfDocument

Updates XMP metadata. Shall be override.

Overrides:

updateXmpMetadata in class PdfDocument

checkIsoConformance

protected void checkIsoConformance()

Description copied from class: PdfDocument

Checks whether PDF document conforms a specific standard. Shall be override.

Overrides:

checkIsoConformance in class PdfDocument

flushObject

protected void flushObject(PdfObject pdfObject,
                           boolean canBeInObjStm)
                    throws IOException

Description copied from class: PdfDocument

Flush an object.

Overrides:

flushObject in class PdfDocument

Parameters:

pdfObject - object to flush.

canBeInObjStm - indicates whether object can be placed into object stream.

Throws:

IOException - on error.

flushFonts

protected void flushFonts()

Description copied from class: PdfDocument

Flushes all newly added or loaded fonts.

Overrides:

flushFonts in class PdfDocument

setChecker

protected void setChecker(PdfAConformanceLevel conformanceLevel)

Sets the checker that defines the requirements of the PDF/A standard depending on conformance level.

Parameters:

conformanceLevel - PdfAConformanceLevel

initTagStructureContext

protected void initTagStructureContext()

Initializes tagStructureContext to track necessary information of document's tag structure.

Overrides:

initTagStructureContext in class PdfDocument

getPageFactory

protected IPdfPageFactory getPageFactory()

Description copied from class: PdfDocument

Returns the factory for creating page instances.

Overrides:

getPageFactory in class PdfDocument

Returns:

implementation of IPdfPageFactory for current document