de.smartics.maven.issues
Class AbstractIssuesReportMojo

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractBugzillaReportMojo

public abstract class AbstractIssuesReportMojo
     
     

      
      extends 
      
      AbstractIssuesConnectionMojo
     
     

Mojo base implementation to render release reports.

Author:

Robert Reiner

Field Summary

protected String	description The description to be set in the configuration to be used instead of the one found in the localized files.
protected String	descriptionFile The description file is a XDoc file to be included as-is into the generated report.
protected String	footerText The raw text for the footer.

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

AbstractIssuesReportMojo()

Method Summary

protected MavenReportRenderer	createRenderer(Locale locale, VersionFactory versionFactoryInstance, ArtifactVersionRange versionRange, List<org.eclipse.mylyn.tasks.core.data.TaskData> issues) Creates the renderer to use for report rendering.
protected abstract String	getColumns() Returns the value for columns.
protected abstract String	getColumnWidths() Returns the value for columnWidths.
abstract String	getComponent() Returns the value for component.
String	getDescription() Returns the description to be set in the configuration to be used instead of the one found in the localized files.
String	getDescriptionFile() Returns the description file is a XDoc file to be included as-is into the generated report.
int	getIncludeComponentAtIndex() Returns the value for includeComponentAtIndex.
int	getIncludeComponentAtIndexColumnWidth() Returns the value for includeComponentAtIndexColumnWidth.
abstract VersionType	getIncludeOnSamePageAllOfVersion() Returns the value for includeOnSamePageAll.
String	getNoResultsDescription() Returns the description to be set in the configuration if no issue matches the query to be used instead of the one found in the localized files.
abstract String	getQueryName() Returns the name of the query to execute.
protected abstract String	getReportRenderer() Returns the name of the class that runs the rendering of the report page.
String	getTitle() Returns the title to be set in the configuration to be used instead of the one found in the localized files.

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

canGenerateReport, createInstance, createQueryData, 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

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

getDescription, getName, getOutputName

Field Detail

description

protected String description

The description to be set in the configuration to be used instead of the one found in the localized files. This property is used to specify the description from the configuration and is useful if the user wants to select a specific set of information retrieved by a specific query and now wants to set a specific description.

This value may be omitted in which case the renderer retrieves a default value (probably assuming that a release notes report is rendered).

Since:

1.0

descriptionFile

protected String descriptionFile

The description file is a XDoc file to be included as-is into the generated report. It is rendered between the main header and the report table where the description is normally written. The description is left out if a description file is given.

If no description file is explicitly specified, the system looks at the default location. If the file exists, it is used.

Please note that any -SNAPSHOT element in front of the extension is removed. $${outputName} is replaced by MavenReport.getOutputName().

Since:

1.0

footerText

protected String footerText

The raw text for the footer. May contain any valid HTML code. The string is not checked to be valid. If you want to remove the link to the plugin's homepage, simple add a non breaking space (e.g.   ).

Since:

1.0

Constructor Detail

AbstractIssuesReportMojo

public AbstractIssuesReportMojo()

Method Detail

getTitle

public String getTitle()

Returns the title to be set in the configuration to be used instead of the one found in the localized files. This property is used to specify the title from the configuration and is useful if the user wants to select a specific set of information retrieved by a specific query and now wants to set a specific title.

This value may be omitted in which case the renderer retrieves a default value (probably assuming that a release notes report is rendered).

Returns:

the title to be set in the configuration to be used instead of the one found in the localized files.

getDescription

public String getDescription()

Returns the description to be set in the configuration to be used instead of the one found in the localized files. This property is used to specify the description from the configuration and is useful if the user wants to select a specific set of information retrieved by a specific query and now wants to set a specific description.

This value may be omitted in which case the renderer retrieves a default value (probably assuming that a release notes report is rendered).

Returns:

the description to be set in the configuration to be used instead of the one found in the localized files.

getDescriptionFile

public String getDescriptionFile()

Returns the description file is a XDoc file to be included as-is into the generated report. It is rendered between the main header and the report table where the description is normally written. The description is left out if a description file is given.

Returns:

the description file is a XDoc file to be included as-is into the generated report.

getNoResultsDescription

public String getNoResultsDescription()

Returns the description to be set in the configuration if no issue matches the query to be used instead of the one found in the localized files. This property is used to specify the description from the configuration and is useful if the user wants to select a specific set of information retrieved by a specific query and now wants to set a specific description.

This value may be omitted in which case the renderer retrieves a default value (probably assuming that a release notes report is rendered).

Returns:

the description to be set in the configuration if no issue matches the query to be used instead of the one found in the localized files.

getReportRenderer

protected abstract String getReportRenderer()

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

Returns:

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

getColumns

protected abstract 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 org.eclipse.mylyn.internal.bugzilla.core.BugzillaAttribute.

The values are separated by comma.

Returns:

the value for columns.

getColumnWidths

protected abstract 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.

Returns:

the value for columnWidths.

getIncludeOnSamePageAllOfVersion

public abstract VersionType getIncludeOnSamePageAllOfVersion()

Returns the value for includeOnSamePageAll.

On the same page all of the given version type are rendered. For instance if this value refers to the major version, all versions having the same major version are rendered. A value of micro implies that only the current version is to be rendered.

Defaults to VersionType.MAJOR.

Returns:

the value for includeOnSamePageAll.

getComponent

public abstract String getComponent()

Returns the value for component.

Sets the component(s) that you want to limit your report to include. Multiple components can be separated by commas. If this is set to empty - that means all components.

Returns:

the value for component.

getQueryName

public abstract String getQueryName()

Returns the name of the query to execute. If the query name is specified none of the other query properties is taken into account.

Returns:

the name of the query to execute.

getIncludeComponentAtIndex

public int getIncludeComponentAtIndex()

Returns the value for includeComponentAtIndex.

Specifies the index (zero bases) of the column at which the component information is to rendered. This option is only taken into account if the component property does not specify exactly one component. Please note that this cannot be used in named queries.

This is a handy option for running the report on a multi project. Sub projects specify exactly one component while the parent project specifies none. The result with setting an index of e.g. 1 is that in each sub project the component is not mentioned while it is on the parent project (listing all issues of all projects) it is rendered at the second column.

Returns:

the value for includeComponentAtIndex.

getIncludeComponentAtIndexColumnWidth

public int getIncludeComponentAtIndexColumnWidth()

Returns the value for includeComponentAtIndexColumnWidth.

Specifies the column width for the includeComponentAtIndex property. If that property is not set, this property value is ignored.

Returns:

the value for includeComponentAtIndexColumnWidth.

createRenderer

protected MavenReportRenderer createRenderer(Locale locale,
                                             VersionFactory versionFactoryInstance,
                                             ArtifactVersionRange versionRange,
                                             List<org.eclipse.mylyn.tasks.core.data.TaskData> issues)
                                      throws MavenReportException

Creates the renderer to use for report rendering.

Specified by:

createRenderer in class AbstractIssuesConnectionMojo

Parameters:

locale - the locale to select the resource bundle that provides labels for the generated reports.

issues - the issues to render.

Returns:

the created renderer instance.

Throws:

MavenReportException - if a problem prevents the creation of the report renderer.