/*
    * Copyright 2008-2010 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.maven.artifact.versioning.ArtifactVersion;
  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.Versions.VersionedSections;
  
  /**
   * The renderer prints issue information in different sections within their
   * version. 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 class VersionedSectionReportRenderer extends
      AbstractSectionReportRenderer
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The version text to be used by template methods provided by the parent's
     * class.
     */
    protected String currentVersionString;
  
    // ****************************** 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.
     */
    public VersionedSectionReportRenderer(final RendererConfig config,
        final Sink sink, final List<TaskData> issues)
    {
      super(config, sink, issues);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
     * {@inheritDoc}
     */
    @Override
    public String getTitle()
    {
      return getTitle("report.name.release");
    }
  
    /**
     * {@inheritDoc}
     */
    @Override
    public String getDescription()
    {
      return getDescription("report.description.release");
    }
  
    /**
     * {@inheritDoc}
     */
    @Override
    public String getNoResultsDescription()
   {
     return getNoResultsDescription("report.noResultsDescription.release");
   }
 
   // --- business -------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    */
   @Override
   protected void renderBody()
   {
     sink.section1();
     final boolean noResults = issues.isEmpty();
     renderTitle(noResults);
 
     if (!noResults)
     {
       final ResourceBundle bundle = config.getBundle();
       final String versionText =
           ReportHelper.getLabel(bundle, getVersionTextId());
 
       final VersionSkipper skipper = createVersionSkipper();
       final Sectioner<Versions> sectioner = createSectioner();
       final Versions versions = sectioner.run();
       final ArtifactVersion releaseVersion = config.getCurrentReleaseVersion();
       for (VersionedSections versionedSections : versions)
       {
         final ArtifactVersion version = versionedSections.getVersion();
         if (skipper.skipVersion(releaseVersion, version))
         {
           continue;
         }
         sink.section2();
         sink.sectionTitle2();
         final String versionString = version.toString();
         this.currentVersionString = versionString;
         sink.text(versionText + ' ' + versionString);
         sink.sectionTitle2_();
 
         renderSections(versionedSections.getSections());
         sink.section2_();
       }
     }
 
     renderPreviousReportReferences();
 
     renderFooter();
     sink.section1_();
   }
 
   /**
    * Returns the arbiter to determine which versions are excluded from the
    * report.
    *
    * @return the arbiter to determine which versions are excluded from the
    *         report.
    */
   protected VersionSkipper createVersionSkipper()
   {
     return new DefaultVersionSkipper(config.getIncludeOnSamePageAllOfVersion(),
         config.getVersionRange() != null);
   }
 
   /**
    * Creates the sectioner to use.
    *
    * @return the sectioner to use.
    */
   protected Sectioner<Versions> createSectioner()
   {
     return new VersionedSectioner(config, issues);
   }
 
   /**
    * Returns the identifier part for the version text rendered in the report.
    *
    * @return the identifier part for the version text rendered in the report.
    */
   protected String getVersionTextId()
   {
     return "version.header";
   }
 
   /**
    * Renders the start of a section.
    *
    * @impl Subclasses should override this if the default level 3 is not
    *       adequate for the report.
    */
   protected void renderSectionSectionStart()
   {
     sink.section3();
   }
 
   /**
    * Renders the end of a section.
    *
    * @impl Subclasses should override this if the default level 3 is not
    *       adequate for the report.
    */
   protected void renderSectionSectionEnd()
   {
     sink.section3_();
   }
 
   /**
    * Renders the start of a section title.
    *
    * @impl Subclasses should override this if the default level 3 is not
    *       adequate for the report.
    */
   protected void renderSectionTitleStart()
   {
     sink.sectionTitle3();
   }
 
   /**
    * Renders the end of a section title.
    *
    * @impl Subclasses should override this if the default level 3 is not
    *       adequate for the report.
    */
   protected void renderSectionTitleEnd()
   {
     sink.sectionTitle3_();
   }
 
   /**
    * 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.versioned", sectionId,
         currentVersionString);
   }
 
   // --- object basics --------------------------------------------------------
 
 }