org.nuiton.jredmine.plugin.report
Class AbstractIssuesReport

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

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

Direct Known Subclasses:

IssuesReport, IssuesReportByAssignee, IssuesReportByCategory, IssuesReportByPriority, IssuesReportByReporter, IssuesReportByStatus, IssuesReportByTracker, IssuesReportByVersion

public abstract class AbstractIssuesReport
extends AbstractRedmineReport
implements IssueCollectorConfiguration

Abstract 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

protected String	group The meta to group issues (or null if no grouping)
protected Issue[]	issues Issues to used for report
protected static Map<IssueCollectorConfiguration,Issue[]>	issuesCache cache of collected issues

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, initOk, password, project, projectId, REDMINE_SYSTEM, releaseProject, releaseUser, releaseVersion, runOnceDone, safe, service, serviceInit, session, url, username, users, verbose, versionId

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

CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE

Constructor Summary

protected

AbstractIssuesReport(String group)

Method Summary

protected boolean	checkRunOnceDone()
void	executeReport(Locale locale)
String	getCategoryIds()
protected abstract String	getColumnNames()
String	getDescription(Locale locale)
protected abstract Map<String,String>	getFilters()
protected String	getGroup()
protected String	getIssueLinkTemplate()
String	getName(Locale locale)
String	getOutputName()
String	getPriorityIds()
String	getProjectId()
String	getStatusIds()
String	getTrackerIds()
String	getVersionId()
protected String	getVersionLinkTemplate()
String	getVersionNames()
void	init()
protected boolean	isGoalSkip()
protected boolean	isRunOnce()
void	setVersionId(String versionId)

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

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

Methods inherited from class org.nuiton.plugin.AbstractPlugin

acceptPackaging, addCompileSourceRoots, addDirectoryToUrlsList, addResourceDir, addResourceDir, addTestCompileSourceRoots, addTestResourceDir, addTestResourceDir, addUrlToUrlsList, backupFile, checkPackaging, checkResource, checkRunOnceDone, copyFile, createDirectoryIfNecessary, createNewFile, deleteFile, execute, getBackupFile, getFileFromBasedir, getFilesToTreate, getFilesToTreateForRoots, getTemplate, 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

getMaxEntries, isOnlyCurrentVersion, 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, isAnonymous, isVerbose, setAnonymous, setEncoding, setRestPassword, setRestUrl, setRestUsername, setVerbose

Field Detail

group

protected final String group

The meta to group issues (or null if no grouping)

Since:

1.0.0

issuesCache

protected static Map<IssueCollectorConfiguration,Issue[]> issuesCache

cache of collected issues

issues

protected Issue[] issues

Issues to used for report

Constructor Detail

AbstractIssuesReport

protected AbstractIssuesReport(String group)

Method Detail

getColumnNames

protected abstract String getColumnNames()

getFilters

protected abstract Map<String,String> getFilters()

getOutputName

public final String getOutputName()

Specified by:

getOutputName in interface org.apache.maven.reporting.MavenReport

getName

public final String getName(Locale locale)

Specified by:

getName in interface org.apache.maven.reporting.MavenReport

Overrides:

getName in class AbstractRedmineReport

getDescription

public final String getDescription(Locale locale)

Specified by:

getDescription in interface org.apache.maven.reporting.MavenReport

Overrides:

getDescription in class AbstractRedmineReport

isRunOnce

protected boolean isRunOnce()

Specified by:

isRunOnce in class AbstractRedmineMojo

checkRunOnceDone

protected boolean checkRunOnceDone()

Specified by:

checkRunOnceDone in class AbstractRedmineMojo

isGoalSkip

protected boolean isGoalSkip()

Specified by:

isGoalSkip in class AbstractRedmineMojo

init

public void init()
          throws Exception

Overrides:

init in class AbstractRedmineMojo

Throws:

Exception

executeReport

public void executeReport(Locale locale)
                   throws org.apache.maven.reporting.MavenReportException

Specified by:

executeReport in class AbstractRedmineReport

Throws:

org.apache.maven.reporting.MavenReportException

getProjectId

public final String getProjectId()

Specified by:

getProjectId in interface IssueCollectorConfiguration

Overrides:

getProjectId in class AbstractRedmineMojo

getVersionId

public final String getVersionId()

Specified by:

getVersionId in interface IssueCollectorConfiguration

Overrides:

getVersionId in class AbstractRedmineMojo

setVersionId

public void setVersionId(String versionId)

Specified by:

setVersionId in interface IssueCollectorConfiguration

getCategoryIds

public String getCategoryIds()

Specified by:

getCategoryIds in interface IssueCollectorConfiguration

getVersionNames

public String getVersionNames()

Specified by:

getVersionNames in interface IssueCollectorConfiguration

getPriorityIds

public String getPriorityIds()

Specified by:

getPriorityIds in interface IssueCollectorConfiguration

getStatusIds

public String getStatusIds()

Specified by:

getStatusIds in interface IssueCollectorConfiguration

getTrackerIds

public String getTrackerIds()

Specified by:

getTrackerIds in interface IssueCollectorConfiguration

getGroup

protected final String getGroup()

getIssueLinkTemplate

protected final String getIssueLinkTemplate()

getVersionLinkTemplate

protected final String getVersionLinkTemplate()