org.sonar.report.pdf

Class PDFReporter

java.lang.Object

org.sonar.report.pdf.PDFReporter

Direct Known Subclasses:

DefaultPDFReporter, ExecutivePDFReporter

public abstract class PDFReporter
extends Object

This is the superclass of concrete reporters. It provides the access to Sonar data (project, measures, graphics) and report config data. The concrete reporter class will provide: sonar base URL, logo (it will be used in yhe PDF document), the project key and the implementation of printPdfBody method.

Constructor Summary

Constructors

Constructor and Description
PDFReporter(Credentials credentials)

Method Summary

Methods

Modifier and Type	Method and Description
com.lowagie.text.Image	getCCNDistribution(Project project)
String	getConfigProperty(String key)
protected abstract Properties	getLangProperties()
protected abstract URL	getLogo()
Project	getProject()
protected abstract String	getProjectKey()
ByteArrayOutputStream	getReport()
protected abstract Properties	getReportProperties()
abstract String	getReportType()
com.lowagie.text.Image	getTendencyImage(int tendencyQualitative, int tendencyCuantitative)
String	getTextProperty(String key)
protected abstract void	printFrontPage(com.lowagie.text.Document frontPageDocument, com.lowagie.text.pdf.PdfWriter frontPageWriter)
protected abstract void	printPdfBody(com.lowagie.text.Document document)
protected abstract void	printTocTitle(Toc tocDocument)

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFReporter

public PDFReporter(Credentials credentials)

Method Detail

getReport

public ByteArrayOutputStream getReport()
                                throws com.lowagie.text.DocumentException,
                                       IOException,
                                       ReportException

Throws:

com.lowagie.text.DocumentException

IOException

ReportException

getProject

public Project getProject()
                   throws org.sonar.api.utils.HttpDownloader.HttpException,
                          IOException,
                          ReportException

Throws:

org.sonar.api.utils.HttpDownloader.HttpException

IOException

ReportException

getCCNDistribution

public com.lowagie.text.Image getCCNDistribution(Project project)

getTextProperty

public String getTextProperty(String key)

getConfigProperty

public String getConfigProperty(String key)

getTendencyImage

public com.lowagie.text.Image getTendencyImage(int tendencyQualitative,
                                      int tendencyCuantitative)

printPdfBody

protected abstract void printPdfBody(com.lowagie.text.Document document)
                              throws com.lowagie.text.DocumentException,
                                     IOException,
                                     ReportException

Throws:

com.lowagie.text.DocumentException

IOException

ReportException

printTocTitle

protected abstract void printTocTitle(Toc tocDocument)
                               throws com.lowagie.text.DocumentException,
                                      IOException

Throws:

com.lowagie.text.DocumentException

IOException

getLogo

protected abstract URL getLogo()

getProjectKey

protected abstract String getProjectKey()

printFrontPage

protected abstract void printFrontPage(com.lowagie.text.Document frontPageDocument,
                  com.lowagie.text.pdf.PdfWriter frontPageWriter)
                                throws ReportException

Throws:

ReportException

getReportProperties

protected abstract Properties getReportProperties()

getLangProperties

protected abstract Properties getLangProperties()

getReportType

public abstract String getReportType()