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 Details

    • createStandardReport

      public static RatReport createStandardReport(XmlWriter 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.

    • simple

      public static RatReport simple(XmlWriter writer)
      Creates a simple claim reporter.
      Parameters:
      writer - The XmlWriter to use
      Returns:
      the RatReport that will write to the writer.

    • validator

      public static RatReport validator(XmlWriter writer, ClaimStatistic statistic, ReportConfiguration configuration)
      Creates a simple claim validator reporter
      Parameters:
      writer - The XmlWriter to use
      Returns:
      the RatReport that will write to the writer.

    • configuration

      public static RatReport configuration(XmlWriter writer, ReportConfiguration configuration)
      Creates a configuration report
      Parameters:
      writer - The writer to write the XML data to.
      configuration - the configuration to write

    • multiplexer

      public static RatReport multiplexer(XmlWriter writer, boolean dryRun, DocumentAnalyser analyser, List<? extends RatReport> reporters)
      Creates a RatReport that multiplexes the running of multiple RatReports