/*
    * Copyright 2008-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.issues.bugzilla;
  
  import java.util.List;
  import java.util.ResourceBundle;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.maven.doxia.sink.Sink;
  import org.eclipse.mylyn.tasks.core.data.TaskData;
  
  import de.smartics.maven.issues.RendererConfig;
  import de.smartics.maven.issues.bugzilla.Sections.Section;
  import de.smartics.maven.issues.util.ReportReference;
  
  /**
   * The renderer prints issue information in different sections. The sections are
   * defines by the key {@link RendererConfig#getSectionType()} and are selected
   * and ordered by {@link RendererConfig#getSections()}.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   */
  public abstract class AbstractSectionReportRenderer extends
      AbstractIssuesReportRenderer
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * Reference to the logger for this class.
     */
    private static final Log LOG = LogFactory
        .getLog(AbstractSectionReportRenderer.class);
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param config the configuration to control the rendering process.
     * @param sink the sink to write to.
     * @param issues the issue information to render in the report.
     */
    protected AbstractSectionReportRenderer(final RendererConfig config,
        final Sink sink, final List<TaskData> issues)
    {
      super(config, sink, issues);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     */
    @Override
    protected void renderBody()
    {
      sink.section1();
      final boolean noResults = issues.isEmpty();
      renderTitle(noResults);
  
      if (!noResults)
      {
        final SimpleSectioner sectioner = new SimpleSectioner(config, issues);
        final Sections sections = sectioner.run();
        renderSections(sections);
      }
  
      renderPreviousReportReferences();
  
      renderFooter();
      sink.section1_();
   }
 
   /**
    * Renders references to previous release reports.
    */
   protected void renderPreviousReportReferences()
   {
     final List<ReportReference> refs = config.getReportReferences();
     if (refs != null && !refs.isEmpty())
     {
       sink.section2();
       renderSectionHeader("previousReleases");
       sink.list();
       for (ReportReference ref : refs)
       {
         sink.listItem();
         ReportHelper.renderLink(sink, ref.getUrl(), ref.getLabel());
         sink.listItem_();
       }
       sink.list_();
       sink.section2_();
     }
   }
 
   /**
    * Renders the sections.
    *
    * @param sections the sections to be rendered.
    */
   protected void renderSections(final Sections sections)
   {
     for (Section section : sections)
     {
       final String sectionId = section.getSectionName();
       final List<TaskData> sectionIssues = section.getTasks();
       if (!sectionIssues.isEmpty())
       {
         renderSectionSectionStart();
         renderSectionHeader(sectionId);
         sink.table();
         renderTableHeader();
         for (TaskData issue : sectionIssues)
         {
           renderTableRow(issue);
         }
         sink.table_();
         renderSectionSectionEnd();
       }
       else
       {
         if (LOG.isDebugEnabled())
         {
           LOG.debug("No issues for section '" + sectionId + "' found.");
         }
       }
     }
   }
 
   /**
    * Renders the section header.
    *
    * @param sectionId the identifier (an attribute key of the issue management
    *          system) of the section.
    */
   protected void renderSectionHeader(final String sectionId)
   {
     final ResourceBundle bundle = config.getBundle();
     final String sectionLabel =
         ReportHelper.getLabel(bundle, "section", sectionId);
     renderSectionTitleStart();
     sink.text(sectionLabel);
     renderSectionTitleEnd();
 
     final String sectionText = getSectionText(bundle, sectionId);
     sink.paragraph();
     sink.text(sectionText);
     sink.paragraph_();
   }
 
   /**
    * Returns the introduction text after the section title.
    *
    * @param bundle the resource bundle to use.
    * @param sectionId the identifier (an attribute key of the issue management
    *          system) of the section.
    * @return the localized text to render.
    */
   protected String getSectionText(final ResourceBundle bundle,
       final String sectionId)
   {
     return ReportHelper.getLabel(bundle, "section.text.unversioned", sectionId);
   }
 
   /**
    * Renders the start of a section.
    *
    * @impl Subclasses should override this if the default level 2 is not
    *       adequate for the report.
    */
   protected void renderSectionSectionStart()
   {
     sink.section2();
   }
 
   /**
    * Renders the end of a section.
    *
    * @impl Subclasses should override this if the default level 2 is not
    *       adequate for the report.
    */
   protected void renderSectionSectionEnd()
   {
     sink.section2_();
   }
 
   /**
    * Renders the start of a section title.
    *
    * @impl Subclasses should override this if the default level 2 is not
    *       adequate for the report.
    */
   protected void renderSectionTitleStart()
   {
     sink.sectionTitle2();
   }
 
   /**
    * Renders the end of a section title.
    *
    * @impl Subclasses should override this if the default level 2 is not
    *       adequate for the report.
    */
   protected void renderSectionTitleEnd()
   {
     sink.sectionTitle2_();
   }
 
   // --- object basics --------------------------------------------------------
 
 }