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