/*
    * 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 java.util.List;
  import java.util.ResourceBundle;
  
  import javax.xml.stream.XMLStreamException;
  import javax.xml.stream.XMLStreamWriter;
  
  import org.apache.commons.lang.StringUtils;
  
  import de.smartics.exceptions.core.Code;
  import de.smartics.exceptions.report.app.ReportException;
  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.renderer.html.HtmlRendererFactory;
  import de.smartics.exceptions.report.utils.CopyReader;
  
  /**
   * Simple generator that generates a HTML file for exception codes.
   */
  public class HtmlReportGenerator extends AbstractHtmlReportGenerator
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @see AbstractHtmlReportGenerator#AbstractHtmlReportGenerator()
     */
    public HtmlReportGenerator()
    {
      super(new JavadocRenderer(new HtmlRendererFactory()));
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     */
    @Override
    protected void writeTableHeader(final XMLStreamWriter xmlWriter,
        final ProjectConfiguration<XMLStreamWriter> config)
      throws XMLStreamException
    {
      xmlWriter.writeStartElement("table");
      xmlWriter.writeStartElement("tr");
  
      final ResourceBundle bundle = config.getBundle();
      final String codeLabel =
          StringFunction.getMessage(bundle,
              "report.exceptioncode.item.reportElement", "Code");
      xmlWriter.writeStartElement("th");
      xmlWriter.writeCharacters(codeLabel);
      xmlWriter.writeEndElement();
  
      final String propertyNameLabel =
          StringFunction.getMessage(bundle,
              "report.exceptioncode.item.propertyName", "Property Name");
      xmlWriter.writeStartElement("th");
      xmlWriter.writeCharacters(propertyNameLabel);
      xmlWriter.writeEndElement();
  
      final String descriptionLabel =
          StringFunction.getMessage(bundle,
              "report.exceptioncode.item.description", "Description");
      xmlWriter.writeStartElement("th");
     xmlWriter.writeCharacters(descriptionLabel);
     xmlWriter.writeEndElement();
 
     xmlWriter.writeEndElement();
   }
 
   /**
    * {@inheritDoc}
    */
   @Override
   protected void writeReportElementInfo(final XMLStreamWriter xmlWriter,
       final ProjectConfiguration<XMLStreamWriter> config,
       final ExceptionCodeReportItem item) throws Exception
   {
     xmlWriter.writeStartElement("tr");
 
     final Code instance = item.getCode();
 
     xmlWriter.writeStartElement("td");
     xmlWriter.writeAttribute("style", "white-space: nowrap;");
     xmlWriter.writeCharacters(String.valueOf(instance));
     xmlWriter.writeEndElement();
 
     xmlWriter.writeStartElement("td");
     xmlWriter.writeAttribute("style", "white-space: nowrap;");
     xmlWriter.writeCharacters(item.getName());
     xmlWriter.writeEndElement();
 
     xmlWriter.writeStartElement("td");
     final String javadoc = this.renderer.render(item.getJavadoc());
     if (StringUtils.isNotBlank(javadoc))
     {
       // FIXME: This breaks if the content read is not valid XHTML...
       final CopyReader copy = new CopyReader(xmlWriter);
       copy.copy(javadoc);
     }
     xmlWriter.writeEndElement();
     xmlWriter.writeEndElement();
   }
 
   @Override
   public void writeReport(final ProjectConfiguration<XMLStreamWriter> config,
       final StoredExceptionCodesReport report) throws ReportException
   {
     // Do nothing
   }
 
   @Override
   protected List<ExceptionCodeReportItem> getItems(
       final StoredExceptionCodesReport report)
   {
     return report.getItems();
   }
 
   @Override
   protected boolean hasSectionChanged(final String currentSection,
       final ExceptionCodeReportItem item)
   {
     return !item.getDeclaringTypeName().equals(currentSection);
   }
 
   @Override
   protected String getCurrentSelection(final ExceptionCodeReportItem item)
   {
     return item.getDeclaringTypeName();
   }
 
   @Override
   protected String getCodeTitle(final String headLine,
       final ExceptionCodeReportItem item)
   {
     final String title;
     if (headLine != null)
     {
       title = headLine;
     }
     else
     {
       final String componentId = item.getCode().getComponentId();
       if (StringUtils.isNotBlank(componentId))
       {
         title = componentId;
       }
       else
       {
         final String className = item.getDeclaringTypeName();
         title = className;
       }
     }
 
     return title;
   }
 
   // --- object basics --------------------------------------------------------
 
 }