org.codehaus.mojo.javancss
Class AbstractNcssReportGenerator

java.lang.Object
  org.codehaus.mojo.javancss.AbstractNcssReportGenerator

Direct Known Subclasses:

NcssAggregateReportGenerator, NcssReportGenerator

public abstract class AbstractNcssReportGenerator
extends java.lang.Object

Base abstract class for NCSSReport classes.
It holds essentially helper methods on top of the Sink Doxia object.

Version:

$Id: AbstractNcssReportGenerator.java 6588 2008-03-28 12:22:57Z bentmann $

Author:

Constructor Summary

protected

AbstractNcssReportGenerator(org.codehaus.doxia.sink.Sink sink, java.util.ResourceBundle bundle, org.apache.maven.plugin.logging.Log log) build a new NcssReportGenerator.

Method Summary

protected void	codeCellHelper(java.lang.String text) sink helper to write cell containing code.
protected void	codeItemListHelper(java.lang.String text) sink helper to write a "code" itemList.
protected void	endSection() sink helper to end a section
org.apache.maven.plugin.logging.Log	getLog() Getter for the Log instance.
java.util.ResourceBundle	getResourceBundle() Getter for the RessourceBundle.
org.codehaus.doxia.sink.Sink	getSink() Getter for the Sink instance.
protected void	headerCellHelper(java.lang.String text) sink helper to write a simple table header cell.
protected void	paragraphHelper(java.lang.String text) sink helper to write a paragrah
protected void	startSection(java.lang.String link, java.lang.String title) sink helper to start a section.
protected void	subtitleHelper(java.lang.String text) sink helper to write a subtitle
protected void	tableCellHelper(java.lang.String text) sink helper to write a simple tabke cell.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNcssReportGenerator

protected AbstractNcssReportGenerator(org.codehaus.doxia.sink.Sink sink,
                                      java.util.ResourceBundle bundle,
                                      org.apache.maven.plugin.logging.Log log)

build a new NcssReportGenerator.

Parameters:

sink - the sink which will be used for reporting.

bundle - the correct RessourceBundle to be used for reporting.

log - the log object enabling logging within maven plugins.

Method Detail

getLog

public org.apache.maven.plugin.logging.Log getLog()

Getter for the Log instance.

Returns:

the current log instance associated with this report generator.

getSink

public org.codehaus.doxia.sink.Sink getSink()

Getter for the Sink instance.

Returns:

the current instance of Sink associated with this report generator.

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Getter for the RessourceBundle.

Returns:

the current ResourceBundle associated with this report generator.

codeItemListHelper

protected void codeItemListHelper(java.lang.String text)

sink helper to write a "code" itemList.

Parameters:

test - the text to write within the code tags.

paragraphHelper

protected void paragraphHelper(java.lang.String text)

sink helper to write a paragrah

Parameters:

the - text to write within the paragraph.

subtitleHelper

protected void subtitleHelper(java.lang.String text)

sink helper to write a subtitle

Parameters:

text - the text to write as a subtitle.

codeCellHelper

protected void codeCellHelper(java.lang.String text)

sink helper to write cell containing code.

Parameters:

text - the text to write within a cell and within code tags.

headerCellHelper

protected void headerCellHelper(java.lang.String text)

sink helper to write a simple table header cell.

Parameters:

text - the text to write within a table header cell.

tableCellHelper

protected void tableCellHelper(java.lang.String text)

sink helper to write a simple tabke cell.

Parameters:

text - the text to write within a table cell.

startSection

protected void startSection(java.lang.String link,
                            java.lang.String title)

sink helper to start a section.

Parameters:

locale - the locale to be used to display text within the section start.

link - the anchor link.

title - the title of the anchor link.

endSection

protected void endSection()

sink helper to end a section