/*
    * Copyright 2006-2012 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.util.report.link;
  
  import java.io.File;
  
  import org.apache.commons.lang.StringUtils;
  
  /**
   * Configuration information for a {@link LinkConstructorStrategy}.
   */
  public final class LinkConstructorStrategyConfig // NOPMD
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The location of the report to link to.
     */
    private final File reportLocation;
  
    /**
     * The extension to the file name to reference to. Usually this is
     * <code>html</code>.
     */
    private final String extension;
  
    /**
     * The hint to request to construct a strategy specific link part to reference
     * a member.
     */
    private final boolean referenceMember;
  
    /**
     * The key to the label to use as a label for the rendered link.
     */
    private final String labelKey;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Builder pattern.
     *
     * @param builder to information to set.
     */
    private LinkConstructorStrategyConfig(final Builder builder)
    {
      this.reportLocation = builder.reportLocation;
      this.extension = builder.extension;
      this.referenceMember = builder.referenceMember;
      this.labelKey = builder.labelKey;
    }
  
    // ****************************** Inner Classes *****************************
  
    /**
     * Builds instances of {@link LinkConstructorStrategyConfig}.
     */
    public static final class Builder
    {
      // ******************************** Fields ********************************
  
      // --- constants ----------------------------------------------------------
  
      // --- members ------------------------------------------------------------
  
      /**
       * The location of the report to link to.
       */
      private File reportLocation;
  
      /**
       * The extension to the file name to reference to. Usually this is
       * <code>html</code>.
       */
      private String extension = "html";
  
      /**
       * The hint to request to construct a strategy specific link part to
       * reference a member.
       */
     private boolean referenceMember;
 
     /**
      * The key to the label to use as a label for the rendered link.
      */
     private String labelKey;
 
     // ***************************** Initializer ******************************
 
     // ***************************** Constructors *****************************
 
     // ***************************** Inner Classes ****************************
 
     // ******************************** Methods *******************************
 
     // --- init ---------------------------------------------------------------
 
     // --- get&set ------------------------------------------------------------
 
     /**
      * Sets the location of the report to link to.
      *
      * @param reportLocation the location of the report to link to.
      */
     public void setReportLocation(final File reportLocation)
     {
       final String path = reportLocation.getPath();
       if (path.contains("..")) // Fix for BUG 622: Referencing Aggregate Reports
       {
         final String parentPath = path.replace("..", "../../../target/site");
         this.reportLocation = new File(parentPath);
       }
       else
       {
         this.reportLocation = reportLocation;
       }
     }
 
     /**
      * Sets the extension to the file name to reference to. Usually this is
      * <code>html</code>.
      *
      * @param extension the extension to the file name to reference to.
      */
     public void setExtension(final String extension)
       throws IllegalArgumentException
     {
       if (StringUtils.isBlank(extension))
       {
         throw new IllegalArgumentException("The extentsion must not be blank.");
       }
       this.extension = extension;
     }
 
     /**
      * Sets the hint to request to construct a strategy specific link part to
      * reference a member.
      *
      * @param referenceMember the hint to request to construct a strategy
      *          specific link part to reference a member.
      */
     public void setReferenceMember(final boolean referenceMember)
     {
       this.referenceMember = referenceMember;
     }
 
     /**
      * Sets the key to the label to use as a label for the rendered link.
      *
      * @param labelKey the key to the label to use as a label for the rendered
      *          link.
      */
     public void setLabelKey(final String labelKey)
     {
       if (StringUtils.isBlank(labelKey))
       {
         throw new IllegalArgumentException(
             "The label for the link must not be blank.");
       }
       this.labelKey = labelKey;
     }
 
     // --- business -----------------------------------------------------------
 
     /**
      * Creates the congfiguration instance.
      *
      * @return the congfiguration instance.
      */
     public LinkConstructorStrategyConfig build()
     {
       if (reportLocation == null)
       {
         throw new IllegalArgumentException(
             "The report location must not be 'null'");
       }
       if (StringUtils.isBlank(labelKey))
       {
         throw new IllegalArgumentException(
             "The label for the link must not be blank.");
       }
 
       return new LinkConstructorStrategyConfig(this);
     }
 
     // --- object basics ------------------------------------------------------
   }
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the location of the report to link to.
    *
    * @return the location of the report to link to.
    */
   public File getReportLocation()
   {
     return reportLocation;
   }
 
   /**
    * Returns the extension to the file name to reference to. Usually this is
    * <code>html</code>.
    *
    * @return the extension to the file name to reference to.
    */
   public String getExtension()
   {
     return extension;
   }
 
   /**
    * Returns the hint to request to construct a strategy specific link part to
    * reference a member.
    *
    * @return the hint to request to construct a strategy specific link part to
    *         reference a member.
    */
   public boolean isReferenceMember()
   {
     return referenceMember;
   }
 
   /**
    * Returns the key to the label to use as a label for the rendered link.
    *
    * @return the key to the label to use as a label for the rendered link.
    */
   public String getLabelKey()
   {
     return labelKey;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }