001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2008-2012 SonarSource
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.plugins.design.batch;
021    
022    import org.sonar.api.batch.Decorator;
023    import org.sonar.api.batch.DecoratorContext;
024    import org.sonar.api.batch.DependedUpon;
025    import org.sonar.api.batch.DependsUpon;
026    import org.sonar.api.measures.Measure;
027    import org.sonar.api.measures.MeasureUtils;
028    import org.sonar.api.measures.Metric;
029    import org.sonar.api.resources.Project;
030    import org.sonar.api.resources.Resource;
031    
032    import java.util.Arrays;
033    import java.util.List;
034    
035    public abstract class TangleIndexDecorator implements Decorator {
036    
037      private Metric tanglesMetric;
038      private Metric edgesWeightMetric;
039      private Metric tangleIndexMetric;
040    
041      protected TangleIndexDecorator(Metric tanglesMetric, Metric edgesWeightMetric, Metric tangleIndexMetric) {
042        this.tanglesMetric = tanglesMetric;
043        this.edgesWeightMetric = edgesWeightMetric;
044        this.tangleIndexMetric = tangleIndexMetric;
045      }
046    
047      @DependsUpon
048      public final List<Metric> dependsUponMetrics() {
049        return Arrays.asList(tanglesMetric, edgesWeightMetric);
050      }
051    
052      /**
053       * Used to define downstream dependencies
054       */
055      @DependedUpon
056      public final Metric generatesMetric() {
057        return tangleIndexMetric;
058      }
059    
060      public final boolean shouldExecuteOnProject(Project project) {
061        return true;
062      }
063    
064      /**
065       * {@inheritDoc}
066       */
067      public final void decorate(Resource resource, DecoratorContext context) {
068        if (!shouldDecorateResource(context)) {
069          return;
070        }
071        Measure tangles = context.getMeasure(tanglesMetric);
072        Measure totalweight = context.getMeasure(edgesWeightMetric);
073    
074        if (MeasureUtils.hasValue(totalweight)) {
075          context.saveMeasure(new Measure(tangleIndexMetric, compute(MeasureUtils.getValue(tangles, 0.0), totalweight.getValue())));
076        }
077      }
078    
079      private boolean shouldDecorateResource(DecoratorContext context) {
080        return context.getMeasure(tangleIndexMetric) == null;
081      }
082    
083    
084      private double compute(double tangles, double totalWeight) {
085        if (totalWeight==0.0) {
086          return 0.0;
087        }
088        double result = 2 * tangles / totalWeight;
089        return result * 100;
090      }
091    }