net.sourceforge.groboutils.codecoverage.v2.ant
Class SimpleXslReportStyle

java.lang.Object
  net.sourceforge.groboutils.codecoverage.v2.ant.SimpleXslReportStyle

All Implemented Interfaces:

IReportStyle

Direct Known Subclasses:

SimpleHtmlReportStyle

public class SimpleXslReportStyle

extends java.lang.Object

implements IReportStyle

Describes a report style, used to generate readable reports from the XML output.

Since:

March 15, 2004

Version:

$Date: 2004/04/15 05:48:25 $

Author:

Matt Albrecht groboclown@users.sourceforge.net

Nested Class Summary

static class

SimpleXslReportStyle.ParamType

Constructor Summary

SimpleXslReportStyle()

Method Summary

void	addParam(SimpleXslReportStyle.ParamType pt)
void	generateReport(org.apache.tools.ant.Project project, org.w3c.dom.Document doc, java.lang.String moduleName)
protected StyleTransformer	getHtmlStyle(org.apache.tools.ant.Project project)
protected StyleTransformer	getRemoveEmptiesStyle(org.apache.tools.ant.Project project)
protected java.lang.String	getStylesheetSystemId() Get the systemid of the appropriate stylesheet based on its name and styledir.
protected java.lang.String	getStylesheetSystemIdForClass(java.lang.String xslname)
void	reportComplete(org.apache.tools.ant.Project project, java.util.Vector errors) Called when the task is finished generating all the reports.
void	setDestDir(java.io.File dir)
void	setPrefix(java.lang.String p)
void	setRemoveEmpty(boolean on)
void	setStyle(java.io.File f)
void	setStyleURL(java.lang.String url)
void	setSuffix(java.lang.String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleXslReportStyle

public SimpleXslReportStyle()

Method Detail

setPrefix

public void setPrefix(java.lang.String p)

setSuffix

public void setSuffix(java.lang.String s)

setDestDir

public void setDestDir(java.io.File dir)

setRemoveEmpty

public void setRemoveEmpty(boolean on)

setStyle

public void setStyle(java.io.File f)

setStyleURL

public void setStyleURL(java.lang.String url)

addParam

public void addParam(SimpleXslReportStyle.ParamType pt)

reportComplete

public void reportComplete(org.apache.tools.ant.Project project,
                           java.util.Vector errors)
                    throws org.apache.tools.ant.BuildException,
                           java.io.IOException

Called when the task is finished generating all the reports. This may be useful for styles that join all the reports together.

Specified by:

reportComplete in interface IReportStyle

Throws:

org.apache.tools.ant.BuildException

java.io.IOException

generateReport

public void generateReport(org.apache.tools.ant.Project project,
                           org.w3c.dom.Document doc,
                           java.lang.String moduleName)
                    throws org.apache.tools.ant.BuildException,
                           java.io.IOException

Specified by:

generateReport in interface IReportStyle

Parameters:

doc - the XML document of the coverage report to process.

Throws:

org.apache.tools.ant.BuildException

java.io.IOException

getRemoveEmptiesStyle

protected StyleTransformer getRemoveEmptiesStyle(org.apache.tools.ant.Project project)
                                          throws java.io.IOException

Throws:

java.io.IOException

getHtmlStyle

protected StyleTransformer getHtmlStyle(org.apache.tools.ant.Project project)
                                 throws java.io.IOException

Throws:

java.io.IOException

getStylesheetSystemId

protected java.lang.String getStylesheetSystemId()
                                          throws java.io.IOException

Get the systemid of the appropriate stylesheet based on its name and styledir. If no styledir is defined it will load it as a java resource in the xsl child package, otherwise it will get it from the given directory.

Throws:

java.io.IOException - thrown if the requested stylesheet does not exist.

getStylesheetSystemIdForClass

protected java.lang.String getStylesheetSystemIdForClass(java.lang.String xslname)
                                                  throws java.io.IOException

Throws:

java.io.IOException