/*
    * 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.report.export.doc;
  
  import java.util.Comparator;
  import java.util.List;
  
  import org.apache.commons.lang.NullArgumentException;
  
  import de.smartics.testdoc.core.doc.ScenarioTestDoc;
  import de.smartics.testdoc.core.doc.UnitTestDoc;
  import de.smartics.testdoc.core.doc.UnitTestDocIndex;
  import de.smartics.testdoc.report.junit.JUnitTestCaseManager;
  
  /**
   * Helper to access test documentation information and provides access to
   * configuration information.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public class TestDocHelper
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The index of test documentation. May be <code>null</code>, if no index is
     * requested.
     */
    private final UnitTestDocIndex index;
  
    /**
     * The configuration to control the generation of the report.
     */
    private final ReportConfig config;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor to create an instance with a filter that accepts
     * all categories and shows defaults.
     *
     * @param index the index of test documentation.
     */
    public TestDocHelper(final UnitTestDocIndex index)
    {
      this(index, new ReportConfig());
    }
  
    /**
     * Default constructor.
     *
     * @param index the index of test documentation.
     * @param config the configuration to control the generation of the report.
     * @throws NullArgumentException if <code>config</code> is <code>null</code>.
     */
    public TestDocHelper(final UnitTestDocIndex index, final ReportConfig config)
      throws NullArgumentException
    {
      if (config == null)
      {
        throw new NullArgumentException("config");
      }
      this.index = index;
      this.config = config;
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    /**
     * Returns the index of test documentation. May be <code>null</code>, if no
     * index is requested.
     *
     * @return the index of test documentation.
    */
   public UnitTestDocIndex getIndex()
   {
     return index;
   }
 
   /**
    * Checks if test documentation information is provided.
    *
    * @return <code>true</code> if test documentation is provided,
    *         <code>false</code> otherwise.
    */
   public boolean isIndexProvided()
   {
     return index != null && !index.isEmpty();
   }
 
   /**
    * Returns the configuration that tells which report information is to be
    * displayed.
    *
    * @return the configuration that tells which report information is to be
    *         displayed.
    */
   public InformationFilter getInformationFilter()
   {
     return config.getInformationFilter();
   }
 
   /**
    * Returns the manager to access JUnit report information. Is
    * <code>null</code> if the information is not to be included.
    *
    * @return the manager to access JUnit report information.
    */
   public JUnitTestCaseManager getJunitManager()
   {
     return config.getJunitManager();
   }
 
   /**
    * Returns the comparator to use to sort the rendering of unit test
    * documentation.
    *
    * @return the comparator to use to sort the rendering of unit test
    *         documentation.
    */
   public Comparator<UnitTestDoc> getUnitTestDocComparator()
   {
     return config.getUnitTestDocComparator();
   }
 
   /**
    * Checks whether or not to include JUnit report information.
    *
    * @return <code>true</code> if the information is requested to be included,
    *         <code>false</code> if it should be omitted.
    */
   public boolean isJUnitReportInformationRequested()
   {
     return config.getJunitManager() != null;
   }
 
   /**
    * Returns the configuration of links to images used in reports.
    *
    * @return the configuration of links to images used in reports.
    */
   public ImageHelper getImageHelper()
   {
     return config.getImageHelper();
   }
 
   /**
    * Returns the external reports to reference to.
    *
    * @return the external reports.
    */
   public ExternalReportReferences getReports()
   {
     return config.getReports();
   }
 
   /**
    * Filters the given categories according the the given report configuration.
    *
    * @param categories the categories to be filtered.
    * @return a copy of the given <code>categories</code> containing only those
    *         categories that are accepted.
    */
   public List<String> filter(final List<String> categories)
   {
     return config.getSelectionFilter().filterCategories(categories);
   }
 
   /**
    * Filters scenarios by their categories according the the given report
    * configuration.
    *
    * @param scenarios the scenarios to filter.
    * @return the filtered scenarios.
    */
   public List<ScenarioTestDoc> filterScenarios(
       final List<ScenarioTestDoc> scenarios)
   {
     return config.getSelectionFilter().filterScenarios(scenarios);
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }