/*
    * 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 org.apache.maven.doxia.sink.Sink;
  
  import de.smartics.maven.util.report.MessageHelper;
  
  /**
   * Helper to render parts of a Sink page.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  class RenderHelper
  { // NOPMD
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The resource bundles with messages to display as labels in the generated
     * report.
     */
    private final MessageHelper messages;
  
    /**
     * The output medium to write to.
     */
    private final Sink sink;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Default constructor.
     *
     * @param messages the resource bundles with messages to display as labels in
     *          the generated report.
     * @param sink the output medium to write to.
     */
    public RenderHelper(final MessageHelper messages, final Sink sink)
    {
      this.messages = messages;
      this.sink = sink;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    void renderIndexTableStart()
    {
      sink.table();
      sink.tableRow();
      sink.tableHeaderCell(messages.getLabel("report.table.header.counter.width"));
      final String topicLabel = messages.getLabel("report.table.header.counter");
      sink.text(topicLabel);
      sink.tableHeaderCell_();
      sink.tableHeaderCell();
      final String valueLabel = messages.getLabel("report.table.header.index");
      sink.text(valueLabel);
      sink.tableHeaderCell_();
      sink.tableRow_();
    }
  
    void renderIndexRow(final int counter, final String label, final String id)
    {
      sink.tableRow();
      sink.tableCell();
      sink.text(String.valueOf(counter));
      sink.tableCell_();
      sink.tableCell();
      renderInPageLink(label, id);
      sink.tableCell_();
      sink.tableRow_();
    }
 
   void renderIndexRow(final int counter, final String content)
   {
     renderIndexRow(counter, content, content);
   }
 
   void renderIndexTableEnd()
   {
     sink.table_();
   }
 
   void renderInPageLink(final String id)
   {
     final String label = messages.getLabel(id);
     renderInPageLink(label, id);
   }
 
   void renderInPageLink(final String label, final String id)
   {
     final String link = '#' + normalizeKey(id);
     renderLink(label, link);
   }
 
   void renderLink(final String label, final String link)
   {
     sink.link(link);
     sink.text(label);
     sink.link_();
   }
 
   void renderAnchor(final String id)
   {
     final String normalized = normalizeKey(id);
     sink.anchor(normalized);
     sink.anchor_();
   }
 
   /**
    * Normalizes the key to an issue information to be a valid key element to
    * render as anchor name.
    *
    * @param key the key to normalize.
    * @return the normalized key.
    */
   public static String normalizeKey(final String key)
   {
     if (key == null || "".equals(key))
     {
       return key;
     }
 
     final char[] trimmed = key.trim().toCharArray();
     boolean uppercase = false;
     int currentPos = 0;
     for (int i = 0; i < trimmed.length; i++, currentPos++)
     {
       final char c = trimmed[i];
       if (Character.isWhitespace(c))
       {
         uppercase = true;
         --currentPos;
       }
       else if (uppercase)
       {
         trimmed[currentPos] = Character.toUpperCase(c);
         uppercase = false;
       }
       else
       {
         trimmed[currentPos] = c;
       }
     }
 
     return new String(trimmed).substring(0, currentPos);
   }
 
   void renderSectionStart(final int level, final String name)
   {
     renderSectionStart(level);
 
     renderAnchor(name);
     renderSectionTitle(level, name);
   }
 
   private void renderSectionTitle(final int level, final String name)
   {
     switch (level)
     {
       case 1:
         sink.sectionTitle1();
         sink.text(name);
         sink.sectionTitle1_();
         break;
       case 2:
         sink.sectionTitle2();
         sink.text(name);
         sink.sectionTitle2_();
         break;
       case 3:
         sink.sectionTitle3();
         sink.text(name);
         sink.sectionTitle3_();
         break;
       case 4:
         sink.sectionTitle4();
         sink.text(name);
         sink.sectionTitle4_();
         break;
       case 5:
         sink.sectionTitle5();
         sink.text(name);
         sink.sectionTitle5_();
         break;
       default:
         sink.sectionTitle5();
         sink.text(name);
         sink.sectionTitle5_();
         break;
     }
   }
 
   private void renderSectionStart(final int level)
   {
     switch (level)
     {
       case 1:
         sink.section1();
         break;
       case 2:
         sink.section2();
         break;
       case 3:
         sink.section3();
         break;
       case 4:
         sink.section4();
         break;
       case 5:
         sink.section5();
         break;
       default:
         sink.section5();
         break;
     }
   }
 
   void renderSectionEnd(final int level)
   {
     switch (level)
     {
       case 1:
         sink.section1_();
         break;
       case 2:
         sink.section2_();
         break;
       case 3:
         sink.section3_();
         break;
       case 4:
         sink.section4_();
         break;
       case 5:
         sink.section5_();
         break;
       default:
         sink.section5_();
         break;
     }
   }
 
   // --- object basics --------------------------------------------------------
 
 }