org.verapdf.metadata.fixer.impl.pb.model

Class PDFDocumentImpl

java.lang.Object

org.verapdf.metadata.fixer.impl.pb.model.PDFDocumentImpl

All Implemented Interfaces:

PDFDocument

public class PDFDocumentImpl
extends Object
implements PDFDocument

Author:

Evgeniy Muravitskiy

Constructor Summary

Constructors

Constructor and Description
PDFDocumentImpl(InputStream pdfStream) Create a new PDFDocumentImpl from the passed InputStream
PDFDocumentImpl(PDDocument document)

Method Summary

Modifier and Type	Method and Description
InfoDictionary	getInfoDictionary() Return pdf document information dictionary representation.
Metadata	getMetadata() Return pdf document metadata representation.
boolean	isNeedToBeUpdated() Implemented by Apache PDFBox library.
int	removeFiltersForAllMetadataObjects() Removes filters for all metadata streams in document
MetadataFixerResult	saveDocumentIncremental(MetadataFixerResult.RepairStatus status, OutputStream output) Incremental save of pdf document.

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFDocumentImpl

public PDFDocumentImpl(InputStream pdfStream)
                throws IOException

Create a new PDFDocumentImpl from the passed InputStream

Parameters:

pdfStream - an InputStream to be parsed as a PDF Document.

Throws:

IOException - when there's a problem reading or parsing the file.

PDFDocumentImpl

public PDFDocumentImpl(PDDocument document)

Parameters:

document -

Method Detail

getMetadata

public Metadata getMetadata()

Return pdf document metadata representation. Must return null if and only if handler having problems with metadata obtain (exceptions, for example). If metadata is not present in the document ('Metadata' key in catalog not present or empty) it`s must be added. Implemented by Apache PDFBox library.

Specified by:

getMetadata in interface PDFDocument

Returns:

metadata representation or null

See Also:

Metadata

getInfoDictionary

public InfoDictionary getInfoDictionary()

Return pdf document information dictionary representation. Must be not null (empty, for example). Implemented by Apache PDFBox library.

Specified by:

getInfoDictionary in interface PDFDocument

Returns:

information dictionary representation

See Also:

InfoDictionary

isNeedToBeUpdated

public boolean isNeedToBeUpdated()

Implemented by Apache PDFBox library.

Specified by:

isNeedToBeUpdated in interface PDFDocument

Returns:

saveDocumentIncremental

public MetadataFixerResult saveDocumentIncremental(MetadataFixerResult.RepairStatus status,
                                                   OutputStream output)

Incremental save of pdf document. Document must be saved if and only if metadata or information dictionary of document was changed. In MetadataFixerResultImpl must set 1 of 3 states:

• MetadataFixerResult.RepairStatus.FIX_ERROR if got problems with document save
• MetadataFixerResult.RepairStatus.NO_ACTION if metadata and information dictionary was not changed
• MetadataFixerResult.RepairStatus.SUCCESS if document save successful

Implemented by Apache PDFBox library.

Specified by:

saveDocumentIncremental in interface PDFDocument

output - output stream for document save

Returns:

removeFiltersForAllMetadataObjects

public int removeFiltersForAllMetadataObjects()

Description copied from interface: PDFDocument

Removes filters for all metadata streams in document

Specified by:

removeFiltersForAllMetadataObjects in interface PDFDocument

Returns:

number of unfiltered streams