org.codehaus.mojo.javancss
Class AbstractNcssReportGenerator

java.lang.Object
  extended by org.codehaus.mojo.javancss.AbstractNcssReportGenerator
Direct Known Subclasses:
NcssAggregateReportGenerator, NcssReportGenerator

public abstract class AbstractNcssReportGenerator
extends Object

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

Version:
$Id: AbstractNcssReportGenerator.java 9906 2009-06-02 15:04:27Z jeanlaurent $
Author:
Constructor Summary
protected AbstractNcssReportGenerator(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle, org.apache.maven.plugin.logging.Log log)
          build a new NcssReportGenerator.
 
Method Summary
protected  void codeCellHelper(String text)
          sink helper to write cell containing code.
protected  void codeItemListHelper(String text)
          sink helper to write a "code" itemList.
protected  void doIntro(boolean withNavigationBar)
          Output the report introduction.
protected  void endSection()
          sink helper to end a section
 org.apache.maven.plugin.logging.Log getLog()
          Getter for the Log instance.
 ResourceBundle getResourceBundle()
          Getter for the RessourceBundle.
 org.apache.maven.doxia.sink.Sink getSink()
          Getter for the Sink instance.
protected  String getString(String key)
          resource bundle helper to get a value.
protected  void headerCellHelper(String text)
          sink helper to write a simple table header cell.
protected  void navigationBar()
           
protected  void paragraphHelper(String text)
          sink helper to write a paragraph
protected  void startSection(String link, String title)
          sink helper to start a section.
protected  void subtitleHelper(String text)
          sink helper to write a subtitle
protected  void tableCellHelper(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.apache.maven.doxia.sink.Sink sink,
                                      ResourceBundle bundle,
                                      org.apache.maven.plugin.logging.Log log)
build a new NcssReportGenerator.

Parameters:
sink - the sink that 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.apache.maven.doxia.sink.Sink getSink()
Getter for the Sink instance.

Returns:
the current instance of Sink associated with this report generator.

getResourceBundle

public ResourceBundle getResourceBundle()
Getter for the RessourceBundle.

Returns:
the current ResourceBundle associated with this report generator.

codeItemListHelper

protected void codeItemListHelper(String text)
sink helper to write a "code" itemList.

Parameters:
text - the text to write within the code tags.

paragraphHelper

protected void paragraphHelper(String text)
sink helper to write a paragraph

Parameters:
text - the text to write within the paragraph.

subtitleHelper

protected void subtitleHelper(String text)
sink helper to write a subtitle

Parameters:
text - the text to write as a subtitle.

codeCellHelper

protected void codeCellHelper(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(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(String text)
sink helper to write a simple tabke cell.

Parameters:
text - the text to write within a table cell.

startSection

protected void startSection(String link,
                            String title)
sink helper to start a section.

Parameters:
link - the anchor link.
title - the title of the anchor link.

endSection

protected void endSection()
sink helper to end a section


getString

protected String getString(String key)
resource bundle helper to get a value.

Parameters:
key - the key for the desired string.
Returns:
the string for the given key.

doIntro

protected void doIntro(boolean withNavigationBar)
Output the report introduction.

Parameters:
withNavigationBar - a boolean stating wether or not the navigationBar should be displayed.

navigationBar

protected void navigationBar()


Copyright © 2005-2011 Codehaus. All Rights Reserved.