org.nuiton.eugene.plugin.renderer

Class AbstractEugeneReportRenderer<D,DD>

java.lang.Object

org.apache.maven.reporting.AbstractMavenReportRenderer

org.nuiton.eugene.plugin.renderer.AbstractEugeneReportRenderer<D,DD>

All Implemented Interfaces:

org.apache.maven.reporting.MavenReportRenderer

Direct Known Subclasses:

StereotypesReportRenderer, TagValuesReportRenderer

public abstract class AbstractEugeneReportRenderer<D,DD>
extends org.apache.maven.reporting.AbstractMavenReportRenderer

Since:

2.10

Author:

tchemit

Field Summary

Fields

Modifier and Type	Field and Description
protected String	bundleName The name of the bundle containing our I18n resources.
protected D	data Data to describe.
protected org.codehaus.plexus.i18n.I18N	i18n Internationalization component.
protected String	javaDocDestDir
protected String	jxrDestDir
protected Locale	locale The locale we are rendering for.

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

sink

Constructor Summary

Constructors

Constructor and Description
AbstractEugeneReportRenderer(org.apache.maven.doxia.sink.Sink sink, org.codehaus.plexus.i18n.I18N i18n, Locale locale, String bundleName, String javaDocDestDir, String jxrDestDir, D data)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Map<String,DD>	getDataDetails()
protected abstract String	getEugeneDocLink()
protected String	getText(boolean key)
protected String	getText(String key) Gets the localized message for this report.
String	getTitle()
void	renderBody()
protected abstract void	renderDetail(String key, DD detail)
protected void	renderDetailTarget(Class<?> target)
protected void	renderErrorIcon()
protected void	renderInfoIcon()
protected void	renderSuccessIcon()
protected abstract void	renderSummaryTable(D provider, Map<String,DD> detailEntries)
protected void	renderTargets(Class<?>... targets)
protected void	renderWarningIcon()
protected void	sinkCellLink(String text, String url)
protected void	sinkCellText(org.apache.maven.doxia.sink.SinkEventAttributes width, String text)
protected void	sinkCellText(String text)
protected void	sinkCellVerbatimText(String text)
protected void	sinkHeaderCellText(org.apache.maven.doxia.sink.SinkEventAttributes width, String text)
protected void	sinkHeaderCellText(String text)

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

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

i18n

protected final org.codehaus.plexus.i18n.I18N i18n

Internationalization component.

locale

protected final Locale locale

The locale we are rendering for.

bundleName

protected final String bundleName

The name of the bundle containing our I18n resources.

data

protected final D data

Data to describe.

javaDocDestDir

protected final String javaDocDestDir

jxrDestDir

protected final String jxrDestDir

Constructor Detail

AbstractEugeneReportRenderer

public AbstractEugeneReportRenderer(org.apache.maven.doxia.sink.Sink sink,
                            org.codehaus.plexus.i18n.I18N i18n,
                            Locale locale,
                            String bundleName,
                            String javaDocDestDir,
                            String jxrDestDir,
                            D data)

Method Detail

getDataDetails

protected abstract Map<String,DD> getDataDetails()

getTitle

public String getTitle()

Specified by:

getTitle in interface org.apache.maven.reporting.MavenReportRenderer

Specified by:

getTitle in class org.apache.maven.reporting.AbstractMavenReportRenderer

renderBody

public void renderBody()

Specified by:

renderBody in class org.apache.maven.reporting.AbstractMavenReportRenderer

getEugeneDocLink

protected abstract String getEugeneDocLink()

renderSummaryTable

protected abstract void renderSummaryTable(D provider,
                      Map<String,DD> detailEntries)

renderDetail

protected abstract void renderDetail(String key,
                DD detail)

getText

protected String getText(boolean key)

getText

protected String getText(String key)

Gets the localized message for this report.

Parameters:

key - the message key.

Returns:

the message.

renderWarningIcon

protected void renderWarningIcon()

renderErrorIcon

protected void renderErrorIcon()

renderSuccessIcon

protected void renderSuccessIcon()

renderInfoIcon

protected void renderInfoIcon()

sinkHeaderCellText

protected void sinkHeaderCellText(String text)

sinkHeaderCellText

protected void sinkHeaderCellText(org.apache.maven.doxia.sink.SinkEventAttributes width,
                      String text)

sinkCellText

protected void sinkCellText(org.apache.maven.doxia.sink.SinkEventAttributes width,
                String text)

sinkCellText

protected void sinkCellText(String text)

sinkCellVerbatimText

protected void sinkCellVerbatimText(String text)

sinkCellLink

protected void sinkCellLink(String text,
                String url)

renderTargets

protected void renderTargets(Class<?>... targets)

renderDetailTarget

protected void renderDetailTarget(Class<?> target)