de.smartics.maven.issues.bugzilla
Class VersionedSectionReleasePlanReportRenderer

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
                  de.smartics.maven.issues.bugzilla.VersionedSectionReleasePlanReportRenderer

All Implemented Interfaces:

MavenReportRenderer

public class VersionedSectionReleasePlanReportRenderer
     
     

      
      extends 
      
      VersionedSectionReportRenderer
     
     

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

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

currentVersionString

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

config, issues

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

sink

Constructor Summary

VersionedSectionReleasePlanReportRenderer(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.

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

renderBody, renderSectionSectionEnd, renderSectionSectionStart, renderSectionTitleEnd, renderSectionTitleStart

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

Constructor Detail

VersionedSectionReleasePlanReportRenderer

public VersionedSectionReleasePlanReportRenderer(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

Overrides:

getTitle in class VersionedSectionReportRenderer

getDescription

public String getDescription()

Returns a short description of the report.

Overrides:

getDescription in class VersionedSectionReportRenderer

Returns:

a short description of the report.

getNoResultsDescription

public String getNoResultsDescription()

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

Overrides:

getNoResultsDescription in class VersionedSectionReportRenderer

Returns:

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

createSectioner

protected Sectioner<Versions> createSectioner()

Creates the sectioner to use.

Overrides:

createSectioner in class VersionedSectionReportRenderer

Returns:

the sectioner to use.

createVersionSkipper

protected VersionSkipper createVersionSkipper()

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

Overrides:

createVersionSkipper in class VersionedSectionReportRenderer

Returns:

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

getVersionTextId

protected String getVersionTextId()

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

Overrides:

getVersionTextId in class VersionedSectionReportRenderer

Returns:

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

getSectionText

protected String getSectionText(ResourceBundle bundle,
                                String sectionId)

Returns the introduction text after the section title.

Overrides:

getSectionText in class VersionedSectionReportRenderer

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.