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.CoreMetrics;
023    import org.sonar.api.measures.MeasureUtils;
024    import org.sonar.api.measures.Metric;
025    import org.sonar.api.resources.Language;
026    import org.sonar.api.resources.Project;
027    import org.sonar.api.resources.Resource;
028    import org.sonar.api.resources.ResourceUtils;
029    
030    import java.util.Arrays;
031    import java.util.List;
032    
033    /**
034     * @since 1.10
035     */
036    public abstract class AbstractFileComplexityDecorator implements Decorator {
037    
038      private Language language;
039    
040      public AbstractFileComplexityDecorator(Language language) {
041        this.language = language;
042      }
043    
044      public boolean shouldExecuteOnProject(Project project) {
045        return language.equals(project.getLanguage());
046      }
047    
048      @DependsUpon
049      public List<Metric> dependsUponFileAndComplexityMetrics() {
050        return Arrays.asList(CoreMetrics.FILES, CoreMetrics.COMPLEXITY);
051      }
052    
053      @DependedUpon
054      public Metric generateFileComplexityMetric() {
055        return CoreMetrics.FILE_COMPLEXITY;
056      }
057    
058      public void decorate(Resource resource, DecoratorContext context) {
059        if (!shouldDecorateResource(resource, context)) {
060          return;
061        }
062        Double files = MeasureUtils.getValue(context.getMeasure(CoreMetrics.FILES), null);
063        Double complexity = MeasureUtils.getValue(context.getMeasure(CoreMetrics.COMPLEXITY), null);
064        if (complexity != null && files != null && files > 0.0) {
065          context.saveMeasure(CoreMetrics.FILE_COMPLEXITY, complexity / files);
066        }
067      }
068    
069      private boolean shouldDecorateResource(Resource resource, DecoratorContext context) {
070        return !MeasureUtils.hasValue(context.getMeasure(CoreMetrics.FILE_COMPLEXITY)) && !ResourceUtils.isEntity(resource);
071      }
072    }