com.itextpdf.zugferd

Class InvoiceDOM

java.lang.Object

com.itextpdf.zugferd.InvoiceDOM

public class InvoiceDOM
extends Object

Represents the DOM structure of a ZUGFeRD invoice. It will load the data from the IBasicProfile implementation. This class is also responsible to transform this dom structure into an XML.

Field Summary

Fields

Modifier and Type	Field and Description
static CountryCode	COUNTRY_CODE The Constant COUNTRY_CODE.
static CurrencyCode	CURR_CODE The Constant CURR_CODE.
static NumberChecker	DEC2 The Constant DEC2.
static NumberChecker	DEC4 The Constant DEC4.
static DateFormatCode	DF_CODE The Constant DF_CODE.
protected Document	doc The DOM document.
static GlobalIdentifierCode	GI_CODE The Constant GI_CODE.
static MeasurementUnitCode	M_UNIT_CODE The Constant M_UNIT_CODE.
static PaymentMeansCode	PM_CODE The Constant PM_CODE.
static TaxCategoryCode	TC_CODE The Constant TC_CODE.
static TaxIDTypeCode	TIDT_CODE The Constant TIDT_CODE.
static TaxTypeCode	TT_CODE The Constant TT_CODE.

Constructor Summary

Constructors

Constructor and Description
InvoiceDOM(IBasicProfile data) Creates an object that will import data into an XML template.
InvoiceDOM(IBasicProfile data, InvoiceProperties properties) Creates an object that will import data into an XML template.

Method Summary

Modifier and Type	Method and Description
protected void	check(String s, String message) Checks if a string is empty and throws a DataIncompleteException if so.
protected void	importAppliedTradeAllowanceCharge(Element parent, boolean indicator, String actualAmount, String currencyID, String reason) Imports applied trade allowance charge data (line items).
protected void	importBuyerTradeParty(Element parent, IBasicProfile data) Gets the buyer trade party data to import this data.
protected void	importContent(Element parent, String tag, String content, String... attributes) Helper method to set the content of a tag.
protected void	importDateTime(Element parent, String tag, String dateTimeFormat, Date dateTime) Set the content of a date tag along with the attribute that defines the format.
protected void	importHeaderExchangedDocument(Element element, IBasicProfile data) Imports the data for the following tag: rsm:HeaderExchangedDocument.
protected void	importIncludedNotes(Element parent, int level, String[][] notes, String[] notesCodes) Includes notes and (in case of the COMFORT profile) the subject codes for those notes.
protected void	importInvoiceeTradeParty(Element parent, IComfortProfile data) Gets the invoicee party data to import this data.
protected void	importLineItemBasic(Element parent, String quantity, String code, String name) Imports the data for a line item (basic profile).
protected void	importLineItemComfort(Element parent, String lineID, String[][] note, String grossPriceChargeAmount, String grossPriceChargeAmountCurrencyID, String grossPriceBasisQuantity, String grossPriceBasisQuantityCode, boolean[] grossPriceTradeAllowanceChargeIndicator, String[] grossPriceTradeAllowanceChargeActualAmount, String[] grossPriceTradeAllowanceChargeActualAmountCurrencyID, String[] grossPriceTradeAllowanceChargeReason, String netPriceChargeAmount, String netPriceChargeAmountCurrencyID, String netPriceBasisQuantity, String netPriceBasisQuantityCode, String billedQuantity, String billedQuantityCode, String[] settlementTaxTypeCode, String[] settlementTaxExemptionReason, String[] settlementTaxCategoryCode, String[] settlementTaxApplicablePercent, String totalAmount, String totalAmountCurrencyID, String specifiedTradeProductGlobalID, String specifiedTradeProductSchemeID, String specifiedTradeProductSellerAssignedID, String specifiedTradeProductBuyerAssignedID, String specifiedTradeProductName, String specifiedTradeProductDescription) Imports line item data (comfort profile).
protected void	importLineItemsBasic(Element parent, IBasicProfile data) Gets line data to import the this data (basic profile).
protected void	importLineItemsComfort(Element parent, IComfortProfile data) Gets line item data to import the this data (comfort profile).
protected void	importPaymentMeans(Element parent, IBasicProfile data) Gets the payment means data to imports this data.
protected void	importPaymentMeans(Element parent, String typeCode, String[] information, String id, String scheme, String payerIban, String payerProprietaryID, String iban, String accName, String accID, String payerBic, String payerBank, String payerInst, String bic, String bank, String inst) Imports payment means data.
protected void	importSellerTradeParty(Element parent, IBasicProfile data) Gets the seller trade party data to import this data.
protected void	importSpecifiedExchangedDocumentContext(Element element, IBasicProfile data) Imports the data for the following tag: rsm:SpecifiedExchangedDocumentContext.
protected void	importSpecifiedLogisticsServiceCharge(Element parent, IComfortProfile data) Gets specified logistics service charge data to import the this data.
protected void	importSpecifiedLogisticsServiceCharge(Element parent, String[] description, String appliedAmount, String currencyID, String[] typeCode, String[] categoryCode, String[] percent) Imports specified logistics service charge data.
protected void	importSpecifiedSupplyChainTradeTransaction(Element element, IBasicProfile data) Imports the data for the following tag: rsm:SpecifiedSupplyChainTradeTransaction.
protected void	importSpecifiedTradeAllowanceCharge(Element parent, boolean indicator, String actualAmount, String actualAmountCurrency, String reason, String[] typeCode, String[] categoryCode, String[] percent) Imports specified trade allowance charge.
protected void	importSpecifiedTradeAllowanceCharge(Element parent, IComfortProfile data) Gets specified trade allowance charge data to import the this data.
protected void	importSpecifiedTradePaymentTerms(Element parent, IComfortProfile data) Gets specified trade payment terms data to import the this data.
protected void	importSpecifiedTradePaymentTerms(Element parent, String[] description, Date dateTime, String dateTimeFormat) Imports specified trade payment terms.
protected void	importTax(Element parent, IBasicProfile data) Gets tax data to import the this data.
protected void	importTax(Element parent, String typeCode, String exemptionReason, String category, String percent) Imports tax data.
protected void	importTax(Element parent, String calculatedAmount, String currencyID, String typeCode, String exemptionReason, String basisAmount, String basisAmountCurr, String category, String percent) Imports tax data.
protected void	importTradeParty(Element parent, String id, String[] globalID, String[] globalIDScheme, String name, String postcode, String lineOne, String lineTwo, String cityName, String countryID, String[] taxRegistrationID, String[] taxRegistrationSchemeID) Imports trade party information (could be seller, buyer or invoicee).
protected static void	removeEmptyNodes(Node node) It is forbidden for a ZUGFeRD XML to contain empty tags, hence we use this method recursively to remove empty nodes.
byte[]	toXML() Exports the Document as an XML file.

Methods inherited from class java.lang.Object

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

Field Detail

COUNTRY_CODE

public static final CountryCode COUNTRY_CODE

The Constant COUNTRY_CODE.

CURR_CODE

public static final CurrencyCode CURR_CODE

The Constant CURR_CODE.

DF_CODE

public static final DateFormatCode DF_CODE

The Constant DF_CODE.

GI_CODE

public static final GlobalIdentifierCode GI_CODE

The Constant GI_CODE.

M_UNIT_CODE

public static final MeasurementUnitCode M_UNIT_CODE

The Constant M_UNIT_CODE.

DEC2

public static final NumberChecker DEC2

The Constant DEC2.

DEC4

public static final NumberChecker DEC4

The Constant DEC4.

PM_CODE

public static final PaymentMeansCode PM_CODE

The Constant PM_CODE.

TC_CODE

public static final TaxCategoryCode TC_CODE

The Constant TC_CODE.

TIDT_CODE

public static final TaxIDTypeCode TIDT_CODE

The Constant TIDT_CODE.

TT_CODE

public static final TaxTypeCode TT_CODE

The Constant TT_CODE.

doc

protected final Document doc

The DOM document.

Constructor Detail

InvoiceDOM

public InvoiceDOM(IBasicProfile data)
           throws ParserConfigurationException,
                  SAXException,
                  IOException,
                  DataIncompleteException,
                  InvalidCodeException

Creates an object that will import data into an XML template.

Parameters:

data - If this is an instance of BASICInvoice, the BASIC profile will be used; If this is an instance of COMFORTInvoice, the COMFORT profile will be used.

Throws:

ParserConfigurationException - the parser configuration exception

SAXException - the SAX exception

IOException - Signals that an I/O exception has occurred.

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

InvoiceDOM

public InvoiceDOM(IBasicProfile data,
                  InvoiceProperties properties)
           throws ParserConfigurationException,
                  SAXException,
                  IOException,
                  DataIncompleteException,
                  InvalidCodeException

Creates an object that will import data into an XML template.

Parameters:

data - If this is an instance of BASICInvoice, the BASIC profile will be used; If this is an instance of COMFORTInvoice, the COMFORT profile will be used.

properties - Invoice properties.

Throws:

ParserConfigurationException - the parser configuration exception

SAXException - the SAX exception

IOException - Signals that an I/O exception has occurred.

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

Method Detail

importSpecifiedExchangedDocumentContext

protected void importSpecifiedExchangedDocumentContext(Element element,
                                                       IBasicProfile data)

Imports the data for the following tag: rsm:SpecifiedExchangedDocumentContext.

Parameters:

element - the rsm:SpecifiedExchangedDocumentContext element

data - the invoice data

importHeaderExchangedDocument

protected void importHeaderExchangedDocument(Element element,
                                             IBasicProfile data)
                                      throws DataIncompleteException,
                                             InvalidCodeException

Imports the data for the following tag: rsm:HeaderExchangedDocument.

Parameters:

element - the rsm:HeaderExchangedDocument element

data - the invoice data

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importContent

protected void importContent(Element parent,
                             String tag,
                             String content,
                             String... attributes)

Helper method to set the content of a tag.

Parameters:

parent - the parent element of the tag

tag - the tag for which we want to set the content

content - the new content for the tag

attributes - a sequence of attributes of which the odd elements are keys, the even elements the corresponding value.

importDateTime

protected void importDateTime(Element parent,
                              String tag,
                              String dateTimeFormat,
                              Date dateTime)
                       throws InvalidCodeException

Set the content of a date tag along with the attribute that defines the format.

Parameters:

parent - the parent element that holds the date tag

tag - the date tag we want to change

dateTimeFormat - the format that will be used as an attribute

dateTime - the actual date

Throws:

InvalidCodeException - the invalid code exception

importIncludedNotes

protected void importIncludedNotes(Element parent,
                                   int level,
                                   String[][] notes,
                                   String[] notesCodes)
                            throws DataIncompleteException,
                                   InvalidCodeException

Includes notes and (in case of the COMFORT profile) the subject codes for those notes.

Parameters:

parent - the parent element of the tag we want to change

level - the level where the notices are added (header or line)

notes - array of notes

notesCodes - array of codes for the notes. If not null, notes and notesCodes need to have an equal number of elements.

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importSpecifiedSupplyChainTradeTransaction

protected void importSpecifiedSupplyChainTradeTransaction(Element element,
                                                          IBasicProfile data)
                                                   throws DataIncompleteException,
                                                          InvalidCodeException

Imports the data for the following tag: rsm:SpecifiedSupplyChainTradeTransaction.

Parameters:

element - the element

data - the invoice data

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importSellerTradeParty

protected void importSellerTradeParty(Element parent,
                                      IBasicProfile data)
                               throws DataIncompleteException,
                                      InvalidCodeException

Gets the seller trade party data to import this data.

Parameters:

parent - the parent element

data - the data

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importBuyerTradeParty

protected void importBuyerTradeParty(Element parent,
                                     IBasicProfile data)
                              throws DataIncompleteException,
                                     InvalidCodeException

Gets the buyer trade party data to import this data.

Parameters:

parent - the parent element

data - the data

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importInvoiceeTradeParty

protected void importInvoiceeTradeParty(Element parent,
                                        IComfortProfile data)
                                 throws DataIncompleteException,
                                        InvalidCodeException

Gets the invoicee party data to import this data.

Parameters:

parent - the parent element

data - the data

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importTradeParty

protected void importTradeParty(Element parent,
                                String id,
                                String[] globalID,
                                String[] globalIDScheme,
                                String name,
                                String postcode,
                                String lineOne,
                                String lineTwo,
                                String cityName,
                                String countryID,
                                String[] taxRegistrationID,
                                String[] taxRegistrationSchemeID)
                         throws DataIncompleteException,
                                InvalidCodeException

Imports trade party information (could be seller, buyer or invoicee).

Parameters:

parent - the parent element

id - the id

globalID - the global ID

globalIDScheme - the global ID scheme

name - the name

postcode - the postcode

lineOne - the line one

lineTwo - the line two

cityName - the city name

countryID - the country ID

taxRegistrationID - the tax registration ID

taxRegistrationSchemeID - the tax registration scheme ID

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importPaymentMeans

protected void importPaymentMeans(Element parent,
                                  IBasicProfile data)
                           throws InvalidCodeException

Gets the payment means data to imports this data.

Parameters:

parent - the parent element

data - the data

Throws:

InvalidCodeException - the invalid code exception

importPaymentMeans

protected void importPaymentMeans(Element parent,
                                  String typeCode,
                                  String[] information,
                                  String id,
                                  String scheme,
                                  String payerIban,
                                  String payerProprietaryID,
                                  String iban,
                                  String accName,
                                  String accID,
                                  String payerBic,
                                  String payerBank,
                                  String payerInst,
                                  String bic,
                                  String bank,
                                  String inst)
                           throws InvalidCodeException

Imports payment means data.

Parameters:

parent - the parent element

typeCode - the type code

information - the information

id - the id

scheme - the scheme

payerIban - the payer iban

payerProprietaryID - the payer proprietary ID

iban - the iban

accName - the acc name

accID - the acc ID

payerBic - the payer bic

payerBank - the payer bank

payerInst - the payer inst

bic - the bic

bank - the bank

inst - the inst

Throws:

InvalidCodeException - the invalid code exception

importTax

protected void importTax(Element parent,
                         IBasicProfile data)
                  throws InvalidCodeException,
                         DataIncompleteException

Gets tax data to import the this data.

Parameters:

parent - the parent element

data - the data

Throws:

InvalidCodeException - the invalid code exception

DataIncompleteException - the data incomplete exception

importTax

protected void importTax(Element parent,
                         String calculatedAmount,
                         String currencyID,
                         String typeCode,
                         String exemptionReason,
                         String basisAmount,
                         String basisAmountCurr,
                         String category,
                         String percent)
                  throws InvalidCodeException,
                         DataIncompleteException

Imports tax data.

Parameters:

parent - the parent

calculatedAmount - the calculated amount

currencyID - the currency ID

typeCode - the type code

exemptionReason - the exemption reason

basisAmount - the basis amount

basisAmountCurr - the basis amount curr

category - the category

percent - the percent

Throws:

InvalidCodeException - the invalid code exception

DataIncompleteException - the data incomplete exception

importSpecifiedTradeAllowanceCharge

protected void importSpecifiedTradeAllowanceCharge(Element parent,
                                                   IComfortProfile data)
                                            throws InvalidCodeException

Gets specified trade allowance charge data to import the this data.

Parameters:

parent - the parent element

data - the data

Throws:

InvalidCodeException - the invalid code exception

importSpecifiedTradeAllowanceCharge

protected void importSpecifiedTradeAllowanceCharge(Element parent,
                                                   boolean indicator,
                                                   String actualAmount,
                                                   String actualAmountCurrency,
                                                   String reason,
                                                   String[] typeCode,
                                                   String[] categoryCode,
                                                   String[] percent)
                                            throws InvalidCodeException

Imports specified trade allowance charge.

Parameters:

parent - the parent

indicator - the indicator

actualAmount - the actual amount

actualAmountCurrency - the actual amount currency

reason - the reason

typeCode - the type code

categoryCode - the category code

percent - the percent

Throws:

InvalidCodeException - the invalid code exception

importSpecifiedLogisticsServiceCharge

protected void importSpecifiedLogisticsServiceCharge(Element parent,
                                                     IComfortProfile data)
                                              throws InvalidCodeException

Gets specified logistics service charge data to import the this data.

Parameters:

parent - the parent element

data - the data

Throws:

InvalidCodeException - the invalid code exception

importSpecifiedLogisticsServiceCharge

protected void importSpecifiedLogisticsServiceCharge(Element parent,
                                                     String[] description,
                                                     String appliedAmount,
                                                     String currencyID,
                                                     String[] typeCode,
                                                     String[] categoryCode,
                                                     String[] percent)
                                              throws InvalidCodeException

Imports specified logistics service charge data.

Parameters:

parent - the parent element

description - the description

appliedAmount - the applied amount

currencyID - the currency ID

typeCode - the type code

categoryCode - the category code

percent - the percent

Throws:

InvalidCodeException - the invalid code exception

importSpecifiedTradePaymentTerms

protected void importSpecifiedTradePaymentTerms(Element parent,
                                                IComfortProfile data)
                                         throws InvalidCodeException

Gets specified trade payment terms data to import the this data.

Parameters:

parent - the parent element

data - the data

Throws:

InvalidCodeException - the invalid code exception

importSpecifiedTradePaymentTerms

protected void importSpecifiedTradePaymentTerms(Element parent,
                                                String[] description,
                                                Date dateTime,
                                                String dateTimeFormat)
                                         throws InvalidCodeException

Imports specified trade payment terms.

Parameters:

parent - the parent element

description - the description

dateTime - the date time

dateTimeFormat - the date time format

Throws:

InvalidCodeException - the invalid code exception

importLineItemsComfort

protected void importLineItemsComfort(Element parent,
                                      IComfortProfile data)
                               throws DataIncompleteException,
                                      InvalidCodeException

Gets line item data to import the this data (comfort profile).

Parameters:

parent - the parent element

data - the data

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importLineItemComfort

protected void importLineItemComfort(Element parent,
                                     String lineID,
                                     String[][] note,
                                     String grossPriceChargeAmount,
                                     String grossPriceChargeAmountCurrencyID,
                                     String grossPriceBasisQuantity,
                                     String grossPriceBasisQuantityCode,
                                     boolean[] grossPriceTradeAllowanceChargeIndicator,
                                     String[] grossPriceTradeAllowanceChargeActualAmount,
                                     String[] grossPriceTradeAllowanceChargeActualAmountCurrencyID,
                                     String[] grossPriceTradeAllowanceChargeReason,
                                     String netPriceChargeAmount,
                                     String netPriceChargeAmountCurrencyID,
                                     String netPriceBasisQuantity,
                                     String netPriceBasisQuantityCode,
                                     String billedQuantity,
                                     String billedQuantityCode,
                                     String[] settlementTaxTypeCode,
                                     String[] settlementTaxExemptionReason,
                                     String[] settlementTaxCategoryCode,
                                     String[] settlementTaxApplicablePercent,
                                     String totalAmount,
                                     String totalAmountCurrencyID,
                                     String specifiedTradeProductGlobalID,
                                     String specifiedTradeProductSchemeID,
                                     String specifiedTradeProductSellerAssignedID,
                                     String specifiedTradeProductBuyerAssignedID,
                                     String specifiedTradeProductName,
                                     String specifiedTradeProductDescription)
                              throws DataIncompleteException,
                                     InvalidCodeException

Imports line item data (comfort profile).

Parameters:

parent - the parent element

lineID - the line ID

note - the note

grossPriceChargeAmount - the gross price charge amount

grossPriceChargeAmountCurrencyID - the gross price charge amount currency ID

grossPriceBasisQuantity - the gross price basis quantity

grossPriceBasisQuantityCode - the gross price basis quantity code

grossPriceTradeAllowanceChargeIndicator - the gross price trade allowance charge indicator

grossPriceTradeAllowanceChargeActualAmount - the gross price trade allowance charge actual amount

grossPriceTradeAllowanceChargeActualAmountCurrencyID - the gross price trade allowance charge actual amount currency ID

grossPriceTradeAllowanceChargeReason - the gross price trade allowance charge reason

netPriceChargeAmount - the net price charge amount

netPriceChargeAmountCurrencyID - the net price charge amount currency ID

netPriceBasisQuantity - the net price basis quantity

netPriceBasisQuantityCode - the net price basis quantity code

billedQuantity - the billed quantity

billedQuantityCode - the billed quantity code

settlementTaxTypeCode - the settlement tax type code

settlementTaxExemptionReason - the settlement tax exemption reason

settlementTaxCategoryCode - the settlement tax category code

settlementTaxApplicablePercent - the settlement tax applicable percent

totalAmount - the total amount

totalAmountCurrencyID - the total amount currency ID

specifiedTradeProductGlobalID - the specified trade product global ID

specifiedTradeProductSchemeID - the specified trade product scheme ID

specifiedTradeProductSellerAssignedID - the specified trade product seller assigned ID

specifiedTradeProductBuyerAssignedID - the specified trade product buyer assigned ID

specifiedTradeProductName - the specified trade product name

specifiedTradeProductDescription - the specified trade product description

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importAppliedTradeAllowanceCharge

protected void importAppliedTradeAllowanceCharge(Element parent,
                                                 boolean indicator,
                                                 String actualAmount,
                                                 String currencyID,
                                                 String reason)
                                          throws DataIncompleteException,
                                                 InvalidCodeException

Imports applied trade allowance charge data (line items).

Parameters:

parent - the parent element

indicator - the indicator

actualAmount - the actual amount

currencyID - the currency ID

reason - the reason

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importTax

protected void importTax(Element parent,
                         String typeCode,
                         String exemptionReason,
                         String category,
                         String percent)
                  throws InvalidCodeException,
                         DataIncompleteException

Imports tax data.

Parameters:

parent - the parent element

typeCode - the type code

exemptionReason - the exemption reason

category - the category

percent - the percent

Throws:

InvalidCodeException - the invalid code exception

DataIncompleteException - the data incomplete exception

importLineItemsBasic

protected void importLineItemsBasic(Element parent,
                                    IBasicProfile data)
                             throws DataIncompleteException,
                                    InvalidCodeException

Gets line data to import the this data (basic profile).

Parameters:

parent - the parent

data - the data

Throws:

DataIncompleteException - the data incomplete exception

InvalidCodeException - the invalid code exception

importLineItemBasic

protected void importLineItemBasic(Element parent,
                                   String quantity,
                                   String code,
                                   String name)
                            throws InvalidCodeException

Imports the data for a line item (basic profile).

Parameters:

parent - the parent element

quantity - the quantity

code - the code

name - the name

Throws:

InvalidCodeException - the invalid code exception

toXML

public byte[] toXML()
             throws TransformerException

Exports the Document as an XML file.

Returns:

a byte[] with the data in XML format

Throws:

TransformerException - the transformer exception

removeEmptyNodes

protected static void removeEmptyNodes(Node node)

It is forbidden for a ZUGFeRD XML to contain empty tags, hence we use this method recursively to remove empty nodes.

Parameters:

node - the node from which we want to remove the empty nodes

check

protected void check(String s,
                     String message)
              throws DataIncompleteException

Checks if a string is empty and throws a DataIncompleteException if so.

Parameters:

s - the String to check

message - the message if an exception is thrown

Throws:

DataIncompleteException - the data incomplete exception