/*
    * 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.exceptions.report.generator;
  
  import javax.xml.stream.XMLStreamException;
  import javax.xml.stream.XMLStreamWriter;
  
  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.renderer.JavadocRenderer;
  import de.smartics.exceptions.report.utils.CopyReader;
  
  /**
   * Simple generator that generates a HTML file.
   */
  public abstract class AbstractHtmlReportGenerator extends
      AbstractXmlReportGenerator
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param renderer the renderer used to map Javadoc comments to the report's
     *          output format.
     */
    protected AbstractHtmlReportGenerator(final JavadocRenderer renderer)
    {
      super(renderer);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     */
    @Override
    protected void writeContent(final XMLStreamWriter xmlWriter,
        final ProjectConfiguration<XMLStreamWriter> config,
        final StoredExceptionCodesReport report) throws Exception // NOPMD
    {
      xmlWriter.writeStartElement("html");
      writeHead(xmlWriter, config);
      xmlWriter.writeStartElement("body");
  
      xmlWriter.writeStartElement("h1");
      xmlWriter.writeCharacters(config.getProjectName());
      xmlWriter.writeEndElement();
  
      write(xmlWriter, config, report);
      xmlWriter.writeEndElement();
      xmlWriter.writeEndElement();
    }
  
    /**
     * Writes the HTML head with the style sheet information.
     *
     * @param xmlWriter the writer to use to write the head element.
     * @param config the configuration to access the style sheet information.
     * @throws XMLStreamException if the XML writer encountered a problem.
     */
    private void writeHead(final XMLStreamWriter xmlWriter,
        final ProjectConfiguration<XMLStreamWriter> config)
      throws XMLStreamException
    {
      final String styleSheet = config.getStyleSheet();
      if (styleSheet != null)
      {
        xmlWriter.writeStartElement("head");
 
       xmlWriter.writeStartElement("title");
       xmlWriter.writeCharacters(config.getProjectName());
       xmlWriter.writeEndElement();
 
       xmlWriter.writeStartElement("link");
       xmlWriter.writeAttribute("rel", "stylesheet");
       xmlWriter.writeAttribute("type", "text/css");
       xmlWriter.writeAttribute("href", styleSheet);
       xmlWriter.writeEndElement();
 
       xmlWriter.writeEndElement();
     }
   }
 
   /**
    * {@inheritDoc}
    */
   @Override
   protected void writeInfoHeader(final XMLStreamWriter xmlWriter,
       final ProjectConfiguration<XMLStreamWriter> config,
       final String headLine, final ExceptionCodeReportItem item) throws Exception // NOPMD
   {
     xmlWriter.writeStartElement("h2");
     if (headLine != null)
     {
       xmlWriter.writeCharacters(headLine);
     }
 
     if (headLine != null)
     {
       xmlWriter.writeCharacters(": ");
     }
     final String className = item.getDeclaringTypeName();
     xmlWriter.writeCharacters(className);
     xmlWriter.writeEndElement();
 
     final String classComment = item.getTypeComment();
     if (classComment != null)
     {
       // FIXME: This breaks if the content read is not valid XHTML...
       final CopyReader copy = new CopyReader(xmlWriter);
       xmlWriter.writeStartElement("div");
       copy.copy(classComment);
       xmlWriter.writeEndElement();
     }
   }
 
   /**
    * {@inheritDoc}
    */
   @Override
   protected void writeInfoFooter(final XMLStreamWriter xmlWriter,
       final ProjectConfiguration<XMLStreamWriter> config) throws Exception // NOPMD
   {
     xmlWriter.writeEndElement();
   }
 
   // --- object basics --------------------------------------------------------
 
 }