org.nuiton.jredmine.plugin.report
Class IssueReportGenerator

java.lang.Object
  org.nuiton.jredmine.plugin.report.IssueReportGenerator

public class IssueReportGenerator
extends Object

Generates a Redmine report.

Since:

1.0.0

Author:

tchemit

Nested Class Summary

static class

IssueReportGenerator.ReportColumn Universe of columns of the report.

Constructor Summary

IssueReportGenerator()

IssueReportGenerator(org.apache.maven.plugin.logging.Log log, String columnNames, String groupBy)

Method Summary

boolean	canGenerateIssueLinks() Checks whether links to the issues can be generated.
boolean	canGenerateVersionLinks() Checks whether links to the issues can be generated.
protected void	constructDetailRows(org.apache.maven.doxia.sink.Sink sink, Issue[] issues)
protected void	constructHeaderRow(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle)
protected void	constructIssueLink(Issue issue, org.apache.maven.doxia.sink.Sink sink)
protected void	constructVersionLink(Version v, org.apache.maven.doxia.sink.Sink sink, String prefix)
void	doGenerateEmptyReport(ResourceBundle bundle, org.apache.maven.doxia.sink.Sink sink)
void	doGenerateReport(ResourceBundle bundle, org.apache.maven.doxia.sink.Sink sink, org.apache.maven.plugin.logging.Log log)
protected IssueCategory	getIssueCategory(int id)
protected IssuePriority	getIssuePriority(int id)
protected IssueStatus	getIssueStatus(int id)
protected Tracker	getTracker(int id)
String	getUrl()
protected User	getUser(int id)
protected Version	getVersion(int id)
protected boolean	isGroup()
protected String	parseIssueLink(String issue)
protected String	parseVersionLink(String issue)
void	setIssueCategories(IssueCategory[] issueCategories)
void	setIssueLinkTemplate(String issueLinkTemplate)
void	setIssuePriorities(IssuePriority[] issuePriorities)
void	setIssues(Issue[] issues)
void	setIssueStatuses(IssueStatus[] issueStatuses)
void	setTrackers(Tracker[] users)
void	setUrl(String url)
void	setUsers(User[] users)
void	setVersionLinkTemplate(String versionLinkTemplate)
void	setVersions(Version[] users)
protected void	sinkBeginReport(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle)
protected void	sinkDate(org.apache.maven.doxia.sink.Sink sink, Date d)
protected void	sinkEndReport(org.apache.maven.doxia.sink.Sink sink)
protected void	sinkHeader(org.apache.maven.doxia.sink.Sink sink, String header)
protected void	sinkI18nAble(org.apache.maven.doxia.sink.Sink sink, int id, I18nAble obj)
protected void	sinkRawText(org.apache.maven.doxia.sink.Sink sink, String text)
protected void	sinkSectionTitle1(org.apache.maven.doxia.sink.Sink sink, String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

IssueReportGenerator

public IssueReportGenerator()

IssueReportGenerator

public IssueReportGenerator(org.apache.maven.plugin.logging.Log log,
                            String columnNames,
                            String groupBy)
                     throws org.apache.maven.reporting.MavenReportException

Parameters:

log - the logger

columnNames - The names of the columns to include in the report

groupBy - the group by column name (or null if not grouped)

Throws:

org.apache.maven.reporting.MavenReportException - if any pb

Method Detail

doGenerateEmptyReport

public void doGenerateEmptyReport(ResourceBundle bundle,
                                  org.apache.maven.doxia.sink.Sink sink)

doGenerateReport

public void doGenerateReport(ResourceBundle bundle,
                             org.apache.maven.doxia.sink.Sink sink,
                             org.apache.maven.plugin.logging.Log log)
                      throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

canGenerateIssueLinks

public boolean canGenerateIssueLinks()

Checks whether links to the issues can be generated.

Returns:

true if issue links can be generated, false otherwise.

canGenerateVersionLinks

public boolean canGenerateVersionLinks()

Checks whether links to the issues can be generated.

Returns:

true if issue links can be generated, false otherwise.

setUrl

public void setUrl(String url)

getUrl

public String getUrl()

setIssueLinkTemplate

public void setIssueLinkTemplate(String issueLinkTemplate)

setVersionLinkTemplate

public void setVersionLinkTemplate(String versionLinkTemplate)

setIssueCategories

public void setIssueCategories(IssueCategory[] issueCategories)

setIssueStatuses

public void setIssueStatuses(IssueStatus[] issueStatuses)

setIssuePriorities

public void setIssuePriorities(IssuePriority[] issuePriorities)

setUsers

public void setUsers(User[] users)

setVersions

public void setVersions(Version[] users)

setTrackers

public void setTrackers(Tracker[] users)

setIssues

public void setIssues(Issue[] issues)

constructHeaderRow

protected void constructHeaderRow(org.apache.maven.doxia.sink.Sink sink,
                                  ResourceBundle bundle)

constructDetailRows

protected void constructDetailRows(org.apache.maven.doxia.sink.Sink sink,
                                   Issue[] issues)

parseIssueLink

protected String parseIssueLink(String issue)

parseVersionLink

protected String parseVersionLink(String issue)

constructIssueLink

protected void constructIssueLink(Issue issue,
                                  org.apache.maven.doxia.sink.Sink sink)

constructVersionLink

protected void constructVersionLink(Version v,
                                    org.apache.maven.doxia.sink.Sink sink,
                                    String prefix)

isGroup

protected boolean isGroup()

getIssueStatus

protected IssueStatus getIssueStatus(int id)

getIssueCategory

protected IssueCategory getIssueCategory(int id)

getIssuePriority

protected IssuePriority getIssuePriority(int id)

getVersion

protected Version getVersion(int id)

getUser

protected User getUser(int id)

getTracker

protected Tracker getTracker(int id)

sinkBeginReport

protected void sinkBeginReport(org.apache.maven.doxia.sink.Sink sink,
                               ResourceBundle bundle)

sinkEndReport

protected void sinkEndReport(org.apache.maven.doxia.sink.Sink sink)

sinkHeader

protected void sinkHeader(org.apache.maven.doxia.sink.Sink sink,
                          String header)

sinkRawText

protected void sinkRawText(org.apache.maven.doxia.sink.Sink sink,
                           String text)

sinkDate

protected void sinkDate(org.apache.maven.doxia.sink.Sink sink,
                        Date d)

sinkI18nAble

protected void sinkI18nAble(org.apache.maven.doxia.sink.Sink sink,
                            int id,
                            I18nAble obj)

sinkSectionTitle1

protected void sinkSectionTitle1(org.apache.maven.doxia.sink.Sink sink,
                                 String text)