com.helger.ebinterface.visualization.VisualizationManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ph-ebinterface Show documentation
ebInterface wrapper library to easily read and write ebInterface documents
There is a newer version: 7.1.0
/**
 * Copyright (C) 2014-2020 Philip Helger (www.helger.com)
 * 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.ebinterface.visualization;

import java.io.File;
import java.util.Locale;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.ThreadSafe;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Templates;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.dom.DOMResult;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;

import com.helger.commons.ValueEnforcer;
import com.helger.commons.collection.impl.CommonsHashMap;
import com.helger.commons.collection.impl.ICommonsMap;
import com.helger.commons.concurrent.SimpleReadWriteLock;
import com.helger.commons.io.resource.IReadableResource;
import com.helger.commons.state.ESuccess;
import com.helger.ebinterface.EEbInterfaceVersion;
import com.helger.xml.XMLFactory;
import com.helger.xml.transform.LoggingTransformErrorListener;
import com.helger.xml.transform.TransformResultFactory;
import com.helger.xml.transform.TransformSourceFactory;
import com.helger.xml.transform.XMLTransformerFactory;

/**
 * This class is responsible for visualizing ebInterface documents as HTML
 * documents.
 *
 * @author Philip Helger
 */
@ThreadSafe
public final class VisualizationManager
{
  private static final Logger LOGGER = LoggerFactory.getLogger (VisualizationManager.class);
  private static final SimpleReadWriteLock s_aRWLock = new SimpleReadWriteLock ();
  // Map
  @GuardedBy ("s_aRWLock")
  private static final ICommonsMap  s_aTemplates = new CommonsHashMap <> ();

  private VisualizationManager ()
  {}

  /**
   * Get the precompiled XSLT template to be used. It is lazily initialized upon
   * first call.
   *
   * @param eVersion
   *        The ebInterface version to be used. May not be null.
   * @return The XSLT {@link Templates} to be used to visualize invoices or
   *         null if the template is buggy!
   */
  @Nullable
  public static Templates getXSLTTemplates (@Nonnull final EEbInterfaceVersion eVersion)
  {
    final String sNamespaceURI = eVersion.getNamespaceURI ();

    // Try in read-lock first
    final Templates ret = s_aRWLock.readLockedGet ( () -> s_aTemplates.get (sNamespaceURI));
    if (ret != null)
      return ret;

    return s_aRWLock.writeLockedGet ( () -> {
      // Try again in write lock
      Templates ret2 = s_aTemplates.get (sNamespaceURI);
      if (ret2 == null)
      {
        // Definitely not present - compile
        final IReadableResource aXSLTRes = eVersion.getXSLTResource ();
        if (aXSLTRes != null)
        {
          ret2 = XMLTransformerFactory.newTemplates (aXSLTRes);
          if (ret2 == null)
            LOGGER.error ("Failed to parse XSLT template " + aXSLTRes);
          else
            if (LOGGER.isDebugEnabled ())
              LOGGER.debug ("Compiled XSLT template " + aXSLTRes);
          s_aTemplates.put (sNamespaceURI, ret2);
        }
        else
        {
          if (LOGGER.isDebugEnabled ())
            LOGGER.debug ("ebInterface version " + eVersion.getVersion ().getAsString () + " contains no XSLT");
        }
      }
      return ret2;
    });
  }

  /**
   * Visualize a source to a result for a certain ebInterface version using
   * XSLT. This is the most generic method.
   *
   * @param eVersion
   *        ebInterface version to use.
   * @param aSource
   *        Source.
   * @param aResult
   *        Destination
   * @return {@link ESuccess}
   */
  @Nonnull
  public static ESuccess visualize (@Nonnull final EEbInterfaceVersion eVersion,
                                    @Nonnull final Source aSource,
                                    @Nonnull final Result aResult)
  {
    ValueEnforcer.notNull (eVersion, "version");

    // Get cache XSL templates
    final Templates aTemplates = getXSLTTemplates (eVersion);
    if (aTemplates == null)
      return ESuccess.FAILURE;

    // Start the main transformation
    try
    {
      final Transformer aTransformer = aTemplates.newTransformer ();
      aTransformer.setErrorListener (new LoggingTransformErrorListener (Locale.US));
      aTransformer.transform (aSource, aResult);
      return ESuccess.SUCCESS;
    }
    catch (final TransformerException ex)
    {
      LOGGER.error ("Failed to apply transformation for ebInterface " + eVersion + " invoice", ex);
      return ESuccess.FAILURE;
    }
  }

  /**
   * Visualize a source to a DOM document for a certain ebInterface version.
   *
   * @param eVersion
   *        ebInterface version to use. May not be null.
   * @param aSource
   *        Source. May not be null.
   * @return null if the XSLT could not be applied.
   */
  @Nullable
  public static Document visualizeToDOMDocument (@Nonnull final EEbInterfaceVersion eVersion, @Nonnull final Source aSource)
  {
    final Document aDoc = XMLFactory.newDocument ();
    return visualize (eVersion, aSource, new DOMResult (aDoc)).isSuccess () ? aDoc : null;
  }

  /**
   * Visualize a source to a DOM document for a certain ebInterface version.
   *
   * @param eVersion
   *        ebInterface version to use. May not be null.
   * @param aResource
   *        Source resource. May not be null.
   * @return null if the XSLT could not be applied.
   */
  @Nullable
  public static Document visualizeToDOMDocument (@Nonnull final EEbInterfaceVersion eVersion, @Nonnull final IReadableResource aResource)
  {
    return visualizeToDOMDocument (eVersion, TransformSourceFactory.create (aResource));
  }

  /**
   * Visualize a source to a file for a certain ebInterface version.
   *
   * @param eVersion
   *        ebInterface version to use. May not be null.
   * @param aSource
   *        Source. May not be null.
   * @param aDestinationFile
   *        The file to write the result to. May not be null.
   * @return {@link ESuccess}
   */
  @Nullable
  public static ESuccess visualizeToFile (@Nonnull final EEbInterfaceVersion eVersion,
                                          @Nonnull final Source aSource,
                                          @Nonnull final File aDestinationFile)
  {
    return visualize (eVersion, aSource, TransformResultFactory.create (aDestinationFile));
  }

  /**
   * Visualize a source to a file for a certain ebInterface version.
   *
   * @param eVersion
   *        ebInterface version to use. May not be null.
   * @param aResource
   *        Source resource. May not be null.
   * @param aDestinationFile
   *        The file to write the result to. May not be null.
   * @return {@link ESuccess}
   */
  @Nullable
  public static ESuccess visualizeToFile (@Nonnull final EEbInterfaceVersion eVersion,
                                          @Nonnull final IReadableResource aResource,
                                          @Nonnull final File aDestinationFile)
  {
    return visualize (eVersion, TransformSourceFactory.create (aResource), TransformResultFactory.create (aDestinationFile));
  }
}