de.smartics.maven.issues.bugzilla
Class AbstractIssuesReportRenderer

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

All Implemented Interfaces:

MavenReportRenderer

Direct Known Subclasses:

AbstractSectionReportRenderer, TabularReportRenderer

public abstract class AbstractIssuesReportRenderer
     
     

      
      extends 
      
      AbstractMavenReportRenderer
     
     

The renderer provides helper methods to render a table.

Author:

Robert Reiner

Field Summary

protected RendererConfig	config The configuration to control the rendering process.
protected List<org.eclipse.mylyn.tasks.core.data.TaskData>	issues The issue information to render in the report.

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

sink

Constructor Summary

protected

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

Method Summary

protected abstract String	getDescription() Returns a short description of the report.
protected String	getDescription(String key) Returns the description set in the configuration and if unset there, the label provided by the configuration's resource bundle.
protected abstract String	getNoResultsDescription() Returns a short description of the report when there are no results.
protected String	getNoResultsDescription(String key) Returns the description if the query matches no issue set in the configuration and if unset there, the label provided by the configuration's resource bundle.
protected String	getTitle(String key) Returns the title set in the configuration and if unset there, the label provided by the configuration's resource bundle.
protected void	renderFooter() Renders the footer text.
protected void	renderTableHeader() Renders a table header.
protected void	renderTableRow(org.eclipse.mylyn.tasks.core.data.TaskData issue) Renders a table row.
protected void	renderTitle(boolean noResults) Renders the title block of the report.

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

createLinkPatternedText, endSection, endTable, getTitle, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, renderBody, 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

config

protected final RendererConfig config

The configuration to control the rendering process.

issues

protected final List<org.eclipse.mylyn.tasks.core.data.TaskData> issues

The issue information to render in the report.

Constructor Detail

AbstractIssuesReportRenderer

protected AbstractIssuesReportRenderer(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

getDescription

protected abstract String getDescription()

Returns a short description of the report.

Returns:

a short description of the report.

getNoResultsDescription

protected abstract String getNoResultsDescription()

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

Returns:

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

getTitle

protected String getTitle(String key)

Returns the title set in the configuration and if unset there, the label provided by the configuration's resource bundle.

Parameters:

key - the key to select the label if the title is not explicitly set.

Returns:

the localized title to render.

getDescription

protected String getDescription(String key)

Returns the description set in the configuration and if unset there, the label provided by the configuration's resource bundle.

Parameters:

key - the key to select the label if the title is not explicitly set.

Returns:

the localized description to render.

getNoResultsDescription

protected String getNoResultsDescription(String key)

Returns the description if the query matches no issue set in the configuration and if unset there, the label provided by the configuration's resource bundle.

Parameters:

key - the key to select the label if the title is not explicitly set.

Returns:

the localized description to render.

renderTitle

protected void renderTitle(boolean noResults)

Renders the title block of the report.

Parameters:

noResults - true if the report renders no results (no issue matches the query), false otherwise.

renderFooter

protected void renderFooter()

Renders the footer text.

renderTableHeader

protected void renderTableHeader()

Renders a table header.

renderTableRow

protected void renderTableRow(org.eclipse.mylyn.tasks.core.data.TaskData issue)

Renders a table row.

Parameters:

issue - the issue whose values will be rendered to the columns.