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 1.11
027 */
028public class SumChildValuesFormula implements Formula {
029
030  private boolean saveZeroIfNoChildValues;
031
032  public SumChildValuesFormula(boolean saveZeroIfNoChildValues) {
033    this.saveZeroIfNoChildValues = saveZeroIfNoChildValues;
034  }
035
036  @Override
037  public List<Metric> dependsUponMetrics() {
038    return Collections.emptyList();
039  }
040
041  @Override
042  public Measure calculate(FormulaData data, FormulaContext context) {
043    Double sum = MeasureUtils.sum(saveZeroIfNoChildValues, data.getChildrenMeasures(context.getTargetMetric()));
044    if (sum != null) {
045      return new Measure(context.getTargetMetric(), sum);
046    }
047    return null;
048  }
049}