Package org.apache.pdfbox.multipdf
Class PDFMergerUtility
- java.lang.Object
-
- org.apache.pdfbox.multipdf.PDFMergerUtility
-
public class PDFMergerUtility extends java.lang.Object
This class will take a list of pdf documents and merge them, saving the result in a new document.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PDFMergerUtility.AcroFormMergeMode
The mode to use when merging AcroForm between documents:PDFMergerUtility.AcroFormMergeMode.JOIN_FORM_FIELDS_MODE
fields with the same fully qualified name will be merged into one with the widget annotations of the merged fields becoming part of the same field.
Although the API is finalized processing of different form field types is still in development. Currently only (nested) text fields do work with intermediate nodes being existent.static class
PDFMergerUtility.DocumentMergeMode
The mode to use when merging documents:PDFMergerUtility.DocumentMergeMode.OPTIMIZE_RESOURCES_MODE
Optimizes resource handling such as closing documents early.
-
Field Summary
Fields Modifier and Type Field Description private PDFMergerUtility.AcroFormMergeMode
acroFormMergeMode
private PDDocumentInformation
destinationDocumentInformation
private java.lang.String
destinationFileName
private PDMetadata
destinationMetadata
private java.io.OutputStream
destinationStream
private PDFMergerUtility.DocumentMergeMode
documentMergeMode
private boolean
ignoreAcroFormErrors
private static org.apache.commons.logging.Log
LOG
Log instance.private int
nextFieldNum
private java.util.List<java.lang.Object>
sources
-
Constructor Summary
Constructors Constructor Description PDFMergerUtility()
Instantiate a new PDFMergerUtility.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description private void
acroFormJoinFieldsMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm)
private void
acroFormLegacyMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm)
void
addSource(java.io.File source)
Add a source file to the list of files to merge.void
addSource(java.io.InputStream source)
Add a source to the list of documents to merge.void
addSource(java.lang.String source)
Add a source file to the list of files to merge.void
addSources(java.util.List<java.io.InputStream> sourcesList)
Add a list of sources to the list of documents to merge.void
appendDocument(PDDocument destination, PDDocument source)
append all pages from source to destination.private void
cleanupFieldCOSDictionary(COSDictionary fieldCos)
private void
cleanupWidgetCOSDictionary(COSDictionary widgetCos, boolean removeDAEntry)
PDFMergerUtility.AcroFormMergeMode
getAcroFormMergeMode()
Get the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
PDDocumentInformation
getDestinationDocumentInformation()
Get the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.java.lang.String
getDestinationFileName()
Get the name of the destination file.PDMetadata
getDestinationMetadata()
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.java.io.OutputStream
getDestinationStream()
Get the destination OutputStream.PDFMergerUtility.DocumentMergeMode
getDocumentMergeMode()
Get the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
(package private) static java.util.Map<java.lang.String,PDStructureElement>
getIDTreeAsMap(PDNameTreeNode<PDStructureElement> idTree)
(package private) static java.util.Map<java.lang.Integer,COSObjectable>
getNumberTreeAsMap(PDNumberTreeNode tree)
private boolean
isDynamicXfa(PDAcroForm acroForm)
Test for dynamic XFA content.boolean
isIgnoreAcroFormErrors()
Indicates if acroform errors are ignored or not.private void
legacyMergeDocuments(MemoryUsageSetting memUsageSetting)
Merge the list of source documents, saving the result in the destination file.private void
mergeAcroForm(PDFCloneUtility cloner, PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
Merge the contents of the source form into the destination form for the destination file.void
mergeDocuments()
Deprecated.void
mergeDocuments(MemoryUsageSetting memUsageSetting)
Merge the list of source documents, saving the result in the destination file.private void
mergeFields(PDFCloneUtility cloner, PDField destField, PDField srcField)
private void
mergeIDTree(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)
private void
mergeInto(COSDictionary src, COSDictionary dst, java.util.Set<COSName> exclude)
This will add all of the dictionaries keys/values to this dictionary, but only if they are not in an exclusion list and if they don't already exist.private void
mergeKEntries(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)
private void
mergeLanguage(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
private void
mergeMarkInfo(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
private void
mergeOutputIntents(PDFCloneUtility cloner, PDDocumentCatalog srcCatalog, PDDocumentCatalog destCatalog)
private void
mergeRoleMap(PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)
private void
mergeViewerPreferences(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
private void
optimizedMergeDocuments(MemoryUsageSetting memUsageSetting)
void
setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode theAcroFormMergeMode)
Set the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
void
setDestinationDocumentInformation(PDDocumentInformation info)
Set the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.void
setDestinationFileName(java.lang.String destination)
Set the name of the destination file.void
setDestinationMetadata(PDMetadata meta)
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
.void
setDestinationStream(java.io.OutputStream destStream)
Set the destination OutputStream.void
setDocumentMergeMode(PDFMergerUtility.DocumentMergeMode theDocumentMergeMode)
Set the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
void
setIgnoreAcroFormErrors(boolean ignoreAcroFormErrorsValue)
Set to true to ignore acroform errors.private void
updatePageReferences(PDFCloneUtility cloner, java.util.Map<java.lang.Integer,COSObjectable> numberTreeAsMap, java.util.Map<COSDictionary,COSDictionary> objMapping)
Update the Pg and Obj references to the new (merged) page.private void
updatePageReferences(PDFCloneUtility cloner, COSArray parentTreeEntry, java.util.Map<COSDictionary,COSDictionary> objMapping)
private void
updatePageReferences(PDFCloneUtility cloner, COSDictionary parentTreeEntry, java.util.Map<COSDictionary,COSDictionary> objMapping)
Update the Pg and Obj references to the new (merged) page.private void
updateParentEntry(COSArray kArray, COSDictionary newParent)
Update the P reference to the new parent dictionary.private void
updateStructParentEntries(PDPage page, int structParentOffset)
Update the StructParents and StructParent values in a PDPage.
-
-
-
Field Detail
-
LOG
private static final org.apache.commons.logging.Log LOG
Log instance.
-
sources
private final java.util.List<java.lang.Object> sources
-
destinationFileName
private java.lang.String destinationFileName
-
destinationStream
private java.io.OutputStream destinationStream
-
ignoreAcroFormErrors
private boolean ignoreAcroFormErrors
-
destinationDocumentInformation
private PDDocumentInformation destinationDocumentInformation
-
destinationMetadata
private PDMetadata destinationMetadata
-
documentMergeMode
private PDFMergerUtility.DocumentMergeMode documentMergeMode
-
acroFormMergeMode
private PDFMergerUtility.AcroFormMergeMode acroFormMergeMode
-
nextFieldNum
private int nextFieldNum
-
-
Method Detail
-
getAcroFormMergeMode
public PDFMergerUtility.AcroFormMergeMode getAcroFormMergeMode()
Get the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
-
setAcroFormMergeMode
public void setAcroFormMergeMode(PDFMergerUtility.AcroFormMergeMode theAcroFormMergeMode)
Set the merge mode to be used for merging AcroForms between documentsPDFMergerUtility.AcroFormMergeMode
-
setDocumentMergeMode
public void setDocumentMergeMode(PDFMergerUtility.DocumentMergeMode theDocumentMergeMode)
Set the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
-
getDocumentMergeMode
public PDFMergerUtility.DocumentMergeMode getDocumentMergeMode()
Get the merge mode to be used for merging documentsPDFMergerUtility.DocumentMergeMode
-
getDestinationFileName
public java.lang.String getDestinationFileName()
Get the name of the destination file.- Returns:
- Returns the destination.
-
setDestinationFileName
public void setDestinationFileName(java.lang.String destination)
Set the name of the destination file.- Parameters:
destination
- The destination to set.
-
getDestinationStream
public java.io.OutputStream getDestinationStream()
Get the destination OutputStream.- Returns:
- Returns the destination OutputStream.
-
setDestinationStream
public void setDestinationStream(java.io.OutputStream destStream)
Set the destination OutputStream.- Parameters:
destStream
- The destination to set.
-
getDestinationDocumentInformation
public PDDocumentInformation getDestinationDocumentInformation()
Get the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Returns:
- The destination document information.
-
setDestinationDocumentInformation
public void setDestinationDocumentInformation(PDDocumentInformation info)
Set the destination document information that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Parameters:
info
- The destination document information.
-
getDestinationMetadata
public PDMetadata getDestinationMetadata()
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Returns:
- The destination metadata.
-
setDestinationMetadata
public void setDestinationMetadata(PDMetadata meta)
Set the destination metadata that is to be set inmergeDocuments(org.apache.pdfbox.io.MemoryUsageSetting)
. The default is null, which means that it is ignored.- Parameters:
meta
- The destination metadata.
-
addSource
public void addSource(java.lang.String source) throws java.io.FileNotFoundException
Add a source file to the list of files to merge.- Parameters:
source
- Full path and file name of source document.- Throws:
java.io.FileNotFoundException
- If the file doesn't exist
-
addSource
public void addSource(java.io.File source) throws java.io.FileNotFoundException
Add a source file to the list of files to merge.- Parameters:
source
- File representing source document- Throws:
java.io.FileNotFoundException
- If the file doesn't exist
-
addSource
public void addSource(java.io.InputStream source)
Add a source to the list of documents to merge.- Parameters:
source
- InputStream representing source document
-
addSources
public void addSources(java.util.List<java.io.InputStream> sourcesList)
Add a list of sources to the list of documents to merge.- Parameters:
sourcesList
- List of InputStream objects representing source documents
-
mergeDocuments
@Deprecated public void mergeDocuments() throws java.io.IOException
Deprecated.Merge the list of source documents, saving the result in the destination file.- Throws:
java.io.IOException
- If there is an error saving the document.
-
mergeDocuments
public void mergeDocuments(MemoryUsageSetting memUsageSetting) throws java.io.IOException
Merge the list of source documents, saving the result in the destination file.- Parameters:
memUsageSetting
- defines how memory is used for buffering PDF streams; in case ofnull
unrestricted main memory is used- Throws:
java.io.IOException
- If there is an error saving the document.
-
optimizedMergeDocuments
private void optimizedMergeDocuments(MemoryUsageSetting memUsageSetting) throws java.io.IOException
- Throws:
java.io.IOException
-
legacyMergeDocuments
private void legacyMergeDocuments(MemoryUsageSetting memUsageSetting) throws java.io.IOException
Merge the list of source documents, saving the result in the destination file.- Parameters:
memUsageSetting
- defines how memory is used for buffering PDF streams; in case ofnull
unrestricted main memory is used- Throws:
java.io.IOException
- If there is an error saving the document.
-
appendDocument
public void appendDocument(PDDocument destination, PDDocument source) throws java.io.IOException
append all pages from source to destination.- Parameters:
destination
- the document to receive the pagessource
- the document originating the new pages- Throws:
java.io.IOException
- If there is an error accessing data from either document.
-
mergeViewerPreferences
private void mergeViewerPreferences(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
-
mergeLanguage
private void mergeLanguage(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
-
mergeMarkInfo
private void mergeMarkInfo(PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog)
-
mergeKEntries
private void mergeKEntries(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree) throws java.io.IOException
- Throws:
java.io.IOException
-
mergeIDTree
private void mergeIDTree(PDFCloneUtility cloner, PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree) throws java.io.IOException
- Throws:
java.io.IOException
-
getIDTreeAsMap
static java.util.Map<java.lang.String,PDStructureElement> getIDTreeAsMap(PDNameTreeNode<PDStructureElement> idTree) throws java.io.IOException
- Throws:
java.io.IOException
-
getNumberTreeAsMap
static java.util.Map<java.lang.Integer,COSObjectable> getNumberTreeAsMap(PDNumberTreeNode tree) throws java.io.IOException
- Throws:
java.io.IOException
-
mergeRoleMap
private void mergeRoleMap(PDStructureTreeRoot srcStructTree, PDStructureTreeRoot destStructTree)
-
mergeOutputIntents
private void mergeOutputIntents(PDFCloneUtility cloner, PDDocumentCatalog srcCatalog, PDDocumentCatalog destCatalog) throws java.io.IOException
- Throws:
java.io.IOException
-
mergeAcroForm
private void mergeAcroForm(PDFCloneUtility cloner, PDDocumentCatalog destCatalog, PDDocumentCatalog srcCatalog) throws java.io.IOException
Merge the contents of the source form into the destination form for the destination file.- Parameters:
cloner
- the object cloner for the destination documentdestAcroForm
- the destination formsrcAcroForm
- the source form- Throws:
java.io.IOException
- If an error occurs while adding the field.
-
acroFormJoinFieldsMode
private void acroFormJoinFieldsMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm) throws java.io.IOException
- Throws:
java.io.IOException
-
mergeFields
private void mergeFields(PDFCloneUtility cloner, PDField destField, PDField srcField)
-
cleanupFieldCOSDictionary
private void cleanupFieldCOSDictionary(COSDictionary fieldCos)
-
cleanupWidgetCOSDictionary
private void cleanupWidgetCOSDictionary(COSDictionary widgetCos, boolean removeDAEntry)
-
acroFormLegacyMode
private void acroFormLegacyMode(PDFCloneUtility cloner, PDAcroForm destAcroForm, PDAcroForm srcAcroForm) throws java.io.IOException
- Throws:
java.io.IOException
-
isIgnoreAcroFormErrors
public boolean isIgnoreAcroFormErrors()
Indicates if acroform errors are ignored or not.- Returns:
- true if acroform errors are ignored
-
setIgnoreAcroFormErrors
public void setIgnoreAcroFormErrors(boolean ignoreAcroFormErrorsValue)
Set to true to ignore acroform errors.- Parameters:
ignoreAcroFormErrorsValue
- true if acroform errors should be ignored
-
updatePageReferences
private void updatePageReferences(PDFCloneUtility cloner, java.util.Map<java.lang.Integer,COSObjectable> numberTreeAsMap, java.util.Map<COSDictionary,COSDictionary> objMapping) throws java.io.IOException
Update the Pg and Obj references to the new (merged) page.- Throws:
java.io.IOException
-
updatePageReferences
private void updatePageReferences(PDFCloneUtility cloner, COSDictionary parentTreeEntry, java.util.Map<COSDictionary,COSDictionary> objMapping) throws java.io.IOException
Update the Pg and Obj references to the new (merged) page.- Parameters:
parentTreeEntry
-objMapping
- mapping between old and new references- Throws:
java.io.IOException
-
updatePageReferences
private void updatePageReferences(PDFCloneUtility cloner, COSArray parentTreeEntry, java.util.Map<COSDictionary,COSDictionary> objMapping) throws java.io.IOException
- Throws:
java.io.IOException
-
updateParentEntry
private void updateParentEntry(COSArray kArray, COSDictionary newParent)
Update the P reference to the new parent dictionary.- Parameters:
kArray
- the kids arraynewParent
- the new parent
-
updateStructParentEntries
private void updateStructParentEntries(PDPage page, int structParentOffset) throws java.io.IOException
Update the StructParents and StructParent values in a PDPage.- Parameters:
page
- the new pagestructParentOffset
- the offset which should be applied- Throws:
java.io.IOException
-
isDynamicXfa
private boolean isDynamicXfa(PDAcroForm acroForm)
Test for dynamic XFA content.- Parameters:
acroForm
- the AcroForm- Returns:
- true if there is a dynamic XFA form.
-
mergeInto
private void mergeInto(COSDictionary src, COSDictionary dst, java.util.Set<COSName> exclude)
This will add all of the dictionaries keys/values to this dictionary, but only if they are not in an exclusion list and if they don't already exist. If a key already exists in this dictionary then nothing is changed.- Parameters:
src
- The source dictionary to get the keys/values from.dst
- The destination dictionary to merge the keys/values into.exclude
- Names of keys that shall be skipped.
-
-