/*
    * Copyright 2007-2013 smartics, Kronseder & Reiner GmbH
    *
    * 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 de.smartics.maven.exceptions.sdoc;
  
  import java.io.BufferedOutputStream;
  import java.io.File;
  import java.io.FileNotFoundException;
  import java.io.FileOutputStream;
  import java.io.OutputStream;
  import java.util.List;
  
  import javax.xml.parsers.DocumentBuilder;
  import javax.xml.parsers.DocumentBuilderFactory;
  import javax.xml.parsers.ParserConfigurationException;
  
  import org.apache.commons.io.IOUtils;
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.w3c.dom.Document;
  
  import de.smartics.exceptions.core.Code;
  import de.smartics.exceptions.report.data.ExceptionCodeReportItem;
  import de.smartics.exceptions.report.data.ProjectConfiguration;
  import de.smartics.exceptions.report.data.StoredExceptionCodesReport;
  import de.smartics.exceptions.report.generator.AbstractReportGenerator;
  import de.smartics.exceptions.report.renderer.JavadocRenderer;
  import de.smartics.exceptions.report.renderer.html.HtmlRendererFactory;
  import de.smartics.maven.io.MojoIoUtils;
  
  /**
   * Writes individual reports in the projectdoc's code doctype.
   */
  public class SdocCodeReportGenerator extends AbstractReportGenerator<File>
  {
  
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * Reference to the logger for this class.
     */
    private static final Log LOG = LogFactory
        .getLog(SdocCodeReportGenerator.class);
  
    // --- members --------------------------------------------------------------
  
    /**
     * The builder for XML documents.
     */
    private final DocumentBuilder builder;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param renderer the renderer used to map Javadoc comments to the report's
     *          output format.
     * @throws ParserConfigurationException if creating XML infrstructure fails.
     */
    public SdocCodeReportGenerator() throws ParserConfigurationException
    {
      super(new JavadocRenderer(new HtmlRendererFactory()));
  
      final DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
      builder = factory.newDocumentBuilder();
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    @Override
    protected void writeContent(final File output,
        final ProjectConfiguration<File> config,
        final StoredExceptionCodesReport reportData) throws Exception
   {
     final List<ExceptionCodeReportItem> items = reportData.getItems();
     for (final ExceptionCodeReportItem codeContainer : items)
     {
       writeReportToFile(output, config, codeContainer);
     }
   }
 
   private void writeReportToFile(final File output,
       final ProjectConfiguration<File> config,
       final ExceptionCodeReportItem codeContainer)
     throws MojoExecutionException, FileNotFoundException, Exception
   {
     final File file = createFile(output, codeContainer);
 
     if (LOG.isDebugEnabled())
     {
       LOG.debug("Creating report file '" + file.getAbsolutePath() + "'.");
     }
     OutputStream out = null;
     try
     {
       out = new BufferedOutputStream(new FileOutputStream(file));
       writeReportElementInfo(out, config, codeContainer);
     }
     finally
     {
       IOUtils.closeQuietly(out);
     }
   }
 
   private static File createFile(final File baseDir,
       final ExceptionCodeReportItem codeContainer)
     throws MojoExecutionException
   {
     final Code code = codeContainer.getCode();
     final String pathName =
         MojoIoUtils.normalizeFileName(code.getComponentId());
     final String fileName =
         MojoIoUtils.normalizeFileName(code.getCode()) + ".xml";
     final File dir = new File(baseDir, pathName);
     MojoIoUtils.provideMojoDirectory(dir);
     final File file = new File(dir, fileName);
     return file;
   }
 
   protected void writeReportElementInfo(final OutputStream reportOut,
       final ProjectConfiguration<File> config,
       final ExceptionCodeReportItem codeContainer) throws Exception
   {
     final Code codeInstance = codeContainer.getCode();
     final String codeRepresentation = String.valueOf(codeInstance);
 
     final Document document = createDocument();
     final SdocCodeBuilder builder =
         new SdocCodeBuilder(this.renderer, config, document, codeRepresentation, codeContainer);
     builder.writeDocumentContent();
     MojoIoUtils.serialize(document, reportOut, true);
   }
 
   private Document createDocument()
   {
     final Document document = builder.newDocument();
     return document;
   }
 
   // --- object basics --------------------------------------------------------
 
 }