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.Collections;
023import java.util.List;
024
025/**
026 * @since 2.0
027 * @deprecated since 5.2 decorators are no more executed on batch side
028 */
029@Deprecated
030public class WeightedMeanAggregationFormula implements Formula {
031
032  private Metric weightingMetric;
033  private boolean zeroIfNoValues=false;
034
035  public WeightedMeanAggregationFormula(Metric weightingMetric, boolean zeroIfNoValues) {
036    this.weightingMetric = weightingMetric;
037    if (weightingMetric==null) {
038      throw new IllegalArgumentException("Metric can not be null");
039    }
040    this.zeroIfNoValues = zeroIfNoValues;
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    double count=0.0;
052    boolean hasValue=false;
053
054    for (FormulaData child : data.getChildren()) {
055      Measure measure = child.getMeasure(context.getTargetMetric());
056      Measure weightingMeasure = child.getMeasure(weightingMetric);
057      if (MeasureUtils.haveValues(measure, weightingMeasure)) {
058        sum += measure.getValue() * weightingMeasure.getValue();
059        count += weightingMeasure.getValue();
060        hasValue=true;
061      }
062    }
063
064    if (!hasValue && !zeroIfNoValues) {
065      return null;
066    }
067
068    double result = (Double.doubleToRawLongBits(count)==0L) ? 0.0 : (sum/count);
069    return new Measure(context.getTargetMetric(), result);
070  }
071}
072