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