org.apache.rat.report.xml

Class XmlReportFactory

java.lang.Object

org.apache.rat.report.xml.XmlReportFactory

public final class XmlReportFactory
extends Object

A factory to create reports from a writer and a configuration.

Method Summary

Modifier and Type	Method and Description
static RatReport	createStandardReport(IXmlWriter writer, ClaimStatistic statistic, ReportConfiguration configuration) Creates a RatReport from the arguments.
static void	endReport(IXmlWriter writer) Ends the XML reprot by closing the element that startReport opened.
static void	startReport(IXmlWriter writer) Starts the XML report by writing the standard header into the writer.

Methods inherited from class java.lang.Object

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

Method Detail

createStandardReport

public static RatReport createStandardReport(IXmlWriter writer,
                                             ClaimStatistic statistic,
                                             ReportConfiguration configuration)

Creates a RatReport from the arguments. The statistic is used to create a ClaimAggregator. If the configuration indicates that licenses should be added a LicenseAddingReport is added.

Parameters:

writer - The XML writer to send output to.

statistic - the ClaimStatistics for the report. may be null.

configuration - The report configuration.

Returns:

a RatReport instance.

startReport

public static void startReport(IXmlWriter writer)
                        throws RatException

Starts the XML report by writing the standard header into the writer.

Parameters:

writer - The writer to write into

Throws:

RatException - on error

endReport

public static void endReport(IXmlWriter writer)
                      throws RatException

Ends the XML reprot by closing the element that startReport opened.

Parameters:

writer - the write to write into.

Throws:

RatException - on error

See Also:

startReport(IXmlWriter)