001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program 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 * This program 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 java.util.List;
023import org.sonar.api.measures.Measure;
024import org.sonar.api.measures.MeasureUtils;
025import org.sonar.api.measures.Metric;
026import org.sonar.api.resources.Project;
027import org.sonar.api.resources.Resource;
028
029/**
030 * Sum measures of child resources.
031 *
032 * @since 1.10
033 * @deprecated since 5.2 there's no more decorator on batch side
034 */
035@Deprecated
036public abstract class AbstractSumChildrenDecorator implements Decorator {
037
038  /**
039   * Each metric is used individually. There are as many generated measures than metrics.
040   * <p><b>Important</b> : annotations are not inherited, so you have to copy the @DependedUpon annotation
041   * when implementing this method.
042   *
043   * @return not null list of metrics
044   */
045  @DependedUpon
046  public abstract List<Metric> generatesMetrics();
047
048  /**
049   * {@inheritDoc}
050   */
051  @Override
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  @Override
065  public void decorate(Resource resource, DecoratorContext context) {
066    if (!shouldDecorateResource(resource)) {
067      return;
068    }
069    for (Metric metric : generatesMetrics()) {
070      if (context.getMeasure(metric) == null) {
071        Double sum = MeasureUtils.sum(shouldSaveZeroIfNoChildMeasures(), context.getChildrenMeasures(metric));
072        if (sum != null) {
073          context.saveMeasure(new Measure(metric, sum));
074        }
075      }
076    }
077  }
078
079  /**
080   * @return whether the resource should be decorated or not
081   */
082  public boolean shouldDecorateResource(Resource resource) {
083    return true;
084  }
085
086  @Override
087  public String toString() {
088    return getClass().getSimpleName();
089  }
090}