/*
    * Copyright 2010-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.testdoc.maven.export.sink;
  
  import java.io.IOException;
  import java.util.List;
  import java.util.Set;
  
  import de.smartics.maven.util.report.MessageHelper;
  import de.smartics.testdoc.core.doc.Type;
  import de.smartics.testdoc.core.doc.UnitTestDoc;
  import de.smartics.testdoc.report.export.doc.InformationFilter;
  import de.smartics.testdoc.report.index.ExportIndex;
  import de.smartics.testdoc.report.index.ExportMultiIndex;
  import de.smartics.testdoc.report.index.Section;
  
  /**
   * Renders the page with the test documentation.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  class TestDocPageRenderer extends AbstractPageRenderer
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The exporter that knows the format of the file to be written.
     */
    protected final SinkExporter exporter;
  
    /**
     * Helper for rendering page parts.
     */
    private final RenderHelper helper;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param reportName
     * @param messages the resource bundles with messages to display as labels in
     *          the generated report.
     * @param informationFilter the configuration that tells which report
     *          information is to be displayed.
     * @param exporter the exporter that knows the format of the file to be
     *          written.
     */
    TestDocPageRenderer(final String reportName, final MessageHelper messages,
        final SinkExporter exporter)
    {
      super(reportName, messages, exporter.getSink());
      this.exporter = exporter;
      this.helper = new RenderHelper(messages, sink);
  
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    void renderPage(final ExportMultiIndex index, final Set<UnitTestDoc> testDocs)
      throws IOException
    {
      renderPageStart();
      renderBody(index, testDocs);
      renderPageEndAndFinalize();
    }
  
    private void renderBody(final ExportMultiIndex index,
        final Set<UnitTestDoc> testDocs) throws IOException
    {
      renderBodyStart();
 
     renderIndexes(index);
     for (final Section<UnitTestDoc> section : index.getSection()
         .getSubSections())
     {
       renderSections(section, 2);
     }
     renderTestDocs(testDocs);
 
     renderBodyEnd();
   }
 
   private void renderIndexes(final ExportMultiIndex index)
   {
     renderIndexOfIndexes(index);
 
     final Section<UnitTestDoc> section = index.getSection();
     for (final Section<UnitTestDoc> subSection : section.getSubSections())
     {
       renderSectionIndex(subSection);
     }
   }
 
   private void renderIndexOfIndexes(final ExportMultiIndex index)
   {
     final InformationFilter filter = exporter.getInformationFilter();
     if (filter.isShowIndexOfIndices() && !index.isEmpty())
     {
       sink.section2();
 
       sink.anchor("indexOfIndexes");
       sink.anchor_();
       sink.sectionTitle2();
       sink.text(messages.getLabel("report.indexOfIndexes"));
       sink.sectionTitle2_();
 
       helper.renderIndexTableStart();
       int counter = 1;
       for (final ExportIndex exportIndex : index.getIndexes())
       {
         if (!exportIndex.isEmpty())
         {
           final String name = exportIndex.getSectionName();
           final String label = messages.getLabel(name);
           helper.renderIndexRow(counter, label);
           counter++;
         }
       }
       helper.renderIndexTableEnd();
 
       sink.section2_();
     }
   }
 
   private void renderSectionIndex(final Section<UnitTestDoc> section)
   {
     final List<Section<UnitTestDoc>> subSections = section.getSubSections();
     if (!subSections.isEmpty())
     {
       sink.section3();
 
       final String id = section.getName();
       helper.renderAnchor(id);
       sink.sectionTitle3();
       sink.text(messages.getLabel("index." + id));
       sink.sectionTitle3_();
 
       helper.renderIndexTableStart();
       int counter = 1;
       for (final Section<UnitTestDoc> subSection : subSections)
       {
         final String name = subSection.getName();
         helper.renderIndexRow(counter, name);
         counter++;
       }
       helper.renderIndexTableEnd();
 
       sink.section3_();
     }
   }
 
   private void renderSections(final Section<UnitTestDoc> section,
       final int level)
   {
     final String name = section.getName();
     final String sectionLabel = messages.getLabel(name);
     helper.renderSectionStart(level, sectionLabel);
 
     if (!section.containsSubSections())
     {
       helper.renderIndexTableStart();
       int counter = 1;
       for (final UnitTestDoc testDoc : section.getItems())
       {
         final Type type = testDoc.getUutType();
         final String label = type.getTypeName();
         final String id = type.toString();
         helper.renderIndexRow(counter, label, id);
         counter++;
       }
       helper.renderIndexTableEnd();
     }
     else
     {
       final int nextLevel = level + 1;
       for (final Section<UnitTestDoc> subSection : section.getSubSections())
       {
         renderSections(subSection, nextLevel);
       }
     }
 
     helper.renderSectionEnd(level);
   }
 
   private void renderTestDocs(final Set<UnitTestDoc> testDocs)
     throws IOException
   {
     sink.section2();
 
     helper.renderAnchor("unitTestDoc");
     sink.sectionTitle2();
     sink.text(messages.getLabel("report.unitTestDoc"));
     sink.sectionTitle2_();
 
     for (final UnitTestDoc testDoc : testDocs)
     {
       exporter.export(testDoc);
     }
 
     sink.section2_();
   }
 
   // --- object basics --------------------------------------------------------
 
 }