at.austriapro.ebinterface.ubl.to.AbstractEbInterface61ToUBLConverter Maven / Gradle / Ivy
/*
* Copyright (c) 2010-2015 Bundesrechenzentrum GmbH - www.brz.gv.at
* Copyright (c) 2015-2024 AUSTRIAPRO - www.austriapro.at
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package at.austriapro.ebinterface.ubl.to;
import java.util.Locale;
import java.util.function.Supplier;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.helger.commons.collection.impl.CommonsLinkedHashSet;
import com.helger.commons.collection.impl.ICommonsOrderedSet;
import com.helger.commons.string.StringHelper;
import com.helger.ebinterface.v61.Ebi61AddressIdentifierType;
import com.helger.ebinterface.v61.Ebi61AddressType;
import com.helger.ebinterface.v61.Ebi61ContactType;
import com.helger.ebinterface.v61.Ebi61DeliveryType;
import com.helger.ebinterface.v61.Ebi61DocumentTypeType;
import com.helger.xsds.ccts.cct.schemamodule.CodeType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.AddressType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.ContactType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.DeliveryTermsType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.DeliveryType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.PartyNameType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.PartyType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.PeriodType;
import oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_21.PersonType;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_21.IDType;
import oasis.names.specification.ubl.schema.xsd.commonbasiccomponents_21.SpecialTermsType;
/**
* Base class for ebInterface 6.1 to Peppol UBL converter
*
* @author Philip Helger
*/
@Immutable
public abstract class AbstractEbInterface61ToUBLConverter extends AbstractEbInterfaceToUBLConverter
{
private static final Logger LOGGER = LoggerFactory.getLogger (AbstractEbInterface61ToUBLConverter.class);
/**
* Constructor
*
* @param aDisplayLocale
* The locale for error messages. May not be null.
* @param aContentLocale
* The locale for the created UBL files. May not be null.
*/
protected AbstractEbInterface61ToUBLConverter (@Nonnull final Locale aDisplayLocale,
@Nonnull final Locale aContentLocale)
{
super (aDisplayLocale, aContentLocale);
}
@Nullable
protected static T getTypeCode (@Nullable final Ebi61DocumentTypeType eType,
@Nonnull final Supplier aFactory)
{
String sID = null;
if (eType != null)
switch (eType)
{
case INVOICE:
case SUBSEQUENT_CREDIT:
case SUBSEQUENT_DEBIT:
sID = INVOICE_TYPE_CODE_INVOICE;
break;
case CREDIT_MEMO:
sID = INVOICE_TYPE_CODE_CREDIT_NOTE;
break;
case INVOICE_FOR_PARTIAL_DELIVERY:
sID = INVOICE_TYPE_CODE_PARTIAL;
break;
case INVOICE_FOR_ADVANCE_PAYMENT:
sID = INVOICE_TYPE_CODE_PREPAYMENT_INVOICE;
break;
case SELF_BILLING:
sID = INVOICE_TYPE_CODE_SELF_BILLING;
break;
case FINAL_SETTLEMENT:
sID = INVOICE_TYPE_CODE_FINAL_PAYMENT;
break;
}
if (sID == null)
{
LOGGER.warn ("Failed to resolve document type " + eType);
return null;
}
final T ret = aFactory.get ();
ret.setValue (sID);
ret.setListID ("UNCL1001");
ret.setName (eType.value ());
return ret;
}
@Nullable
protected static AddressType convertAddress (@Nullable final Ebi61AddressType aEbiAddress,
@Nonnull final Locale aContentLocale)
{
if (aEbiAddress == null)
return null;
final AddressType ret = new AddressType ();
if (aEbiAddress.hasAddressIdentifierEntries ())
{
// Only one ID allowed
final Ebi61AddressIdentifierType aEbiType = aEbiAddress.getAddressIdentifierAtIndex (0);
final IDType aUBLID = new IDType ();
aUBLID.setValue (aEbiType.getValue ());
if (aEbiType.getAddressIdentifierType () != null)
aUBLID.setSchemeID (aEbiType.getAddressIdentifierType ());
ret.setID (aUBLID);
}
if (StringHelper.hasText (aEbiAddress.getStreet ()))
ret.setStreetName (aEbiAddress.getStreet ());
if (StringHelper.hasText (aEbiAddress.getPOBox ()))
ret.setPostbox (aEbiAddress.getPOBox ());
if (StringHelper.hasText (aEbiAddress.getTown ()))
ret.setCityName (aEbiAddress.getTown ());
if (StringHelper.hasText (aEbiAddress.getZIP ()))
ret.setPostalZone (aEbiAddress.getZIP ());
if (aEbiAddress.getCountry () != null)
{
ret.setCountry (createCountry (aEbiAddress.getCountry ().getCountryCode (),
aEbiAddress.getCountry ().getValue (),
aContentLocale));
}
return ret;
}
@Nullable
protected static PartyType convertParty (@Nullable final Ebi61AddressType aEbiAddress,
@Nullable final Ebi61ContactType aEbiContact,
@Nonnull final Locale aContentLocale)
{
if (aEbiAddress == null && aEbiContact == null)
return null;
// Combine email addresses and phone numbers from Contact and Address
final ICommonsOrderedSet aEmails = new CommonsLinkedHashSet <> ();
final ICommonsOrderedSet aPhones = new CommonsLinkedHashSet <> ();
final PartyType ret = new PartyType ();
if (aEbiAddress != null)
{
if (StringHelper.hasText (aEbiAddress.getName ()))
{
final PartyNameType aUBLPartyName = new PartyNameType ();
aUBLPartyName.setName (aEbiAddress.getName ());
ret.addPartyName (aUBLPartyName);
}
ret.setPostalAddress (convertAddress (aEbiAddress, aContentLocale));
aEmails.addAll (aEbiAddress.getEmail ());
aPhones.addAll (aEbiAddress.getPhone ());
}
final ContactType aUBLContact = new ContactType ();
boolean bHasContactData = false;
if (aEbiContact != null)
{
if (StringHelper.hasText (aEbiContact.getSalutation ()))
{
final PersonType aUBLPerson = new PersonType ();
aUBLPerson.setGenderCode (aEbiContact.getSalutation ());
ret.addPerson (aUBLPerson);
}
if (StringHelper.hasText (aEbiContact.getName ()))
{
aUBLContact.setName (aEbiContact.getName ());
bHasContactData = true;
}
aEmails.addAll (aEbiContact.getEmail ());
aPhones.addAll (aEbiContact.getPhone ());
}
if (aEmails.isNotEmpty ())
{
aUBLContact.setElectronicMail (StringHelper.getImploded (' ', aEmails));
bHasContactData = true;
}
if (aPhones.isNotEmpty ())
{
aUBLContact.setTelephone (StringHelper.getImploded (' ', aPhones));
bHasContactData = true;
}
if (bHasContactData)
ret.setContact (aUBLContact);
return ret;
}
@Nullable
protected static DeliveryType convertDelivery (@Nullable final Ebi61DeliveryType aEbiDelivery,
@Nonnull final Locale aContentLocale)
{
if (aEbiDelivery == null)
return null;
final DeliveryType aUBLDelivery = new DeliveryType ();
if (aEbiDelivery.getDeliveryID () != null)
aUBLDelivery.setID (aEbiDelivery.getDeliveryID ());
if (aEbiDelivery.getDate () != null)
aUBLDelivery.setActualDeliveryDate (aEbiDelivery.getDate ());
else
if (aEbiDelivery.getPeriod () != null)
{
// Delivery period is mapped to invoice period
final PeriodType aUBLPeriod = new PeriodType ();
aUBLPeriod.setStartDate (aEbiDelivery.getPeriod ().getFromDate ());
aUBLPeriod.setEndDate (aEbiDelivery.getPeriod ().getToDate ());
aUBLDelivery.setRequestedDeliveryPeriod (aUBLPeriod);
}
aUBLDelivery.setDeliveryAddress (convertAddress (aEbiDelivery.getAddress (), aContentLocale));
aUBLDelivery.setDeliveryParty (convertParty (aEbiDelivery.getAddress (),
aEbiDelivery.getContact (),
aContentLocale));
// UBL has no address info field - add all
String sDeliveryInfo = aEbiDelivery.getDescription ();
if (aEbiDelivery.getAddress () != null)
{
// AdditionalInformation since v6.0
for (final var aAddInfo : aEbiDelivery.getAddress ().getAdditionalInformation ())
{
if (StringHelper.hasText (sDeliveryInfo))
{
sDeliveryInfo += "\n\n";
sDeliveryInfo += aAddInfo.getValue ();
}
else
sDeliveryInfo = aAddInfo.getValue ();
}
}
if (StringHelper.hasText (sDeliveryInfo))
{
final DeliveryTermsType aDeliveryTerms = new DeliveryTermsType ();
aDeliveryTerms.addSpecialTerms (new SpecialTermsType (sDeliveryInfo));
aUBLDelivery.addDeliveryTerms (aDeliveryTerms);
}
return aUBLDelivery;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy