Google Git
Sign in
apache / creadur-site / 884397342c3371df8a501072a271104b6416a3a1 / . / xref / org / apache / rat / report / claim / impl / ClaimAggregator.html
blob: 9498fe981c11ad2d9c2dead8d3fbfffd920d3be0 [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>ClaimAggregator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/rat/report/claim/impl/ClaimAggregator.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>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <strong class="jxr_keyword">package</strong> org.apache.rat.report.claim.impl;
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.rat.api.MetaData;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.rat.api.RatException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.claim.ClaimStatistic;
<a class="jxr_linenumber" name="L25" href="#L25">25</a>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashMap;
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="L28" href="#L28">28</a>
<a class="jxr_linenumber" name="L29" href="#L29">29</a>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * The aggregator is used to create a numerical statistic</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * of claims.</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/rat/report/claim/impl/ClaimAggregator.html">ClaimAggregator</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/rat/report/claim/impl/AbstractClaimReporter.html">AbstractClaimReporter</a> {
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/rat/report/claim/ClaimStatistic.html">ClaimStatistic</a> statistic;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;String, Integer&gt; numsByLicenseFamilyName = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Integer&gt;();
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;String, Integer&gt; numsByLicenseFamilyCode = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Integer&gt;();
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map&lt;String, Integer&gt; numsByFileType = <strong class="jxr_keyword">new</strong> HashMap&lt;String, Integer&gt;();
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> numApproved, numUnApproved, numGenerated, numUnknown;
<a class="jxr_linenumber" name="L40" href="#L40">40</a>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/rat/report/claim/impl/ClaimAggregator.html">ClaimAggregator</a>(<a href="../../../../../../org/apache/rat/report/claim/ClaimStatistic.html">ClaimStatistic</a> pStatistic) {
<a class="jxr_linenumber" name="L42" href="#L42">42</a> statistic = pStatistic;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> }
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> incMapValue(Map&lt;String, Integer&gt; pMap, String pKey) {
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">final</strong> Integer num = pMap.get(pKey);
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> newNum;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">if</strong> (num == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L49" href="#L49">49</a> newNum = 1;
<a class="jxr_linenumber" name="L50" href="#L50">50</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L51" href="#L51">51</a> newNum = num + 1;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a> pMap.put(pKey, newNum);
<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
<a class="jxr_linenumber" name="L55" href="#L55">55</a>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> @Override
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> handleDocumentCategoryClaim(String documentCategoryName) {
<a class="jxr_linenumber" name="L58" href="#L58">58</a> incMapValue(numsByFileType, documentCategoryName);
<a class="jxr_linenumber" name="L59" href="#L59">59</a> }
<a class="jxr_linenumber" name="L60" href="#L60">60</a>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> @Override
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> handleApprovedLicenseClaim(String licenseApproved) {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">if</strong> (MetaData.RAT_APPROVED_LICENSE_VALUE_TRUE.equals(licenseApproved)) {
<a class="jxr_linenumber" name="L64" href="#L64">64</a> numApproved++;
<a class="jxr_linenumber" name="L65" href="#L65">65</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> numUnApproved++;
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
<a class="jxr_linenumber" name="L69" href="#L69">69</a>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> @Override
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> handleLicenseFamilyNameClaim(String licenseFamilyName) {
<a class="jxr_linenumber" name="L72" href="#L72">72</a> incMapValue(numsByLicenseFamilyName, licenseFamilyName);
<a class="jxr_linenumber" name="L73" href="#L73">73</a> }
<a class="jxr_linenumber" name="L74" href="#L74">74</a>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> @Override
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> handleHeaderCategoryClaim(String headerCategory) {
<a class="jxr_linenumber" name="L77" href="#L77">77</a>
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">if</strong> (MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN.equals(headerCategory)) {
<a class="jxr_linenumber" name="L79" href="#L79">79</a> numGenerated++;
<a class="jxr_linenumber" name="L80" href="#L80">80</a> incMapValue(numsByLicenseFamilyCode, MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_GEN);
<a class="jxr_linenumber" name="L81" href="#L81">81</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN.equals(headerCategory)) {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> numUnknown++;
<a class="jxr_linenumber" name="L83" href="#L83">83</a> incMapValue(numsByLicenseFamilyCode, MetaData.RAT_LICENSE_FAMILY_CATEGORY_VALUE_UNKNOWN);
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
<a class="jxr_linenumber" name="L86" href="#L86">86</a>
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> fillClaimStatistic(<a href="../../../../../../org/apache/rat/report/claim/ClaimStatistic.html">ClaimStatistic</a> pStatistic) {
<a class="jxr_linenumber" name="L88" href="#L88">88</a> pStatistic.setDocumentCategoryMap(numsByFileType);
<a class="jxr_linenumber" name="L89" href="#L89">89</a> pStatistic.setLicenseFileCodeMap(numsByLicenseFamilyCode);
<a class="jxr_linenumber" name="L90" href="#L90">90</a> pStatistic.setLicenseFileNameMap(numsByLicenseFamilyName);
<a class="jxr_linenumber" name="L91" href="#L91">91</a> pStatistic.setNumApproved(numApproved);
<a class="jxr_linenumber" name="L92" href="#L92">92</a> pStatistic.setNumGenerated(numGenerated);
<a class="jxr_linenumber" name="L93" href="#L93">93</a> pStatistic.setNumUnApproved(numUnApproved);
<a class="jxr_linenumber" name="L94" href="#L94">94</a> pStatistic.setNumUnknown(numUnknown);
<a class="jxr_linenumber" name="L95" href="#L95">95</a> }
<a class="jxr_linenumber" name="L96" href="#L96">96</a>
<a class="jxr_linenumber" name="L97" href="#L97">97</a> @Override
<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> endReport() <strong class="jxr_keyword">throws</strong> RatException {
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">super</strong>.endReport();
<a class="jxr_linenumber" name="L100" href="#L100">100</a> fillClaimStatistic(statistic);
<a class="jxr_linenumber" name="L101" href="#L101">101</a> }
<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2006&#x2013;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>