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;
025
026/**
027 * @since 2.0
028 * @deprecated since 5.2 decorators are no more executed on batch side
029 */
030@Deprecated
031public class MeanAggregationFormula implements Formula {
032
033  private boolean forceZeroIfMissingData=false;
034
035  public MeanAggregationFormula(boolean forceZeroIfMissingData) {
036    this.forceZeroIfMissingData = forceZeroIfMissingData;
037  }
038
039  public MeanAggregationFormula() {
040    this(false);
041  }
042
043  @Override
044  public List<Metric> dependsUponMetrics() {
045    return Collections.emptyList();
046  }
047
048  @Override
049  public Measure calculate(FormulaData data, FormulaContext context) {
050    double sum=0.0;
051    int count=0;
052    boolean hasValue=false;
053    Collection<Measure> measures = data.getChildrenMeasures(context.getTargetMetric());
054    for (Measure measure : measures) {
055      if (MeasureUtils.hasValue(measure)) {
056        sum+=measure.getValue();
057        count++;
058        hasValue=true;
059      }
060    }
061
062    if (!hasValue && !forceZeroIfMissingData) {
063      return null;
064    }
065    return new Measure(context.getTargetMetric(), (count==0) ? 0.0 : (sum/count));
066  }
067}