org.nuiton.jredmine.plugin.report
Class IssuesReportByPriority

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.nuiton.plugin.AbstractPlugin
          org.nuiton.jredmine.plugin.AbstractRedmineMojo
              org.nuiton.jredmine.plugin.report.AbstractRedmineReport
                  org.nuiton.jredmine.plugin.report.AbstractIssuesReport
                      org.nuiton.jredmine.plugin.report.IssuesReportByPriority

All Implemented Interfaces:

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

public class IssuesReportByPriority
extends AbstractIssuesReport

Generates a report for issues from Redmine's server group by priority.

Since:

1.0.0

Author:

tchemit

Is defined by the goal name:

issues-report-by-priority

Nested Class Summary

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

org.nuiton.plugin.Plugin.Packaging

Field Summary

protected java.lang.String	columnNamesByPriority Sets the column names that you want to show in the report.
protected java.util.Map<java.lang.String,java.lang.String>	filtersByPriority Sets some filters on issues to include.
protected int	maxEntriesByPriority Maximum number of entries to be fetched from redmine.
protected boolean	onlyCurrentVersionByPriority If you only want to show issues for the current version in the report.

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

group

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

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

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

dateFormat, encoding, password, project, projectId, REDMINE_SYSTEM, releaseProject, releaseUser, releaseVersion, runOnceDone, safe, service, session, url, username, users, verbose, versionId

Fields inherited from class org.nuiton.plugin.AbstractPlugin

skipAfterInitMessage

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

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Constructor Summary

IssuesReportByPriority()

Method Summary

protected java.lang.String	getColumnNames()
protected java.util.Map<java.lang.String,java.lang.String>	getFilters()
int	getMaxEntries()
boolean	isOnlyCurrentVersion()

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

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

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

canGenerateReport, doAction, generate, getBundle, getCategoryName, getReportOutputDirectory, getSink, getSkinArtifactFile, isExternalReport, setReportOutputDirectory

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

closeService, execute, getEncoding, getProject, getRestPassword, getRestUrl, getRestUsername, initReleaseProject, initReleaseUser, initReleaseVersion, isRunOnceDone, isSafe, isVerbose, setEncoding, setProject, setRestPassword, setRestUrl, setRestUsername, setSafe, setVerbose

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addUrlToUrlsList, checkPackaging, checkResource, checkRunOnceDone, copyFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getTemplate, initClassLoader, isExecutionRoot, isFileNewerThanPomFile, rejectPackaging, removeCompileSourceRoots, removeTestCompileSourceRoots, 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

isVerbose

Methods inherited from interface org.nuiton.plugin.Plugin

getProject, isVerbose, setProject, setVerbose

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

execute, getLog, setLog

Methods inherited from interface org.nuiton.io.rest.RestClientConfiguration

getEncoding, getRestPassword, getRestUrl, getRestUsername, isVerbose, setEncoding, setRestPassword, setRestUrl, setRestUsername, setVerbose

Field Detail

maxEntriesByPriority

protected int maxEntriesByPriority

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

onlyCurrentVersionByPriority

protected boolean onlyCurrentVersionByPriority

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

Is defined by:

expression:

${redmine.onlyCurrentVersion}

default-value:

false

filtersByPriority

protected java.util.Map<java.lang.String,java.lang.String> filtersByPriority

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

Is defined by:

columnNamesByPriority

protected java.lang.String columnNamesByPriority

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:

2.0

Is defined by:

expression:

${redmine.columnNames}

default-value:

Tracker,Category,Key,Summary,Status,Assignee,Version

Constructor Detail

IssuesReportByPriority

public IssuesReportByPriority()

Method Detail

isOnlyCurrentVersion

public boolean isOnlyCurrentVersion()

getMaxEntries

public int getMaxEntries()

getColumnNames

protected java.lang.String getColumnNames()

Specified by:

getColumnNames in class AbstractIssuesReport

getFilters

protected java.util.Map<java.lang.String,java.lang.String> getFilters()

Specified by:

getFilters in class AbstractIssuesReport