Package net.sf.statcvs.output
Class ReportConfig
java.lang.Object
net.sf.statcvs.output.ReportConfig
A configuration object that controls several aspects of
report creation, such as the output directory and chart
sizes. A single instance is passed around to all objects
involved in report creation.
- Version:
- $Id: ReportConfig.java,v 1.12 2009/06/02 13:28:53 benoitx Exp $
- Author:
- Richard Cyganiak (richard@cyganiak.de)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final MarkupSyntax
static final MarkupSyntax
static final MarkupSyntax
-
Constructor Summary
ConstructorsConstructorDescriptionReportConfig
(Repository repository, String projectName, String rootDirectory, MarkupSyntax syntax, CssHandler cssHandler, String charSet) -
Method Summary
Modifier and TypeMethodDescriptionvoid
copyFileIntoReport
(URL source, String destinationFilename) Copies a file from a URL into the report.createChartImage
(String fileName, String title, org.jfree.chart.JFreeChart chart, Dimension size) Writes a chart image file.createPage
(String fileName, String shortTitle, String fullTitle) Creates an empty report page.boolean
isDeveloper
(Author author) void
setLargeChartSize
(Dimension newSize) void
setNonDeveloperLogins
(Collection names) void
setSmallChartSize
(Dimension newSize) void
setWebBugtracker
(BugTracker webBugtracker) void
setWebRepository
(WebRepositoryIntegration webRepository)
-
Field Details
-
XDOC
-
HTML
-
XML
-
-
Constructor Details
-
ReportConfig
public ReportConfig(Repository repository, String projectName, String rootDirectory, MarkupSyntax syntax, CssHandler cssHandler, String charSet)
-
-
Method Details
-
setSmallChartSize
-
setLargeChartSize
-
setWebRepository
-
setWebBugtracker
-
setNonDeveloperLogins
-
getRootDirectory
-
getRepository
-
getProjectName
-
getSmallChartSize
-
getLargeChartSize
-
getMarkup
-
getCssHandler
-
getWebRepository
-
getWebBugtracker
-
createPage
Creates an empty report page.- Parameters:
fileName
- The page's file name, relative to the root, without file extensionshortTitle
- A short title for use in navigation linksfullTitle
- The full title for the headline- Returns:
- An empty page according to the specifications
-
createChartImage
public ChartImage createChartImage(String fileName, String title, org.jfree.chart.JFreeChart chart, Dimension size) Writes a chart image file.- Parameters:
fileName
- The file's name, relative to the root.title
- The chart's titlechart
- The JFreeChart representationsize
- Width and height in pixels- Returns:
- An object representing the file
-
copyFileIntoReport
Copies a file from a URL into the report.- Parameters:
source
- The source filedestinationFilename
- The destination, relative to the report root, without initial slash.
-
isDeveloper
-
getCharSet
-