de.smartics.maven.exceptions
Class AbstractSinkReportGenerator

java.lang.Object
  de.smartics.exceptions.report.generator.AbstractReportGenerator<O>
      de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>
          de.smartics.maven.exceptions.AbstractSinkReportGenerator

All Implemented Interfaces:

de.smartics.exceptions.report.generator.ReportGenerator<org.apache.maven.doxia.sink.Sink>

Direct Known Subclasses:

CodeSortedSinkReportGenerator, ComponentCodeSortedSinkReportGenerator, PackageSortedSinkReportGenerator

public abstract class AbstractSinkReportGenerator
     
     

      
      extends de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>
     
     

Simple generator that generates with a Maven sink.

Field Summary

Fields inherited from class de.smartics.exceptions.report.generator.AbstractReportGenerator

encoding, output, renderer

Fields inherited from interface de.smartics.exceptions.report.generator.ReportGenerator

DEFAULT_ENCODING

Constructor Summary

protected

AbstractSinkReportGenerator() Default constructor.

Method Summary

protected void	renderPlaceholderInfo(de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config, de.smartics.exceptions.report.data.ExceptionCodeReportItem item, org.apache.maven.doxia.sink.Sink sink)
protected void	writeContent(org.apache.maven.doxia.sink.Sink sink, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config, de.smartics.exceptions.report.data.StoredExceptionCodesReport report)
protected void	writeFooter(org.apache.maven.doxia.sink.Sink output, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config)
protected void	writeInfoFooter(org.apache.maven.doxia.sink.Sink sink, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config)
protected void	writeInfoHeader(org.apache.maven.doxia.sink.Sink output, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config, String headLine, de.smartics.exceptions.report.data.ExceptionCodeReportItem item) Writes the header and introduction text on a section 2.
protected void	writeInfoSubFooter(org.apache.maven.doxia.sink.Sink sink, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config)
protected void	writeInfoSubHeader(org.apache.maven.doxia.sink.Sink output, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config, String subHeader)
protected void	writeReportElementInfo(org.apache.maven.doxia.sink.Sink output, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config, de.smartics.exceptions.report.data.ExceptionCodeReportItem item)
protected void	writeTableHeader(org.apache.maven.doxia.sink.Sink sink, de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config) Writes the table header.

Methods inherited from class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator

getCodeTitle, getCurrentSelection, getItems, hasSectionChanged, write, writeHeader

Methods inherited from class de.smartics.exceptions.report.generator.AbstractReportGenerator

getEncoding, getOutput, setEncoding, setOutput, writeReport

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSinkReportGenerator

protected AbstractSinkReportGenerator()

Default constructor.

Method Detail

writeReportElementInfo

protected void writeReportElementInfo(org.apache.maven.doxia.sink.Sink output,
                                      de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config,
                                      de.smartics.exceptions.report.data.ExceptionCodeReportItem item)
                               throws Exception

Specified by:

writeReportElementInfo in class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>

Throws:

Exception

renderPlaceholderInfo

protected void renderPlaceholderInfo(de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config,
                                     de.smartics.exceptions.report.data.ExceptionCodeReportItem item,
                                     org.apache.maven.doxia.sink.Sink sink)

writeContent

protected void writeContent(org.apache.maven.doxia.sink.Sink sink,
                            de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config,
                            de.smartics.exceptions.report.data.StoredExceptionCodesReport report)
                     throws Exception

Specified by:

writeContent in class de.smartics.exceptions.report.generator.AbstractReportGenerator<org.apache.maven.doxia.sink.Sink>

Throws:

Exception

writeInfoFooter

protected void writeInfoFooter(org.apache.maven.doxia.sink.Sink sink,
                               de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config)
                        throws Exception

Specified by:

writeInfoFooter in class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>

Throws:

Exception

writeInfoSubFooter

protected void writeInfoSubFooter(org.apache.maven.doxia.sink.Sink sink,
                                  de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config)
                           throws Exception

Throws:

Exception

writeInfoHeader

protected void writeInfoHeader(org.apache.maven.doxia.sink.Sink output,
                               de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config,
                               String headLine,
                               de.smartics.exceptions.report.data.ExceptionCodeReportItem item)
                        throws Exception

Writes the header and introduction text on a section 2.

If no headLine is given, the qualified class name is written as section title instead.

Specified by:

writeInfoHeader in class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>

Parameters:

output - the output to write to.

config - not used in this implementation.

headLine - the text for the section header. May be null.

classDoc - the type information to render if headLine is null as section header and its comment to render as introduction text.

Throws:

Exception - on any problem encountered.

writeInfoSubHeader

protected void writeInfoSubHeader(org.apache.maven.doxia.sink.Sink output,
                                  de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config,
                                  String subHeader)

Overrides:

writeInfoSubHeader in class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>

writeTableHeader

protected void writeTableHeader(org.apache.maven.doxia.sink.Sink sink,
                                de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config)

Writes the table header.

Specified by:

writeTableHeader in class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>

Parameters:

output - the output to write to.

config - the project configuration to control the output.

writeFooter

protected void writeFooter(org.apache.maven.doxia.sink.Sink output,
                           de.smartics.exceptions.report.data.ProjectConfiguration<org.apache.maven.doxia.sink.Sink> config)

Overrides:

writeFooter in class de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<org.apache.maven.doxia.sink.Sink>