org.nuiton.jredmine.plugin.report

Class IssuesReport

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.nuiton.plugin.AbstractPlugin

org.nuiton.jredmine.plugin.AbstractRedmineMojo

org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProject

org.nuiton.jredmine.plugin.report.AbstractRedmineReport

org.nuiton.jredmine.plugin.report.AbstractIssuesReport

org.nuiton.jredmine.plugin.report.IssuesReport

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.apache.maven.reporting.MavenReport, org.nuiton.io.rest.RestClientConfiguration, IssueCollectorConfiguration, RedmineProjectAware, RedmineVersionAware, RedmineServiceConfiguration, org.nuiton.plugin.Plugin

@Mojo(name="issues-report",
      requiresOnline=true,
      requiresProject=true,
      requiresReports=true)
public class IssuesReport
extends AbstractIssuesReport

Generates a report for issues from Redmine's server

Since:

1.0.0

Author:

tchemit

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuiton.plugin.Plugin

org.nuiton.plugin.Plugin.InitState, org.nuiton.plugin.Plugin.Packaging

Field Summary

Fields

Modifier and Type	Field and Description
protected String	columnNames Sets the column names that you want to show in the report.
protected Map<String,String>	filters Sets some filters on issues to include.
protected int	maxEntries Maximum number of entries to be fetched from redmine.
protected boolean	onlyCurrentVersion If you only want to show issues for the current version in the report.
protected boolean	skipIssueReport A flag to skip the report.

Fields inherited from class org.nuiton.jredmine.plugin.report.AbstractIssuesReport

group, issues, issuesCache

Fields inherited from class org.nuiton.jredmine.plugin.report.AbstractRedmineReport

anonymous, factory, i18n, issueLinkTemplate, localRepository, outputDirectory, resolver, siteRenderer, versionId, versionLinkTemplate

Fields inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProject

projectId, releaseProject, releaseUser, users

Fields inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojo

dateFormat, encoding, initOk, password, project, REDMINE_SYSTEM, runOnceDone, safe, service, serviceInit, session, url, username, verbose

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

Constructors

Constructor and Description
IssuesReport()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	getColumnNames()
protected Map<String,String>	getFilters()
int	getMaxEntries()
boolean	isOnlyCurrentVersion()
protected boolean	skipReport()

Methods inherited from class org.nuiton.jredmine.plugin.report.AbstractIssuesReport

checkRunOnceDone, executeReport, getCategoryIds, getDescription, getGroup, getIssueLinkTemplate, getName, getOutputName, getPriorityIds, getStatusIds, getTrackerIds, getVersionLinkTemplate, getVersionNames, init, isGoalSkip, isRunOnce

Methods inherited from class org.nuiton.jredmine.plugin.report.AbstractRedmineReport

canGenerateReport, doAction, generate, getBundle, getCategoryName, getReportOutputDirectory, getSink, getSkinArtifactFile, getVersionId, isAnonymous, isExternalReport, setAnonymous, setReportOutputDirectory, setVersionId

Methods inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojoWithProject

checkSkip, getProjectId, initReleaseProject, initReleaseUser, setProjectId

Methods inherited from class org.nuiton.jredmine.plugin.AbstractRedmineMojo

afterExecute, closeService, getApiKey, getEncoding, getProject, getRestPassword, getRestUrl, getRestUsername, isRunOnceDone, isSafe, isVerbose, setApiKey, setEncoding, setProject, setRestPassword, setRestUrl, setRestUsername, setSafe, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, backupFile, checkEncoding, checkPackaging, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getRootProject, getTemplate, hasClassPath, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, renameFile, writeFile

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.nuiton.jredmine.plugin.IssueCollectorConfiguration

getProjectId, getVersionId, isVerbose, setVersionId

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

getLog, setLog

Field Detail

maxEntries

@Parameter(property="redmine.maxEntries",
           defaultValue="100")
protected int maxEntries

Maximum number of entries to be fetched from redmine.

Note: use value 0 to have no limits

Since:

1.0.0

Is defined by:

expression:

${redmine.maxEntries}

default-value:

100

onlyCurrentVersion

@Parameter(property="redmine.onlyCurrentVersion",
           defaultValue="false")
protected boolean onlyCurrentVersion

If you only want to show issues for the current version in the report. The current version being used is ${project.version} minus any "-SNAPSHOT" suffix.

Since:

1.0.0

filters

@Parameter
protected Map<String,String> filters

Sets some filters on issues to include. the possible keys are :

• version : to restrict on version fixed
• status : to restrict on some status
• priority : to restrict on some priorties
• category : to restrict on some categories
• tracker : to restrict on some tracker (says type of issues)

Values are Redmine's internal ids (except for the version entry which use Redmine's version names).

Multiple values can be separated by commas.

Note : If a value is set to empty - that means to not filter on that property.

To see the internal ids, use the command :

 mvn redmine:display-ids -Dtype=<entry key>
 

Since:

1.0.0

columnNames

@Parameter(property="redmine.columnNames",
           defaultValue="Tracker,Category,Key,Summary,Status,Assignee,Version")
protected String columnNames

Sets the column names that you want to show in the report. The columns will appear in the report in the same order as you specify them here. Multiple values can be separated by commas.

Valid columns are: Key, Summary, Status, Assignee, Reporter, Tracker, Priority, Version, Category, Created and Updated.

Since:

1.0.0

skipIssueReport

@Parameter(property="redmine.skipIssueReport",
           defaultValue="false")
protected boolean skipIssueReport

A flag to skip the report.

This can be usefull since there is no way to skip a report from an inherited reportSet configuration.

Since:

1.0.0

Constructor Detail

IssuesReport

public IssuesReport()

Method Detail

skipReport

protected boolean skipReport()

Specified by:

skipReport in class AbstractRedmineReport

Returns:

true if report should be skip

isOnlyCurrentVersion

public boolean isOnlyCurrentVersion()

getMaxEntries

public int getMaxEntries()

getColumnNames

protected String getColumnNames()

Specified by:

getColumnNames in class AbstractIssuesReport

getFilters

protected Map<String,String> getFilters()

Specified by:

getFilters in class AbstractIssuesReport