de.smartics.maven.issues.bugzilla
Class VersionedSectionReportRenderer

java.lang.Object
  org.apache.maven.reporting.AbstractMavenReportRenderer
      de.smartics.maven.issues.bugzilla.AbstractIssuesReportRenderer
          de.smartics.maven.issues.bugzilla.AbstractSectionReportRenderer
              de.smartics.maven.issues.bugzilla.VersionedSectionReportRenderer

All Implemented Interfaces:

MavenReportRenderer

Direct Known Subclasses:

VersionedSectionReleasePlanReportRenderer

public class VersionedSectionReportRenderer
     
     

      
      extends 
      
      AbstractSectionReportRenderer
     
     

The renderer prints issue information in different sections within their version. The sections are defines by the key RendererConfig.getSectionType() and are selected and ordered by RendererConfig.getSections().

Author:

Robert Reiner

Field Summary

protected String

currentVersionString The version text to be used by template methods provided by the parent's class.

Fields inherited from class de.smartics.maven.issues.bugzilla.AbstractIssuesReportRenderer

config, issues

Fields inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

sink

Constructor Summary

VersionedSectionReportRenderer(RendererConfig config, Sink sink, List<org.eclipse.mylyn.tasks.core.data.TaskData> issues)
Default constructor.

Method Summary

protected Sectioner<Versions>	createSectioner() Creates the sectioner to use.
protected VersionSkipper	createVersionSkipper() Returns the arbiter to determine which versions are excluded from the report.
String	getDescription() Returns a short description of the report.
String	getNoResultsDescription() Returns a short description of the report when there are no results.
protected String	getSectionText(ResourceBundle bundle, String sectionId) Returns the introduction text after the section title.
String	getTitle()
protected String	getVersionTextId() Returns the identifier part for the version text rendered in the report.
protected void	renderBody()
protected void	renderSectionSectionEnd() Renders the end of a section.
protected void	renderSectionSectionStart() Renders the start of a section.
protected void	renderSectionTitleEnd() Renders the end of a section title.
protected void	renderSectionTitleStart() Renders the start of a section title.

Methods inherited from class de.smartics.maven.issues.bugzilla.AbstractSectionReportRenderer

renderPreviousReportReferences, renderSectionHeader, renderSections

Methods inherited from class de.smartics.maven.issues.bugzilla.AbstractIssuesReportRenderer

getDescription, getNoResultsDescription, getTitle, renderFooter, renderTableHeader, renderTableRow, renderTitle

Methods inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

createLinkPatternedText, endSection, endTable, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, startSection, startTable, tableCaption, tableCell, tableCell, tableHeader, tableHeaderCell, tableRow, text, verbatimLink, verbatimText

Methods inherited from class java.lang.Object

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

Field Detail

currentVersionString

protected String currentVersionString

The version text to be used by template methods provided by the parent's class.

Constructor Detail

VersionedSectionReportRenderer

public VersionedSectionReportRenderer(RendererConfig config,
                                      Sink sink,
                                      List<org.eclipse.mylyn.tasks.core.data.TaskData> issues)

Default constructor.

Parameters:

config - the configuration to control the rendering process.

sink - the sink to write to.

issues - the issue information to render in the report.

Method Detail

getTitle

public String getTitle()

Specified by:

getTitle in interface MavenReportRenderer

Specified by:

getTitle in class AbstractMavenReportRenderer

getDescription

public String getDescription()

Returns a short description of the report.

Specified by:

getDescription in class AbstractIssuesReportRenderer

Returns:

a short description of the report.

getNoResultsDescription

public String getNoResultsDescription()

Returns a short description of the report when there are no results.

Specified by:

getNoResultsDescription in class AbstractIssuesReportRenderer

Returns:

a short description of the report when there are no results.

renderBody

protected void renderBody()

Overrides:

renderBody in class AbstractSectionReportRenderer

createVersionSkipper

protected VersionSkipper createVersionSkipper()

Returns the arbiter to determine which versions are excluded from the report.

Returns:

the arbiter to determine which versions are excluded from the report.

createSectioner

protected Sectioner<Versions> createSectioner()

Creates the sectioner to use.

Returns:

the sectioner to use.

getVersionTextId

protected String getVersionTextId()

Returns the identifier part for the version text rendered in the report.

Returns:

the identifier part for the version text rendered in the report.

renderSectionSectionStart

protected void renderSectionSectionStart()

Renders the start of a section.

Overrides:

renderSectionSectionStart in class AbstractSectionReportRenderer

Implementation Notes:

Subclasses should override this if the default level 3 is not adequate for the report.

renderSectionSectionEnd

protected void renderSectionSectionEnd()

Renders the end of a section.

Overrides:

renderSectionSectionEnd in class AbstractSectionReportRenderer

Implementation Notes:

Subclasses should override this if the default level 3 is not adequate for the report.

renderSectionTitleStart

protected void renderSectionTitleStart()

Renders the start of a section title.

Overrides:

renderSectionTitleStart in class AbstractSectionReportRenderer

Implementation Notes:

Subclasses should override this if the default level 3 is not adequate for the report.

renderSectionTitleEnd

protected void renderSectionTitleEnd()

Renders the end of a section title.

Overrides:

renderSectionTitleEnd in class AbstractSectionReportRenderer

Implementation Notes:

Subclasses should override this if the default level 3 is not adequate for the report.

getSectionText

protected String getSectionText(ResourceBundle bundle,
                                String sectionId)

Returns the introduction text after the section title.

Overrides:

getSectionText in class AbstractSectionReportRenderer

Parameters:

bundle - the resource bundle to use.

sectionId - the identifier (an attribute key of the issue management system) of the section.

Returns:

the localized text to render.