Google Git
Sign in
apache / creadur-site / refs/heads/asf-site / . / rat017 / apache-rat-core / xref / org / apache / rat / report / xml / XmlReportFactory.html
blob: 63c6d9ca01bd483653587f6ecb4a42361f46a5e7 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>XmlReportFactory xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/rat/report/xml/XmlReportFactory.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one *</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file *</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information *</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file *</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the *</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance *</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, *</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an *</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the *</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations *</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License. *</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.rat.report.xml;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.time.DateFormatUtils;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.rat.ReportConfiguration;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.rat.analysis.DefaultAnalyserFactory;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.rat.api.RatException;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.rat.document.IDocumentAnalyser;
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.rat.document.impl.util.DocumentAnalyserMultiplexer;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.rat.license.LicenseSetFactory.LicenseFilter;
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.rat.policy.DefaultPolicy;
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.ConfigurationReport;
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.RatReport;
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.claim.ClaimStatistic;
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.claim.impl.ClaimAggregator;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.claim.impl.xml.SimpleXmlClaimReporter;
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.claim.util.ClaimReporterMultiplexer;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.claim.util.LicenseAddingReport;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.xml.writer.IXmlWriter;
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> java.util.Calendar;
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="L42" href="#L42">42</a>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * A factory to create reports from a writer and a configuration.</em>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="XmlReportFactory" href="../../../../../org/apache/rat/report/xml/XmlReportFactory.html#XmlReportFactory">XmlReportFactory</a> {
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String RAT_REPORT = <span class="jxr_string">"rat-report"</span>;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String TIMESTAMP = <span class="jxr_string">"timestamp"</span>;
<a class="jxr_linenumber" name="L49" href="#L49">49</a>
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <a name="XmlReportFactory" href="../../../../../org/apache/rat/report/xml/XmlReportFactory.html#XmlReportFactory">XmlReportFactory</a>() {
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_comment">// Do not instantiate</em>
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Creates a RatReport from the arguments.</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * The {@code statistic} is used to create a ClaimAggregator.</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * If the {@code configuration} indicates that licenses should be added a LicenseAddingReport is added.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @param writer The XML writer to send output to.</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param statistic the ClaimStatistics for the report. may be null.</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * @param configuration The report configuration.</em>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * @return a RatReport instance.</em>
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="RatReport" href="../../../../../org/apache/rat/report/RatReport.html#RatReport">RatReport</a> createStandardReport(<strong class="jxr_keyword">final</strong> <a name="IXmlWriter" href="../../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, <strong class="jxr_keyword">final</strong> <a name="ClaimStatistic" href="../../../../../org/apache/rat/report/claim/ClaimStatistic.html#ClaimStatistic">ClaimStatistic</a> statistic, <strong class="jxr_keyword">final</strong> <a name="ReportConfiguration" href="../../../../../org/apache/rat/ReportConfiguration.html#ReportConfiguration">ReportConfiguration</a> configuration) {
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">final</strong> List&lt;RatReport&gt; reporters = <strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;();
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (statistic != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L67" href="#L67">67</a> reporters.add(<strong class="jxr_keyword">new</strong> <a name="ClaimAggregator" href="../../../../../org/apache/rat/report/claim/impl/ClaimAggregator.html#ClaimAggregator">ClaimAggregator</a>(statistic));
<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">if</strong> (configuration.isAddingLicenses() &amp;&amp; !configuration.isDryRun()) {
<a class="jxr_linenumber" name="L70" href="#L70">70</a> reporters.add(<strong class="jxr_keyword">new</strong> <a name="LicenseAddingReport" href="../../../../../org/apache/rat/report/claim/util/LicenseAddingReport.html#LicenseAddingReport">LicenseAddingReport</a>(configuration.getLog(), configuration.getCopyrightMessage(), configuration.isAddingLicensesForced()));
<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
<a class="jxr_linenumber" name="L72" href="#L72">72</a>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">if</strong> (configuration.listFamilies() != LicenseFilter.NONE || configuration.listLicenses() != LicenseFilter.NONE) {
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> reporters.add(<strong class="jxr_keyword">new</strong> <a name="ConfigurationReport" href="../../../../../org/apache/rat/report/ConfigurationReport.html#ConfigurationReport">ConfigurationReport</a>(writer, configuration));
<a class="jxr_linenumber" name="L76" href="#L76">76</a> }
<a class="jxr_linenumber" name="L77" href="#L77">77</a>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> reporters.add(<strong class="jxr_keyword">new</strong> <a name="SimpleXmlClaimReporter" href="../../../../../org/apache/rat/report/claim/impl/xml/SimpleXmlClaimReporter.html#SimpleXmlClaimReporter">SimpleXmlClaimReporter</a>(writer));
<a class="jxr_linenumber" name="L79" href="#L79">79</a>
<a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">final</strong> <a name="IDocumentAnalyser" href="../../../../../org/apache/rat/document/IDocumentAnalyser.html#IDocumentAnalyser">IDocumentAnalyser</a> analyser = DefaultAnalyserFactory.createDefaultAnalyser(configuration);
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">final</strong> <a name="DefaultPolicy" href="../../../../../org/apache/rat/policy/DefaultPolicy.html#DefaultPolicy">DefaultPolicy</a> policy = <strong class="jxr_keyword">new</strong> <a name="DefaultPolicy" href="../../../../../org/apache/rat/policy/DefaultPolicy.html#DefaultPolicy">DefaultPolicy</a>(configuration.getLicenseFamilies(LicenseFilter.APPROVED));
<a class="jxr_linenumber" name="L82" href="#L82">82</a>
<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">final</strong> <a name="IDocumentAnalyser" href="../../../../../org/apache/rat/document/IDocumentAnalyser.html#IDocumentAnalyser">IDocumentAnalyser</a>[] analysers = {analyser, policy};
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <a name="DocumentAnalyserMultiplexer" href="../../../../../org/apache/rat/document/impl/util/DocumentAnalyserMultiplexer.html#DocumentAnalyserMultiplexer">DocumentAnalyserMultiplexer</a> analysisMultiplexer = <strong class="jxr_keyword">new</strong> <a name="DocumentAnalyserMultiplexer" href="../../../../../org/apache/rat/document/impl/util/DocumentAnalyserMultiplexer.html#DocumentAnalyserMultiplexer">DocumentAnalyserMultiplexer</a>(analysers);
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a name="ClaimReporterMultiplexer" href="../../../../../org/apache/rat/report/claim/util/ClaimReporterMultiplexer.html#ClaimReporterMultiplexer">ClaimReporterMultiplexer</a>(writer, configuration.isDryRun(), analysisMultiplexer, reporters);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> }
<a class="jxr_linenumber" name="L87" href="#L87">87</a>
<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Starts the XML report by writing the standard header into the writer.</em>
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * @param writer The writer to write into</em>
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * @throws RatException on error</em>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> startReport(<strong class="jxr_keyword">final</strong> <a name="IXmlWriter" href="../../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer) <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> {
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L95" href="#L95">95</a> writer.openElement(RAT_REPORT).attribute(TIMESTAMP, DateFormatUtils.ISO_8601_EXTENDED_DATETIME_TIME_ZONE_FORMAT.format(Calendar.getInstance()));
<a class="jxr_linenumber" name="L96" href="#L96">96</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="RatException" href="../../../../../org/apache/rat/api/RatException.html#RatException">RatException</a>(<span class="jxr_string">"Cannot open start element"</span>, e);
<a class="jxr_linenumber" name="L98" href="#L98">98</a> }
<a class="jxr_linenumber" name="L99" href="#L99">99</a> }
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * Ends the XML reprot by closing the element that startReport opened.</em>
<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * @param writer the write to write into.</em>
<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * @throws RatException on error</em>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @see #startReport(IXmlWriter)</em>
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> endReport(<strong class="jxr_keyword">final</strong> <a name="IXmlWriter" href="../../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer) <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> {
<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="L109" href="#L109">109</a> writer.closeElement();
<a class="jxr_linenumber" name="L110" href="#L110">110</a> } <strong class="jxr_keyword">catch</strong> (IOException e) {
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="RatException" href="../../../../../org/apache/rat/api/RatException.html#RatException">RatException</a>(<span class="jxr_string">"Cannot close start element: "</span> + RAT_REPORT, e);
<a class="jxr_linenumber" name="L112" href="#L112">112</a> }
<a class="jxr_linenumber" name="L113" href="#L113">113</a> }
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2006&#x2013;2024 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>