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.batch;
021
022import org.sonar.api.measures.Measure;
023import org.sonar.api.measures.MeasureUtils;
024import org.sonar.api.measures.Metric;
025import org.sonar.api.resources.Project;
026import org.sonar.api.resources.Resource;
027
028import java.util.List;
029
030/**
031 * Sum measures of child resources.
032 *
033 * @since 1.10
034 */
035public abstract class AbstractSumChildrenDecorator implements Decorator {
036
037
038  /**
039   * Each metric is used individually. There are as many generated measures than metrics.
040   * <p/>
041   * <p><b>Important</b> : annotations are not inherited, so you have to copy the @DependedUpon annotation
042   * when implementing this method.</p>
043   *
044   * @return not null list of metrics
045   */
046  @DependedUpon
047  public abstract List<Metric> generatesMetrics();
048
049  /**
050   * {@inheritDoc}
051   */
052  public boolean shouldExecuteOnProject(Project project) {
053    return true;
054  }
055
056  /**
057   * @return whether it should save zero if no child measures
058   */
059  protected abstract boolean shouldSaveZeroIfNoChildMeasures();
060
061  /**
062   * {@inheritDoc}
063   */
064  public void decorate(Resource resource, DecoratorContext context) {
065    if (!shouldDecorateResource(resource)) {
066      return;
067    }
068    for (Metric metric : generatesMetrics()) {
069      if (context.getMeasure(metric) == null) {
070        Double sum = MeasureUtils.sum(shouldSaveZeroIfNoChildMeasures(), context.getChildrenMeasures(metric));
071        if (sum != null) {
072          context.saveMeasure(new Measure(metric, sum));
073        }
074      }
075    }
076  }
077
078  /**
079   * @return whether the resource should be decorated or not
080   */
081  public boolean shouldDecorateResource(Resource resource) {
082    return true;
083  }
084
085  @Override
086  public String toString() {
087    return getClass().getSimpleName();
088  }
089}