/*
    * 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.report;
  
  import java.util.Collection;
  import java.util.Iterator;
  import java.util.List;
  
  import org.apache.commons.lang.ObjectUtils;
  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.exceptions.code.NumberCode;
  import de.smartics.exceptions.core.Code;
  import de.smartics.exceptions.report.sort.CodeUtils;
  import de.smartics.exceptions.report.sort.MixedCodeComparator;
  import de.smartics.exceptions.report.sort.CodeUtils.CodeContainer;
  import de.smartics.maven.exceptions.AbstractSinkReportGenerator;
  import de.smartics.report.conf.ProjectConfiguration;
  import de.smartics.report.conf.ReportData;
  import de.smartics.report.util.JavadocUtils;
  
  /**
   * Simple generator that generates with a Maven sink. This interfaces as Java
   * 1.4 code.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public class CodeSortedSinkReportGenerator extends AbstractSinkReportGenerator
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     */
    public CodeSortedSinkReportGenerator()
    {
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * Writes the content of the report data to the stream.
     *
     * @param output the writer to write to.
     * @param config the project configuration to control the output.
     * @param reportData the report information to write.
     * @throws Exception on any problem encountered.
     */
    protected void write(final Object output, final ProjectConfiguration config,
        final ReportData reportData) throws Exception // NOPMD
    {
      final Sink sink = toSink(output);
      final Collection javadocs = reportData.getJavadocs();
  
      final List codeContainerList =
          CodeUtils.getCodeList(config, javadocs, new MixedCodeComparator());
  
      writeHeader(output, config);
      String currentComponentId = null;
      String currentCodeMajorNumber = null;
      boolean firstTime = true;
      for (final Iterator i = codeContainerList.iterator(); i.hasNext();)
      {
        boolean headerChanged = false;
        final CodeContainer codeContainer = (CodeContainer) i.next();
       final ClassDoc classDoc = codeContainer.getClassDoc();
       final FieldDoc fieldDoc = codeContainer.getFieldDoc();
       final Code code = codeContainer.getCode();
 
       final String componentId = code.getComponentId();
       if (!ObjectUtils.equals(currentComponentId, componentId))
       {
         if (!firstTime)
         {
           writeInfoSubFooter(output, config);
           writeInfoFooter(output, config);
         }
         firstTime = false;
         writeInfoHeader(output, config, componentId, classDoc);
         currentComponentId = componentId;
         headerChanged = true;
       }
 
       if (code instanceof NumberCode)
       {
         final NumberCode numberCode = (NumberCode) code;
         final String codeMajorNumber =
             String.valueOf(numberCode.getMajorNumber());
         if (!ObjectUtils.equals(currentCodeMajorNumber, codeMajorNumber))
         {
           if (!headerChanged)
           {
             writeInfoSubFooter(output, config);
           }
           writeInfoSubHeader(output, config, codeMajorNumber);
           currentCodeMajorNumber = codeMajorNumber;
           headerChanged = true;
         }
       }
       else if (currentCodeMajorNumber != null)
       {
         currentCodeMajorNumber = null; // NOPMD
         if (!headerChanged)
         {
           writeInfoSubHeader(output, config, "-----");
           headerChanged = true;
         }
       }
 
       if (headerChanged)
       {
         final String relDir = config.getJavadocRelativeDir();
         if (relDir != null)
         {
           sink.paragraph();
 
           final String className = classDoc.qualifiedName();
           final String path = JavadocUtils.expandJavadocUrl(relDir, className);
           sink.link(path);
           sink.text(className);
           sink.link_();
           sink.paragraph_();
         }
 
         final String message = classDoc.commentText();
         if (!StringUtils.isBlank(message))
         {
           sink.paragraph();
           sink.text(message);
           sink.paragraph_();
         }
 
         writeTableHeader(output, config);
       }
 
       writeReportElementInfo(output, config, fieldDoc);
     }
 
     writeInfoSubFooter(output, config);
     writeInfoFooter(output, config);
     writeFooter(output, config);
   }
 
   // --- object basics --------------------------------------------------------
 
 }