de.smartics.exceptions.report.generator
Class AbstractHtmlReportGenerator

java.lang.Object
  de.smartics.exceptions.report.generator.AbstractReportGenerator<O>
      de.smartics.exceptions.report.generator.AbstractOutputReportGenerator<XMLStreamWriter>
          de.smartics.exceptions.report.generator.AbstractXmlReportGenerator
              de.smartics.exceptions.report.generator.AbstractHtmlReportGenerator

All Implemented Interfaces:

ReportGenerator< XMLStreamWriter>

Direct Known Subclasses:

HtmlReportGenerator

public abstract class AbstractHtmlReportGenerator
     
     

      
      extends 
      
      AbstractXmlReportGenerator
     
     

Simple generator that generates a HTML file.

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

AbstractHtmlReportGenerator(JavadocRenderer renderer) Default constructor.

Method Summary

protected void	writeContent(XMLStreamWriter xmlWriter, ProjectConfiguration<XMLStreamWriter> config, StoredExceptionCodesReport report) Writes the content of the XML document.
protected void	writeInfoFooter(XMLStreamWriter xmlWriter, ProjectConfiguration<XMLStreamWriter> config) Writes the footer for the report element set to the document.
protected void	writeInfoHeader(XMLStreamWriter xmlWriter, ProjectConfiguration<XMLStreamWriter> config, String headLine, ExceptionCodeReportItem item) Writes the header for the report.

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

createOutput, writeReport

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

getCodeTitle, getCurrentSelection, getItems, hasSectionChanged, write, writeFooter, writeHeader, writeInfoSubHeader, writeReportElementInfo, writeTableHeader

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

getEncoding, getOutput, setEncoding, setOutput

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHtmlReportGenerator

protected AbstractHtmlReportGenerator(JavadocRenderer renderer)

Default constructor.

Parameters:

renderer - the renderer used to map Javadoc comments to the report's output format.

Method Detail

writeContent

protected void writeContent(XMLStreamWriter xmlWriter,
                            ProjectConfiguration<XMLStreamWriter> config,
                            StoredExceptionCodesReport report)
                     throws Exception

Writes the content of the XML document. The XML declaration is already written.

Specified by:

writeContent in class AbstractReportGenerator<XMLStreamWriter>

Parameters:

xmlWriter - the writer to use.

config - the project configuration to control the output.

report - the information to write.

Throws:

Exception - on any problem encountered.

writeInfoHeader

protected void writeInfoHeader(XMLStreamWriter xmlWriter,
                               ProjectConfiguration<XMLStreamWriter> config,
                               String headLine,
                               ExceptionCodeReportItem item)
                        throws Exception

Writes the header for the report.

One of clazz or header may be null. If both are not null the implementation decides how to print.

Specified by:

writeInfoHeader in class AbstractOutputReportGenerator<XMLStreamWriter>

Parameters:

xmlWriter - the writer to write to.

config - the project configuration to control the output.

headLine - an head line text to print.

item - the information of the class whose elements are about to print.

Throws:

Exception - on any problem encountered.

writeInfoFooter

protected void writeInfoFooter(XMLStreamWriter xmlWriter,
                               ProjectConfiguration<XMLStreamWriter> config)
                        throws Exception

Writes the footer for the report element set to the document.

Specified by:

writeInfoFooter in class AbstractOutputReportGenerator<XMLStreamWriter>

Parameters:

xmlWriter - the writer to write to.

config - the project configuration to control the output.

Throws:

Exception - on any problem encountered.