Package org.mustangproject.ZUGFeRD

Class OXExporterFromA1

java.lang.Object

org.mustangproject.ZUGFeRD.XRExporter

org.mustangproject.ZUGFeRD.ZUGFeRDExporterFromA3

org.mustangproject.ZUGFeRD.OXExporterFromA3

org.mustangproject.ZUGFeRD.OXExporterFromA1

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, IExporter, IZUGFeRDExporter

public class OXExporterFromA1
extends OXExporterFromA3

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	ignorePDFAErrors

Fields inherited from class org.mustangproject.ZUGFeRD.OXExporterFromA3

author, conformanceLevel, creator, creatorTool, fileAttachments, metadata, orderXDocumentType, overwrite, producer, subject, title

Fields inherited from class org.mustangproject.ZUGFeRD.ZUGFeRDExporterFromA3

DefaultZUGFeRDVersion, doc, xmp, XRechnungVersion, ZFVersion

Constructor Summary

Constructors

Constructor	Description
OXExporterFromA1()

Method Summary

Modifier and Type	Method	Description
OXExporterFromA1	convertOnly()
OXExporterFromA1	disableAutoClose(boolean disableAutoClose)
boolean	ensurePDFIsValid(jakarta.activation.DataSource dataSource)
java.lang.String	getNamespaceForVersion(int ver)	internal helper function: get namespace for order-x
java.lang.String	getPrefixForVersion(int ver)	internal helper: returns the namespace prefix for the given order-x version number
OXExporterFromA1	ignorePDFAErrors()
OXExporterFromA1	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)
OXExporterFromA1	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)
OXExporterFromA1	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)
OXExporterFromA1	setConformanceLevel(PDFAConformanceLevel newLevel)	All files are PDF/A-3, setConformance refers to the level conformance.
OXExporterFromA1	setCreator(java.lang.String creator)
OXExporterFromA1	setProducer(java.lang.String producer)
OXExporterFromA1	setProfile(java.lang.String profileName)
OXExporterFromA1	setProfile(Profile p)
OXExporterFromA1	setXML(byte[] zugferdData)	Sets the ZUGFeRD XML data to be attached as a single byte array.
OXExporterFromA1	setZUGFeRDVersion(int version)

Methods inherited from class org.mustangproject.ZUGFeRD.OXExporterFromA3

addAdditionalFile, addSRGBOutputIntend, addStructureTreeRoot, addXMP, attachFile, attachFile, close, export, export, getAdobePDFSchema, getDublinCoreSchema, getPDFAIdentificationSchema, getProvider, getXmpBasicSchema, getXmpMetadata, isAutoCloseDisabled, PDFAttachGenericFile, PDFAttachGenericFile, prepare, serializeXmpMetadata, setAttachZUGFeRDHeaders, setCreatorTool, setMarked, setOrderXDocumentType, setTransaction, setXMLProvider, writeAdobePDFSchema, writeDocumentInformation, writeDublinCoreSchema, writePDFAIdentificationSchema, writeXMLBasicSchema

Methods inherited from class org.mustangproject.ZUGFeRD.ZUGFeRDExporterFromA3

disableFacturX, getFilenameForVersion, prepareDocument, setFacturX, setXRechnungSpecificVersion, setZUGFeRDVersion

Methods inherited from class java.lang.Object

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

Field Detail

ignorePDFAErrors

protected boolean ignorePDFAErrors

Constructor Detail

OXExporterFromA1

public OXExporterFromA1()

Method Detail

ignorePDFAErrors

public OXExporterFromA1 ignorePDFAErrors()

Overrides:

ignorePDFAErrors in class ZUGFeRDExporterFromA3

getNamespaceForVersion

public java.lang.String getNamespaceForVersion(int ver)

internal helper function: get namespace for order-x

Specified by:

getNamespaceForVersion in interface IZUGFeRDExporter

Overrides:

getNamespaceForVersion in class ZUGFeRDExporterFromA3

Parameters:

ver - the order-x version

Returns:

the URN of the namespace

getPrefixForVersion

public java.lang.String getPrefixForVersion(int ver)

internal helper: returns the namespace prefix for the given order-x version number

Specified by:

getPrefixForVersion in interface IZUGFeRDExporter

Overrides:

getPrefixForVersion in class ZUGFeRDExporterFromA3

Parameters:

ver - the ox version

Returns:

the namespace prefix as string, without colon

setProfile

public OXExporterFromA1 setProfile(Profile p)

Specified by:

setProfile in interface IZUGFeRDExporter

Overrides:

setProfile in class OXExporterFromA3

setProfile

public OXExporterFromA1 setProfile(java.lang.String profileName)

Overrides:

setProfile in class OXExporterFromA3

ensurePDFIsValid

public boolean ensurePDFIsValid(jakarta.activation.DataSource dataSource)
                         throws java.io.IOException

Specified by:

ensurePDFIsValid in interface IZUGFeRDExporter

Overrides:

ensurePDFIsValid in class OXExporterFromA3

Throws:

java.io.IOException

load

public OXExporterFromA1 load(java.lang.String pdfFilename)
                      throws java.io.IOException

Description copied from class: OXExporterFromA3

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)

Specified by:

load in interface IZUGFeRDExporter

Overrides:

load in class OXExporterFromA3

Parameters:

pdfFilename - filename of an PDF/A1 compliant document

Returns:

the generated exporter

Throws:

java.io.IOException - if anything is wrong with filename

load

public OXExporterFromA1 load(byte[] pdfBinary)
                      throws java.io.IOException

Description copied from class: OXExporterFromA3

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)

Specified by:

load in interface IZUGFeRDExporter

Overrides:

load in class OXExporterFromA3

Parameters:

pdfBinary - binary of a PDF/A1 compliant document

Returns:

the generated exporter

Throws:

java.io.IOException - (should not happen at all)

load

public OXExporterFromA1 load(java.io.InputStream pdfSource)
                      throws java.io.IOException

Description copied from class: OXExporterFromA3

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)

Specified by:

load in interface IZUGFeRDExporter

Overrides:

load in class OXExporterFromA3

Parameters:

pdfSource - source to read a PDF/A1 compliant document from

Returns:

the generated ZUGFeRDExporter

Throws:

java.io.IOException - if anything is wrong with inputstream

setCreator

public OXExporterFromA1 setCreator(java.lang.String creator)

Specified by:

setCreator in interface IZUGFeRDExporter

Overrides:

setCreator in class OXExporterFromA3

setConformanceLevel

public OXExporterFromA1 setConformanceLevel(PDFAConformanceLevel newLevel)

Description copied from class: OXExporterFromA3

All files are PDF/A-3, setConformance refers to the level conformance.

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 :-)

Specified by:

setConformanceLevel in interface IZUGFeRDExporter

Overrides:

setConformanceLevel in class OXExporterFromA3

setProducer

public OXExporterFromA1 setProducer(java.lang.String producer)

Specified by:

setProducer in interface IZUGFeRDExporter

Overrides:

setProducer in class OXExporterFromA3

setZUGFeRDVersion

public OXExporterFromA1 setZUGFeRDVersion(int version)

Specified by:

setZUGFeRDVersion in interface IZUGFeRDExporter

Overrides:

setZUGFeRDVersion in class OXExporterFromA3

setXML

public OXExporterFromA1 setXML(byte[] zugferdData)
                        throws java.io.IOException

Description copied from class: OXExporterFromA3

Sets the ZUGFeRD XML data to be attached as a single byte array. This is useful for use-cases where the XML has already been produced by some external API or component.

Specified by:

setXML in interface IZUGFeRDExporter

Overrides:

setXML in class OXExporterFromA3

Parameters:

zugferdData - XML data to be set as a byte array (XML file in raw form).

Throws:

java.io.IOException - (should not happen)

disableAutoClose

public OXExporterFromA1 disableAutoClose(boolean disableAutoClose)

Specified by:

disableAutoClose in interface IZUGFeRDExporter

Overrides:

disableAutoClose in class OXExporterFromA3

Parameters:

disableAutoClose - prevent PDF file from being closed after adding ZF

convertOnly

public OXExporterFromA1 convertOnly()