001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * SonarQube is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.measures;
021    
022    import org.sonar.api.resources.Scopes;
023    
024    import java.util.Collection;
025    import java.util.Collections;
026    import java.util.List;
027    
028    /**
029     * @since 2.0
030     *
031     * Used to consolidate a distribution measure throughout the resource tree
032     */
033    public class SumChildDistributionFormula implements Formula {
034    
035      private String minimumScopeToPersist= Scopes.FILE;
036    
037      public List<Metric> dependsUponMetrics() {
038        return Collections.emptyList();
039      }
040    
041      public String getMinimumScopeToPersist() {
042        return minimumScopeToPersist;
043      }
044    
045      public SumChildDistributionFormula setMinimumScopeToPersist(String s) {
046        this.minimumScopeToPersist = s;
047        return this;
048      }
049    
050      public Measure calculate(FormulaData data, FormulaContext context) {
051        Collection<Measure> measures = data.getChildrenMeasures(context.getTargetMetric());
052        if (measures == null || measures.isEmpty()) {
053          return null;
054        }
055        RangeDistributionBuilder distribution = new RangeDistributionBuilder(context.getTargetMetric());
056        for (Measure measure : measures) {
057          distribution.add(measure);
058        }
059        Measure measure = distribution.build();
060        if (!Scopes.isHigherThanOrEquals(context.getResource().getScope(), minimumScopeToPersist)) {
061          measure.setPersistenceMode(PersistenceMode.MEMORY);
062        }
063        return measure;
064      }
065    }