001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.batch;
021    
022    import org.sonar.api.measures.Measure;
023    import org.sonar.api.measures.MeasureUtils;
024    import org.sonar.api.measures.Metric;
025    import org.sonar.api.resources.Project;
026    import org.sonar.api.resources.Resource;
027    
028    import java.util.List;
029    
030    /**
031     * Sum measures of child resources.
032     *
033     * @since 1.10
034     */
035    public 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      public boolean shouldExecuteOnProject(Project project) {
050        return true;
051      }
052    
053      protected abstract boolean shouldSaveZeroIfNoChildMeasures();
054    
055      public void decorate(Resource resource, DecoratorContext context) {
056        if (!shouldDecorateResource(resource)) {
057          return;
058        }
059        for (Metric metric : generatesMetrics()) {
060          if (context.getMeasure(metric) == null) {
061            Double sum = MeasureUtils.sum(shouldSaveZeroIfNoChildMeasures(), context.getChildrenMeasures(metric));
062            if (sum != null) {
063              context.saveMeasure(new Measure(metric, sum));
064            }
065          }
066        }
067      }
068    
069      public boolean shouldDecorateResource(Resource resource) {
070        return true;
071      }
072    
073      @Override
074      public String toString() {
075        return getClass().getSimpleName();
076      }
077    }