[jira] [Created] (RAT-570) Create Reporter.Output to contain context and result of reporter execution.

["Claude Warren (Jira)" <ji...@apache.org>]

Claude Warren created RAT-570:
---------------------------------

             Summary: Create Reporter.Output to contain context and result of reporter execution.
                 Key: RAT-570
                 URL: https://issues.apache.org/jira/browse/RAT-570
             Project: Apache RAT
          Issue Type: Improvement
          Components: core engine
    Affects Versions: 0.18
            Reporter: Claude Warren
             Fix For: 1.0.0


Currently RAT reporter execution return the ClaimStatistic for the execution, but loses the configuration and command line contexts as well as the document that was generated during the execution.

This change is to define a Reporter.Output class that will contain the configuration that was used for the execution, the XML document that was produced,  and the ClaimStatistic that captures the numbers various types of files, licenses, license categories and other statistics from the run.

 

The Reporter.execute() will create a Reporter.Output and will not automatically format the output as specified in the configuration.  Formatting output becomes a second step.

Reporter.Output will have 2 methods to format the output 
 * format(ReportConfiguration) - will use the output and stylesheet defined in the configuration to format the output.
 * format(IOSupplier stylesheet, IOSupplier output) - will apply an arbitrary stylsheet against the contained document and send the output to the locateion specified.

The Reporter will be able to serialize the result to 

This change will make it easier for the Maven version to generate the document in the Mojo.check method and the final output in the Mojo.report method without regenerating the report. 

The Reporter.Output will be immutable and constructed using a builder pattern.

The builder will be able to read the 3 components (Configuration, XML document,  and ClaimStatistic) from input streams.  Each of those components will be extended to include a Serde implementation to write to, and restore from and IO stream.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)