/*
    * Copyright 2008-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.maven.issues.bugzilla;
  
  import java.util.Locale;
  
  /**
   * The report to generate a tabular representation of issues.
   *
   * @goal bugzilla-issues-report
   * @phase site
   * @requiresProject
   * @description Generates a release plan report using issues from the issues
   *              management system rendering them in a simple table.
   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
   * @version $Revision:591 $
   */
  public class TabularReportMojo extends AbstractBugzillaReportMojo
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    // --- members --------------------------------------------------------------
  
    /**
     * Specifies the name of the file to write the issues report (without
     * extension).
     *
     * @required
     * @parameter expression="${issues.release.report.fileName}"
     *            default-value="issues-tabular-report"
     * @since 1.0
     */
    private String outputName;
  
    /**
     * The name of the class that runs the rendering of the report page.
     *
     * @required
     * @parameter default-value=
     *            "de.smartics.maven.issues.bugzilla.TabularReportRenderer"
     * @since 1.0
     */
    private String reportRenderer;
  
    /**
     * Sets the status(es) that you want to limit your report to include. Valid
     * statuses are: UNCONFIRMED, NEW, ASSIGNED, REOPENED, RESOLVED, VERIFIED, and
     * CLOSED. Multiple values can be separated by commas.
     *
     * @parameter default-value="CLOSED"
     * @since 1.0
     */
    private String status;
  
    /**
     * Lists the columns to be rendered. Each element of this list is a property
     * of an issue. The identifiers given here must match the ones defined in the
     * referenced issue management system. E.g. for Bugzilla these are defined in
     * <code>org.eclipse.mylyn.internal.bugzilla.core.BugzillaAttribute</code>.
     * <p>
     * The values are separated by comma.
     * </p>
     *
     * @parameter default-value=
     *            "bug_id,short_desc,bug_status,resolution,bug_severity"
     * @required
     * @since 1.0
     */
    private String columns;
  
    /**
     * Lists the column width to be used to set to the columns. If the value is
     * <code>0</code> (zero) no width will be set explicitly for that column.
     *
     * @parameter default-value="65,0,100,100,100"
     * @required
     * @since 1.0
     */
    private String columnWidths;
  
    /**
     * The flag to determine if only the current release version is to be rendered
     * (<code>true</code>) or all versions are to be considered (
     * <code>false</code>).
    *
    * @parameter default-value="false"
    * @required
    * @since 1.0
    */
   private boolean currentReleaseVersionOnly;
 
   // ****************************** Initializer *******************************
 
   // ****************************** Constructors ******************************
 
   // ****************************** Inner Classes *****************************
 
   // ********************************* Methods ********************************
 
   // --- init -----------------------------------------------------------------
 
   // --- get&set --------------------------------------------------------------
 
   /**
    * {@inheritDoc}
    *
    * @see org.apache.maven.reporting.MavenReport#getOutputName()
    */
   public String getOutputName()
   {
     return outputName;
   }
 
   /**
    * Returns the value for status.
    * <p>
    * Sets the status(es) that you want to limit your report to include. Valid
    * statuses are: UNCONFIRMED, NEW, ASSIGNED, REOPENED, RESOLVED, VERIFIED, and
    * CLOSED. Multiple values can be separated by commas.
    *
    * @return the value for status.
    */
   public String getStatus()
   {
     return status;
   }
 
   // ... plugin metadata ......................................................
 
   /**
    * {@inheritDoc}
    *
    * @see org.apache.maven.reporting.AbstractMavenReport#getName(java.util.Locale)
    */
   public String getName(final Locale locale)
   {
     return getTitle() != null ? getTitle() : getBundle(locale).getString(
         "report.name.release");
   }
 
   /**
    * {@inheritDoc}
    *
    * @see org.apache.maven.reporting.AbstractMavenReport#getDescription(java.util.Locale)
    */
   public String getDescription(final Locale locale)
   {
     return description != null ? description : getBundle(locale).getString(
         "report.description.release");
   }
 
   // ... report related .......................................................
 
   /**
    * Returns the name of the class that runs the rendering of the report page.
    *
    * @return the name of the class that runs the rendering of the report page.
    */
   protected String getReportRenderer()
   {
     return reportRenderer;
   }
 
   /**
    * Returns the value for columns.
    * <p>
    * Lists the columns to be rendered. Each element of this list is a property
    * of an issue. The identifiers given here must match the ones defined in the
    * referenced issue management system. E.g. for Bugzilla these are defined in
    * {@link org.eclipse.mylyn.internal.bugzilla.core.BugzillaAttribute}.
    * <p>
    * The values are separated by comma.
    * </p>
    *
    * @return the value for columns.
    */
   protected String getColumns()
   {
     return columns;
   }
 
   /**
    * Returns the value for columnWidths.
    * <p>
    * Lists the column width to be used to set to the columns. If the value is
    * <code>0</code> (zero) no width will be set explicitly for that column.
    * </p>
    *
    * @return the value for columnWidths.
    */
   protected String getColumnWidths()
   {
     return columnWidths;
   }
 
   /**
    * Returns the flag to determine if only the current release version is to be
    * rendered (<code>true</code>) or all versions are to be considered (
    * <code>false</code>).
    *
    * @return the flag to determine if only the current release version is to be
    *         rendered (<code>true</code>) or all versions are to be considered (
    *         <code>false</code>).
    */
   public boolean isCurrentReleaseVersionOnly()
   {
     return currentReleaseVersionOnly;
   }
 
   // --- business -------------------------------------------------------------
 
   // --- object basics --------------------------------------------------------
 
 }