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 */
020package org.sonar.api.measures;
021
022import org.sonar.api.resources.Scopes;
023
024import java.util.Collection;
025import java.util.Collections;
026import java.util.List;
027
028/**
029 * @since 2.0
030 *
031 * Used to consolidate a distribution measure throughout the resource tree
032 */
033public class SumChildDistributionFormula implements Formula {
034
035  private String minimumScopeToPersist= Scopes.FILE;
036
037  @Override
038  public List<Metric> dependsUponMetrics() {
039    return Collections.emptyList();
040  }
041
042  public String getMinimumScopeToPersist() {
043    return minimumScopeToPersist;
044  }
045
046  public SumChildDistributionFormula setMinimumScopeToPersist(String s) {
047    this.minimumScopeToPersist = s;
048    return this;
049  }
050
051  @Override
052  public Measure calculate(FormulaData data, FormulaContext context) {
053    Collection<Measure> measures = data.getChildrenMeasures(context.getTargetMetric());
054    if (measures == null || measures.isEmpty()) {
055      return null;
056    }
057    RangeDistributionBuilder distribution = new RangeDistributionBuilder(context.getTargetMetric());
058    for (Measure measure : measures) {
059      distribution.add(measure);
060    }
061    Measure measure = distribution.build();
062    if (!Scopes.isHigherThanOrEquals(context.getResource().getScope(), minimumScopeToPersist)) {
063      measure.setPersistenceMode(PersistenceMode.MEMORY);
064    }
065    return measure;
066  }
067}