de.smartics.maven.issues.bugzilla
Class TabularReportMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.reporting.AbstractMavenReport
          de.smartics.maven.issues.AbstractReportMojo
              de.smartics.maven.issues.AbstractIssuesConnectionMojo
                  de.smartics.maven.issues.AbstractIssuesReportMojo
                      de.smartics.maven.issues.bugzilla.AbstractBugzillaReportMojo
                          de.smartics.maven.issues.bugzilla.TabularReportMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, MavenReport

public class TabularReportMojo
     
     

      
      extends 
      
      AbstractBugzillaReportMojo
     
     

The report to generate a tabular representation of issues.

Author:

Robert Reiner

maven-goal:

bugzilla-issues-report

maven-phase:

site

maven-requiresProject:

maven-description:

Generates a release plan report using issues from the issues management system rendering them in a simple table.

Field Summary

Fields inherited from class de.smartics.maven.issues.bugzilla.AbstractBugzillaReportMojo

ALL_VALUES_SELECTOR, includeOnSamePageAllOfVersion

Fields inherited from class de.smartics.maven.issues.AbstractIssuesReportMojo

description, descriptionFile, footerText

Fields inherited from class de.smartics.maven.issues.AbstractIssuesConnectionMojo

buildDirectory, ignoreLogoutProblem, issueManagementPassword, issueManagementSystem, issueManagementUrl, issueManagementUser, logColumns, maxRetries, offline, repositoryFacadeFactory, repositoryFacadeFactoryClass, repositoryVersion, skip, timeout, webPassword, webUser

Fields inherited from class de.smartics.maven.issues.AbstractReportMojo

factory, locale, localRepository, logLevel, outputDirectory, project, resolver, siteRenderer

Fields inherited from interface org.apache.maven.reporting.MavenReport

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

TabularReportMojo()

Method Summary

protected String	getColumns() Returns the value for columns.
protected String	getColumnWidths() Returns the value for columnWidths.
String	getDescription(Locale locale)
String	getName(Locale locale)
String	getOutputName()
protected String	getReportRenderer() Returns the name of the class that runs the rendering of the report page.
String	getStatus() Returns the value for status.
boolean	isCurrentReleaseVersionOnly() Returns the flag to determine if only the current release version is to be rendered (true) or all versions are to be considered ( false).

Methods inherited from class de.smartics.maven.issues.bugzilla.AbstractBugzillaReportMojo

createQueryData, getCommandType, getComponent, getFilter, getIncludeOnSamePageAllOfVersion, getKeywords, getKeywordsType, getOrder, getProduct, getQueryName, getResolution

Methods inherited from class de.smartics.maven.issues.AbstractIssuesReportMojo

createRenderer, getDescription, getDescriptionFile, getIncludeComponentAtIndex, getIncludeComponentAtIndexColumnWidth, getNoResultsDescription, getTitle

Methods inherited from class de.smartics.maven.issues.AbstractIssuesConnectionMojo

canGenerateReport, createInstance, createVersionRange, executeReport

Methods inherited from class de.smartics.maven.issues.AbstractReportMojo

execute, getBundle, getOutputDirectory, getProject, getSiteRenderer, provideSink

Methods inherited from class org.apache.maven.reporting.AbstractMavenReport

closeReport, generate, getCategoryName, getReportOutputDirectory, getSink, isExternalReport, setReportOutputDirectory

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TabularReportMojo

public TabularReportMojo()

Method Detail

getOutputName

public String getOutputName()

See Also:

MavenReport.getOutputName()

getStatus

public String getStatus()

Returns the value for status.

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.

Overrides:

getStatus in class AbstractBugzillaReportMojo

Returns:

the value for status.

getName

public String getName(Locale locale)

See Also:

MavenReport.getName(java.util.Locale)

getDescription

public String getDescription(Locale locale)

See Also:

MavenReport.getDescription(java.util.Locale)

getReportRenderer

protected String getReportRenderer()

Returns the name of the class that runs the rendering of the report page.

Specified by:

getReportRenderer in class AbstractIssuesReportMojo

Returns:

the name of the class that runs the rendering of the report page.

getColumns

protected String getColumns()

Returns the value for columns.

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 BugzillaAttribute.

The values are separated by comma.

Specified by:

getColumns in class AbstractIssuesReportMojo

Returns:

the value for columns.

getColumnWidths

protected String getColumnWidths()

Returns the value for columnWidths.

Lists the column width to be used to set to the columns. If the value is 0 (zero) no width will be set explicitly for that column.

Specified by:

getColumnWidths in class AbstractIssuesReportMojo

Returns:

the value for columnWidths.

isCurrentReleaseVersionOnly

public boolean isCurrentReleaseVersionOnly()

Returns the flag to determine if only the current release version is to be rendered ( true) or all versions are to be considered ( false).

Returns:

the flag to determine if only the current release version is to be rendered ( true) or all versions are to be considered ( false).