Package org.myire.scent.report

Class XslReportWriter

java.lang.Object

org.myire.scent.report.XslReportWriter

All Implemented Interfaces:

MetricsReportWriter

@NotThreadSafe
public class XslReportWriter
extends java.lang.Object
implements MetricsReportWriter

An XslReportWriter creates metrics reports by applying an XSL transformation to an XML report produced by an XmlReportWriter. The report is written to an OutputStream.

Instances of this class are not safe for use by multiple threads without external synchronization.

Author:

Peter Franzen

Constructor Summary

Constructors

Constructor	Description
XslReportWriter(java.io.OutputStream pOutputStream, java.io.File pXslFile)	Create a new XslReportWriter that gets its XSL style sheet from a file.
XslReportWriter(java.io.OutputStream pOutputStream, java.lang.String pXslResource)	Create a new XslReportWriter that gets its XSL style sheet from a classpath resource.

Method Summary

Modifier and Type	Method	Description
void	writeReport(JavaMetrics pMetrics, MetricsReportMetaData pMetaData)	Write a report for the source code metrics in a JavaMetrics instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

XslReportWriter

public XslReportWriter(@Nonnull
                       java.io.OutputStream pOutputStream,
                       @Nonnull
                       java.io.File pXslFile)

Create a new XslReportWriter that gets its XSL style sheet from a file.

Parameters:

pOutputStream - The stream to write the report to.

pXslFile - A file containing the XSL style sheet to create the report with.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

XslReportWriter

public XslReportWriter(@Nonnull
                       java.io.OutputStream pOutputStream,
                       @Nonnull
                       java.lang.String pXslResource)

Create a new XslReportWriter that gets its XSL style sheet from a classpath resource.

Parameters:

pOutputStream - The stream to write the report to.

pXslResource - The name of the resource containing the XSL style sheet.

Throws:

java.lang.NullPointerException - if any of the parameters is null.

Method Detail

writeReport

public void writeReport(@Nonnull
                        JavaMetrics pMetrics,
                        @Nonnull
                        MetricsReportMetaData pMetaData)
                 throws java.io.IOException

Description copied from interface: MetricsReportWriter

Write a report for the source code metrics in a JavaMetrics instance.

Specified by:

writeReport in interface MetricsReportWriter

Parameters:

pMetrics - The metrics to get the report data from.

pMetaData - The report's meta data.

Throws:

java.io.IOException - if writing the report fails.