/*
    * Copyright 2007-2011 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;
  
  import java.util.ResourceBundle;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.maven.doxia.sink.Sink;
  
  import com.sun.javadoc.ClassDoc;
  import com.sun.javadoc.FieldDoc;
  
  import de.smartics.analysis.javadoc.render.JavadocRenderer;
  import de.smartics.analysis.javadoc.render.html.HtmlRendererFactory;
  import de.smartics.analysis.javadoc.runtime.RuntimeUtils;
  import de.smartics.exceptions.core.Code;
  import de.smartics.exceptions.report.generator.StringFunction;
  import de.smartics.report.conf.ProjectConfiguration;
  import de.smartics.report.conf.ReportData;
  import de.smartics.report.generator.AbstractOutputReportGenerator;
  
  /**
   * Simple generator that generates with a Maven sink.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public abstract class AbstractSinkReportGenerator extends
      AbstractOutputReportGenerator
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    protected AbstractSinkReportGenerator()
    {
      super(new JavadocRenderer(new HtmlRendererFactory()));
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
     * Makes the cast.
     *
     * @param sink the instance to cast.
     * @return the sink with the concrete type.
     */
    protected Sink toSink(final Object sink)
    {
      return (Sink) sink;
    }
  
    // --- business -------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     */
    protected void writeReportElementInfo(
        final Object output,
        final ProjectConfiguration config,
        final FieldDoc fieldDoc) throws Exception
    {
      final Sink sink = toSink(output);
  
      sink.tableRow();
  
      // TODO: Check to optimize that class is not loaded for every constant but
      // provided once to be accessed by each constant...
      final Code instance =
          (Code) RuntimeUtils.loadInstance(config.getProjectClassLoader(),
              fieldDoc);
 
     sink.tableCell();
     sink.text(String.valueOf(String.valueOf(instance)));
     sink.tableCell_();
 
     sink.tableCell();
     sink.text(fieldDoc.name());
     sink.tableCell_();
 
     sink.tableCell();
 
     final String javadoc = this.renderer.render(fieldDoc);
     if (StringUtils.isNotBlank(javadoc))
     {
       sink.rawText(javadoc);
     }
     else
     {
       sink.rawText("&nbsp;");
     }
     sink.tableCell_();
 
     sink.tableRow_();
   }
 
   /**
    * {@inheritDoc}
    */
   protected void writeContent(
       final Object output,
       final ProjectConfiguration config,
       final ReportData reportData) throws Exception // NOPMD
   {
     final Sink sink = toSink(output);
 
     final ResourceBundle bundle = config.getBundle();
     final String title = bundle.getString("report.name");
     sink.head();
     sink.title();
     sink.text(title);
     sink.title_();
     sink.head_();
 
     sink.body();
     sink.section1();
 
     sink.sectionTitle1();
     sink.text(title);
     sink.sectionTitle1_();
 
     sink.text(bundle.getString("report.description"));
     sink.lineBreak();
 
     if (!reportData.isEmpty())
     {
       write(output, config, reportData);
     }
     else
     {
       sink.lineBreak();
       sink.lineBreak();
       sink.text(bundle.getString("report.noElementsFound"));
     }
 
     sink.section1_();
     sink.body_();
     sink.flush();
     sink.close();
   }
 
   /**
    * {@inheritDoc}
    */
   protected void writeInfoFooter(
       final Object output,
       final ProjectConfiguration config) throws Exception // NOPMD
   {
     final Sink sink = toSink(output);
     sink.section2_();
   }
 
   protected void writeInfoSubFooter(
       final Object output,
       final ProjectConfiguration config) throws Exception // NOPMD
   {
     final Sink sink = toSink(output);
     sink.table_();
     sink.section3_();
   }
 
   /**
    * Writes the header and introduction text on a section 2.
    * <p>
    * If no <code>headLine</code> is given, the qualified class name is written
    * as section title instead.
    * </p>
    *
    * @param output the output to write to.
    * @param config not used in this implementation.
    * @param headLine the text for the section header. May be <code>null</code>.
    * @param classDoc the type information to render if <code>headLine</code> is
    *          <code>null</code> as section header and its comment to render as
    *          introduction text.
    * @throws Exception on any problem encountered.
    */
   protected void writeInfoHeader(
       final Object output,
       final ProjectConfiguration config,
       final String headLine,
       final ClassDoc classDoc) throws Exception // NOPMD
   {
     final Sink sink = toSink(output);
 
     sink.section2();
     sink.sectionTitle2();
     if (headLine != null)
     {
       sink.text(headLine);
     }
     else
     {
       final String className = classDoc.qualifiedName();
       sink.text(className);
     }
 
     final String classComment = classDoc.commentText();
     sink.sectionTitle2_();
 
     if (classComment != null)
     {
       sink.rawText(classComment);
     }
   }
 
   /**
    * {@inheritDoc}
    */
   protected void writeInfoSubHeader(
       final Object output,
       final ProjectConfiguration config,
       final String subHeader)
   {
     final Sink sink = toSink(output);
     // The section3 increased the space which displays ugly...
     sink.section3();
     sink.sectionTitle3();
     sink.text(subHeader);
     sink.sectionTitle3_();
   }
 
   /**
    * Writes the table header.
    *
    * @param output the output to write to.
    * @param config the project configuration to control the output.
    */
   protected void writeTableHeader(
       final Object output,
       final ProjectConfiguration config)
   {
     final Sink sink = toSink(output);
     sink.table();
     sink.tableRow();
 
     final ResourceBundle bundle = config.getBundle();
     sink.tableHeaderCell("100");
     final String codeLabel =
         StringFunction.getMessage(bundle,
             "report.exceptioncodes.item.reportElement", "Code");
     sink.text(codeLabel);
     sink.tableHeaderCell_();
 
     sink.tableHeaderCell("150");
     final String propertyNameLabel =
         StringFunction.getMessage(bundle,
             "report.exceptioncodes.item.propertyName", "Property Name");
     sink.text(propertyNameLabel);
     sink.tableHeaderCell_();
 
     sink.tableHeaderCell();
     final String descriptionLabel =
         StringFunction.getMessage(bundle,
             "report.exceptioncodes.item.description", "Description");
     sink.text(descriptionLabel);
     sink.tableHeaderCell_();
 
     sink.tableRow_();
   }
 
   /**
    * {@inheritDoc}
    */
   protected void writeFooter(
       final Object output,
       final ProjectConfiguration config)
   {
   }
 
   // --- object basics --------------------------------------------------------
 
 }