com.helger.peppol.sbdh.write.PeppolSBDHDocumentWriter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of peppol-sbdh Show documentation
Library for reading and writing OASIS Standard Business Document Header (SBDH) documents conforming to the PEPPOL specifications
There is a newer version: 8.0.7
Show newest version
/**
 * Copyright (C) 2014-2019 Philip Helger
 * philip[at]helger[dot]com
 *
 * 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 com.helger.peppol.sbdh.write;

import java.util.Map;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.NotThreadSafe;

import org.unece.cefact.namespaces.sbdh.BusinessScope;
import org.unece.cefact.namespaces.sbdh.DocumentIdentification;
import org.unece.cefact.namespaces.sbdh.Partner;
import org.unece.cefact.namespaces.sbdh.PartnerIdentification;
import org.unece.cefact.namespaces.sbdh.Scope;
import org.unece.cefact.namespaces.sbdh.StandardBusinessDocument;
import org.unece.cefact.namespaces.sbdh.StandardBusinessDocumentHeader;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.OverrideOnDemand;
import com.helger.commons.string.StringHelper;
import com.helger.datetime.util.PDTXMLConverter;
import com.helger.peppol.sbdh.CPeppolSBDH;
import com.helger.peppol.sbdh.PeppolSBDHDocument;

@NotThreadSafe
public class PeppolSBDHDocumentWriter
{
  public PeppolSBDHDocumentWriter ()
  {}

  /**
   * Override this method to customize the created header version
   *
   * @return The SBDH header version to be used. May not be null.
   */
  @Nonnull
  @OverrideOnDemand
  protected String getHeaderVersion ()
  {
    return CPeppolSBDH.HEADER_VERSION;
  }

  /**
   * Create a new {@link StandardBusinessDocument} from the specified document
   * data.
   *
   * @param aData
   *        The document data to be used. May not be null and
   *        {@link PeppolSBDHDocument#areAllFieldsSet()} must return true!
   * @return Never null.
   * @throws IllegalArgumentException
   *         if not all document data fields are set!
   */
  @Nonnull
  public StandardBusinessDocument createStandardBusinessDocument (@Nonnull final PeppolSBDHDocument aData)
  {
    ValueEnforcer.notNull (aData, "Data");
    if (!aData.areAllFieldsSet ())
      throw new IllegalArgumentException ("Not all data fields are set!");

    final StandardBusinessDocument aSBD = new StandardBusinessDocument ();
    {
      final StandardBusinessDocumentHeader aSBDH = new StandardBusinessDocumentHeader ();
      aSBDH.setHeaderVersion (getHeaderVersion ());

      // Sender data
      {
        final Partner aSender = new Partner ();
        final PartnerIdentification aSenderID = new PartnerIdentification ();
        aSenderID.setAuthority (aData.getSenderScheme ());
        aSenderID.setValue (aData.getSenderValue ());
        aSender.setIdentifier (aSenderID);
        aSBDH.addSender (aSender);
      }

      // Receiver data
      {
        final Partner aReceiver = new Partner ();
        final PartnerIdentification aReceiverID = new PartnerIdentification ();
        aReceiverID.setAuthority (aData.getReceiverScheme ());
        aReceiverID.setValue (aData.getReceiverValue ());
        aReceiver.setIdentifier (aReceiverID);
        aSBDH.addReceiver (aReceiver);
      }

      // Document identification
      {
        final DocumentIdentification aDI = new DocumentIdentification ();
        aDI.setStandard (aData.getStandard ());
        aDI.setTypeVersion (aData.getTypeVersion ());
        aDI.setType (aData.getType ());
        aDI.setInstanceIdentifier (aData.getInstanceIdentifier ());
        aDI.setCreationDateAndTime (PDTXMLConverter.getXMLCalendar (aData.getCreationDateAndTime ()));
        aSBDH.setDocumentIdentification (aDI);
      }

      // Business scope
      {
        final BusinessScope aBusinessScope = new BusinessScope ();
        {
          final Scope aScope = new Scope ();
          aScope.setType (CPeppolSBDH.SCOPE_DOCUMENT_TYPE_ID);
          aScope.setInstanceIdentifier (aData.getDocumentTypeValue ());
          // The scheme was added in Spec v1.1
          aScope.setIdentifier (aData.getDocumentTypeScheme ());
          aBusinessScope.addScope (aScope);
        }
        {
          final Scope aScope = new Scope ();
          aScope.setType (CPeppolSBDH.SCOPE_PROCESS_ID);
          aScope.setInstanceIdentifier (aData.getProcessValue ());
          // The scheme was added in Spec v1.1
          aScope.setIdentifier (aData.getProcessScheme ());
          aBusinessScope.addScope (aScope);
        }

        // Add the additional attributes
        for (final Map.Entry  aEntry : aData.additionalAttributes ().entrySet ())
        {
          final Scope aScope = new Scope ();
          aScope.setType (aEntry.getKey ());
          // XSD requires InstanceIdentifier
          aScope.setInstanceIdentifier (StringHelper.getNotNull (aEntry.getValue ()));
          aBusinessScope.addScope (aScope);
        }

        aSBDH.setBusinessScope (aBusinessScope);
      }
      aSBD.setStandardBusinessDocumentHeader (aSBDH);
    }
    // getBusinessMessage already returns a cloned node!
    aSBD.setAny (aData.getBusinessMessage ());
    return aSBD;
  }
}