/*
    * 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 de.smartics.testdoc.core.doc.UnitTestDoc;
  import de.smartics.testdoc.core.doc.UnitTestDocNaturalComparator;
  import de.smartics.testdoc.report.junit.JUnitTestCaseManager;
  
  /**
   * The configuration to control the generation of the report. This is simply a
   * tool to pass the configuration information from the client (e.g. a Maven
   * plugin) to the generator.
   *
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public final class ReportConfig
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * The category classes of test scenarios that should be included or not.
     */
    private final SelectionFilter selectionFilter;
  
    /**
     * The configuration that tells which report information is to be displayed.
     */
    private final InformationFilter informationFilter;
  
    /**
     * The manager to access JUnit report information. Is <code>null</code> if the
     * information is not to be included.
     */
    private final JUnitTestCaseManager junitManager;
  
    /**
     * The configuration of links to images used in reports.
     */
    private final ImageHelper imageHelper;
  
    /**
     * The external reports to reference to.
     */
    private final ExternalReportReferences reports;
  
    /**
     * The comparator to use to sort the rendering of unit test documentation.
     */
    private final Comparator<UnitTestDoc> unitTestDocComparator;
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor with default values for structures not needed for
     * non visual reports.
     */
    public ReportConfig()
    {
      this(SelectionFilter.STANDARD, InformationFilter.SHOW_DEFAULTS, null,
          new ImageHelper(null), ExternalReportReferences.EMPTY,
          new UnitTestDocNaturalComparator());
    }
  
    /**
     * Default constructor.
     *
     * @param selectionFilter the category classes of test scenarios that should
     *          be included or not.
     * @param informationFilter the configuration that tells which report
     *          information is to be displayed.
     * @param junitManager the manager to access JUnit report information.
     * @param imageHelper the configuration of links to images used in reports.
     * @param reports the external reports to reference to.
     * @param unitTestDocComparator the comparator to use to sort the rendering of
     *          unit test documentation.
     */
    public ReportConfig(final SelectionFilter selectionFilter,
       final InformationFilter informationFilter,
       final JUnitTestCaseManager junitManager, final ImageHelper imageHelper,
       final ExternalReportReferences reports,
       final Comparator<UnitTestDoc> unitTestDocComparator)
   {
     this.selectionFilter = selectionFilter;
     this.informationFilter = informationFilter;
     this.junitManager = junitManager;
     this.imageHelper = imageHelper;
     this.reports = reports;
     this.unitTestDocComparator = unitTestDocComparator;
   }
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * Returns the category classes of test scenarios that should be filtered.
    *
    * @return the category classes of test scenarios that should be filtered.
    */
   public SelectionFilter getSelectionFilter()
   {
     return selectionFilter;
   }
 
   /**
    * 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 informationFilter;
   }
 
   /**
    * 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 junitManager;
   }
 
   /**
    * Returns the configuration of links to images used in reports.
    *
    * @return the configuration of links to images used in reports.
    */
   public ImageHelper getImageHelper()
   {
     return imageHelper;
   }
 
   /**
    * Returns the external reports to reference to.
    *
    * @return the external reports to reference to.
    */
   public ExternalReportReferences getReports()
   {
     return reports;
   }
 
   /**
    * 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 unitTestDocComparator;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }