public class DXExporterFromA3 extends ZUGFeRDExporterFromA3
| Modifier and Type | Field and Description |
|---|---|
protected java.lang.String |
author
Deprecated.
author is never set yet
|
protected PDFAConformanceLevel |
conformanceLevel |
protected java.lang.String |
creator
Author/Creator attribute for PDF
|
protected java.lang.String |
creatorTool
CreatorTool
|
protected java.lang.String |
despatchAdviceDocumentType
OrderX document type.
|
protected java.util.ArrayList<FileAttachment> |
fileAttachments |
protected org.apache.pdfbox.pdmodel.common.PDMetadata |
metadata
Data (XML invoice) to be added to the ZUGFeRD PDF.
|
protected boolean |
overwrite
This flag controls whether or not the metadata is overwritten, or kind of merged.
|
protected java.lang.String |
producer
Producer attribute for PDF
|
protected java.lang.String |
subject
Deprecated.
subject is never set yet
|
protected java.lang.String |
title
Deprecated.
title is never set yet
|
DefaultZUGFeRDVersion, doc, xmp, XRechnungVersion, ZFVersion| Constructor and Description |
|---|
DXExporterFromA3() |
| Modifier and Type | Method and Description |
|---|---|
DXExporterFromA3 |
addAdditionalFile(java.lang.String name,
byte[] content) |
protected void |
addSRGBOutputIntend()
Adds an OutputIntent and the sRGB color profile if no OutputIntent exist
|
protected void |
addStructureTreeRoot()
Adds a StructureTreeRoot element to the PDF if it doesn't already exist.
|
protected void |
addXMP(org.apache.xmpbox.XMPMetadata metadata)
This will add both the RDF-indication which embedded file is Zugferd and the
neccessary PDF/A schema extension description to be able to add this
information to RDF
|
void |
attachFile(FileAttachment file) |
void |
attachFile(java.lang.String filename,
byte[] data,
java.lang.String mimetype,
java.lang.String relation) |
void |
close() |
DXExporterFromA3 |
disableAutoClose(boolean disableAutoClose) |
boolean |
ensurePDFIsValid(javax.activation.DataSource dataSource) |
void |
export(java.io.OutputStream output)
Perform the final export to a now ZUGFeRD-enriched PDF file as OutputStream
|
void |
export(java.lang.String ZUGFeRDfilename)
Perform the final export to a now ZUGFeRD-enriched PDF file
|
protected org.apache.xmpbox.schema.AdobePDFSchema |
getAdobePDFSchema(org.apache.xmpbox.XMPMetadata xmp)
Returns the AdobePDFSchema from the XMPMetadata if it exists.
|
protected org.apache.xmpbox.schema.DublinCoreSchema |
getDublinCoreSchema(org.apache.xmpbox.XMPMetadata xmp) |
protected org.apache.xmpbox.schema.PDFAIdentificationSchema |
getPDFAIdentificationSchema(org.apache.xmpbox.XMPMetadata xmp) |
IXMLProvider |
getProvider() |
protected org.apache.xmpbox.schema.XMPBasicSchema |
getXmpBasicSchema(org.apache.xmpbox.XMPMetadata xmp) |
protected org.apache.xmpbox.XMPMetadata |
getXmpMetadata()
Reads the XMPMetadata from the PDDocument, if it exists.
|
boolean |
isAutoCloseDisabled() |
DXExporterFromA3 |
load(byte[] pdfBinary)
Makes A PDF/A3a-compliant document from a PDF-A1 compliant document (on the
metadata level, this will not e.g. convert graphics to JPG-2000)
|
DXExporterFromA3 |
load(java.io.InputStream pdfSource)
Makes A PDF/A3a-compliant document from a PDF-A1 compliant document (on the
metadata level, this will not e.g. convert graphics to JPG-2000)
|
DXExporterFromA3 |
load(java.lang.String pdfFilename)
Makes A PDF/A3a-compliant document from a PDF-A1 compliant document (on the
metadata level, this will not e.g. convert graphics to JPG-2000)
|
void |
PDFAttachGenericFile(org.apache.pdfbox.pdmodel.PDDocument doc,
java.lang.String filename,
java.lang.String relationship,
java.lang.String description,
java.lang.String subType,
byte[] data)
Embeds an external file (generic - any type allowed) in the PDF.
|
void |
PDFAttachGenericFile(java.lang.String filename,
java.lang.String relationship,
java.lang.String description,
java.lang.String subType,
byte[] data)
Embeds an external file (generic - any type allowed) in the PDF.
|
IExporter |
prepare() |
protected byte[] |
serializeXmpMetadata(org.apache.xmpbox.XMPMetadata xmpMetadata) |
protected DXExporterFromA3 |
setAttachZUGFeRDHeaders(boolean attachHeaders) |
DXExporterFromA3 |
setConformanceLevel(PDFAConformanceLevel newLevel)
All files are PDF/A-3, setConformance refers to the level conformance.
|
DXExporterFromA3 |
setCreator(java.lang.String creator) |
DXExporterFromA3 |
setCreatorTool(java.lang.String creatorTool) |
DXExporterFromA3 |
setDocumentType(java.lang.String DocumentType)
Sets the property for DocumentType.
|
protected void |
setMarked()
Adds a MarkInfo element to the PDF if it doesn't already exist and sets it as marked.
|
DXExporterFromA3 |
setProducer(java.lang.String producer) |
DXExporterFromA3 |
setProfile(Profile p) |
DXExporterFromA3 |
setProfile(java.lang.String profilename) |
IExporter |
setTransaction(IExportableTransaction trans)
Embeds the Zugferd XML structure in a file named ZUGFeRD-invoice.xml.
|
DXExporterFromA3 |
setXML(byte[] zugferdData)
Sets the ZUGFeRD XML data to be attached as a single byte array.
|
protected void |
setXMLProvider(IXMLProvider p) |
DXExporterFromA3 |
setZUGFeRDVersion(int version) |
protected void |
writeAdobePDFSchema(org.apache.xmpbox.XMPMetadata xmp)
Sets the producer if the overwrite flag is set or the producer is not already set.
|
protected void |
writeDocumentInformation() |
protected void |
writeDublinCoreSchema(org.apache.xmpbox.XMPMetadata xmp) |
protected void |
writePDFAIdentificationSchema(org.apache.xmpbox.XMPMetadata xmp) |
protected void |
writeXMLBasicSchema(org.apache.xmpbox.XMPMetadata xmp) |
disableFacturX, getFilenameForVersion, getNamespaceForVersion, getPrefixForVersion, prepareDocument, setFacturX, setXRechnungSpecificVersion, setZUGFeRDVersionprotected PDFAConformanceLevel conformanceLevel
protected java.util.ArrayList<FileAttachment> fileAttachments
protected boolean overwrite
protected org.apache.pdfbox.pdmodel.common.PDMetadata metadata
protected java.lang.String producer
protected java.lang.String creator
protected java.lang.String creatorTool
@Deprecated protected java.lang.String author
@Deprecated protected java.lang.String title
@Deprecated protected java.lang.String subject
protected java.lang.String despatchAdviceDocumentType
public DXExporterFromA3 load(java.lang.String pdfFilename) throws java.io.IOException
load in interface IZUGFeRDExporterload in class ZUGFeRDExporterFromA3pdfFilename - filename of an PDF/A1 compliant documentjava.io.IOException - if anything is wrong with filenamepublic IXMLProvider getProvider()
getProvider in interface IZUGFeRDExportergetProvider in class ZUGFeRDExporterFromA3public DXExporterFromA3 setProfile(Profile p)
setProfile in class ZUGFeRDExporterFromA3public DXExporterFromA3 setProfile(java.lang.String profilename)
setProfile in class ZUGFeRDExporterFromA3public DXExporterFromA3 addAdditionalFile(java.lang.String name, byte[] content)
addAdditionalFile in class ZUGFeRDExporterFromA3public DXExporterFromA3 load(byte[] pdfBinary) throws java.io.IOException
load in interface IZUGFeRDExporterload in class ZUGFeRDExporterFromA3pdfBinary - binary of a PDF/A1 compliant documentjava.io.IOException - (should not happen at all)public void attachFile(FileAttachment file)
attachFile in class ZUGFeRDExporterFromA3public void attachFile(java.lang.String filename,
byte[] data,
java.lang.String mimetype,
java.lang.String relation)
attachFile in class ZUGFeRDExporterFromA3public void export(java.lang.String ZUGFeRDfilename)
throws java.io.IOException
export in interface IExporterexport in class ZUGFeRDExporterFromA3ZUGFeRDfilename - the pdf file namejava.io.IOException - if anything is wrong in the target locationpublic void close()
throws java.io.IOException
close in interface java.io.Closeableclose in interface java.lang.AutoCloseableclose in class ZUGFeRDExporterFromA3java.io.IOExceptionpublic void export(java.io.OutputStream output)
throws java.io.IOException
export in interface IExporterexport in class ZUGFeRDExporterFromA3output - the OutputStreamjava.io.IOException - if anything is wrong in the OutputStreampublic void PDFAttachGenericFile(java.lang.String filename,
java.lang.String relationship,
java.lang.String description,
java.lang.String subType,
byte[] data)
throws java.io.IOException
PDFAttachGenericFile in class ZUGFeRDExporterFromA3filename - name of the file that will become attachment name in the PDFrelationship - how the file relates to the content, e.g. "Alternative"description - Human-readable description of the file contentsubType - type of the data e.g. could be "text/xml" - mime likedata - the binary data of the file/attachmentjava.io.IOException - if anything is wrong with filenamepublic void PDFAttachGenericFile(org.apache.pdfbox.pdmodel.PDDocument doc,
java.lang.String filename,
java.lang.String relationship,
java.lang.String description,
java.lang.String subType,
byte[] data)
throws java.io.IOException
PDFAttachGenericFile in class ZUGFeRDExporterFromA3doc - PDDocument to attach the file to.filename - name of the file that will become attachment name in the PDFrelationship - how the file relates to the content, e.g. "Alternative"description - Human-readable description of the file contentsubType - type of the data e.g. could be "text/xml" - mime likedata - the binary data of the file/attachmentjava.io.IOException - if anything is wrong with filenamepublic DXExporterFromA3 setXML(byte[] zugferdData) throws java.io.IOException
setXML in interface IZUGFeRDExportersetXML in class ZUGFeRDExporterFromA3zugferdData - XML data to be set as a byte array (XML file in raw form).java.io.IOException - (should not happen)public DXExporterFromA3 load(java.io.InputStream pdfSource) throws java.io.IOException
load in interface IZUGFeRDExporterload in class ZUGFeRDExporterFromA3pdfSource - source to read a PDF/A1 compliant document fromjava.io.IOException - if anything is wrong with inputstreampublic boolean ensurePDFIsValid(javax.activation.DataSource dataSource)
throws java.io.IOException
ensurePDFIsValid in interface IZUGFeRDExporterensurePDFIsValid in class ZUGFeRDExporterFromA3java.io.IOExceptionpublic DXExporterFromA3 setConformanceLevel(PDFAConformanceLevel newLevel)
PDF/A-3 has three coformance levels, called "A", "U" and "B".
PDF/A-3-B where B means only visually preservable, U -standard for Mustang- means visually and unicode preservable and A means full compliance, i.e. visually, unicode and structurally preservable and tagged PDF, i.e. useful metainformation for blind people.
Feel free to pass "A" as new level if you know what you are doing :-)
setConformanceLevel in interface IZUGFeRDExportersetConformanceLevel in class ZUGFeRDExporterFromA3public DXExporterFromA3 setCreator(java.lang.String creator)
setCreator in interface IZUGFeRDExportersetCreator in class ZUGFeRDExporterFromA3public DXExporterFromA3 setCreatorTool(java.lang.String creatorTool)
setCreatorTool in class ZUGFeRDExporterFromA3public DXExporterFromA3 setProducer(java.lang.String producer)
setProducer in interface IZUGFeRDExportersetProducer in class ZUGFeRDExporterFromA3public DXExporterFromA3 setDocumentType(java.lang.String DocumentType)
DocumentType - String, usually DESPATCHADVICEprotected DXExporterFromA3 setAttachZUGFeRDHeaders(boolean attachHeaders)
setAttachZUGFeRDHeaders in class ZUGFeRDExporterFromA3protected void addXMP(org.apache.xmpbox.XMPMetadata metadata)
addXMP in class ZUGFeRDExporterFromA3metadata - the PDFbox XMPMetadata objectpublic IExporter setTransaction(IExportableTransaction trans) throws java.io.IOException
setTransaction in interface IExportersetTransaction in class ZUGFeRDExporterFromA3trans - a IZUGFeRDExportableTransaction that provides the data-model to
populate the XML. This parameter may be null, if so the XML data
should hav ebeen set via
setZUGFeRDXMLData(byte[] zugferdData)java.io.IOException - if anything is wrong with already loaded PDFpublic IExporter prepare() throws java.io.IOException
prepare in class ZUGFeRDExporterFromA3java.io.IOExceptionprotected org.apache.xmpbox.XMPMetadata getXmpMetadata()
throws java.io.IOException
getXmpMetadata in class ZUGFeRDExporterFromA3java.io.IOExceptionprotected byte[] serializeXmpMetadata(org.apache.xmpbox.XMPMetadata xmpMetadata)
throws javax.xml.transform.TransformerException
serializeXmpMetadata in class ZUGFeRDExporterFromA3javax.xml.transform.TransformerExceptionprotected void writeAdobePDFSchema(org.apache.xmpbox.XMPMetadata xmp)
writeAdobePDFSchema in class ZUGFeRDExporterFromA3protected org.apache.xmpbox.schema.AdobePDFSchema getAdobePDFSchema(org.apache.xmpbox.XMPMetadata xmp)
getAdobePDFSchema in class ZUGFeRDExporterFromA3xmp - the metadata to attach toprotected void writePDFAIdentificationSchema(org.apache.xmpbox.XMPMetadata xmp)
writePDFAIdentificationSchema in class ZUGFeRDExporterFromA3protected org.apache.xmpbox.schema.PDFAIdentificationSchema getPDFAIdentificationSchema(org.apache.xmpbox.XMPMetadata xmp)
getPDFAIdentificationSchema in class ZUGFeRDExporterFromA3protected void writeDublinCoreSchema(org.apache.xmpbox.XMPMetadata xmp)
writeDublinCoreSchema in class ZUGFeRDExporterFromA3protected org.apache.xmpbox.schema.DublinCoreSchema getDublinCoreSchema(org.apache.xmpbox.XMPMetadata xmp)
getDublinCoreSchema in class ZUGFeRDExporterFromA3protected void writeXMLBasicSchema(org.apache.xmpbox.XMPMetadata xmp)
writeXMLBasicSchema in class ZUGFeRDExporterFromA3protected org.apache.xmpbox.schema.XMPBasicSchema getXmpBasicSchema(org.apache.xmpbox.XMPMetadata xmp)
getXmpBasicSchema in class ZUGFeRDExporterFromA3protected void writeDocumentInformation()
writeDocumentInformation in class ZUGFeRDExporterFromA3protected void addSRGBOutputIntend()
throws java.io.IOException
addSRGBOutputIntend in class ZUGFeRDExporterFromA3java.io.IOExceptionprotected void setMarked()
setMarked in class ZUGFeRDExporterFromA3protected void addStructureTreeRoot()
addStructureTreeRoot in class ZUGFeRDExporterFromA3public boolean isAutoCloseDisabled()
isAutoCloseDisabled in class ZUGFeRDExporterFromA3public DXExporterFromA3 disableAutoClose(boolean disableAutoClose)
disableAutoClose in interface IZUGFeRDExporterdisableAutoClose in class ZUGFeRDExporterFromA3disableAutoClose - prevent PDF file from being closed after adding ZFprotected void setXMLProvider(IXMLProvider p)
setXMLProvider in class ZUGFeRDExporterFromA3public DXExporterFromA3 setZUGFeRDVersion(int version)
setZUGFeRDVersion in interface IZUGFeRDExportersetZUGFeRDVersion in class ZUGFeRDExporterFromA3Copyright © 2023. All rights reserved.