001 /* 002 * Sonar, open source software quality management tool. 003 * Copyright (C) 2008-2011 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.api.measures; 021 022 import org.sonar.api.qualitymodel.Characteristic; 023 import org.sonar.api.rules.Rule; 024 import org.sonar.api.rules.RulePriority; 025 026 import java.util.ArrayList; 027 import java.util.Collection; 028 import java.util.Collections; 029 import java.util.List; 030 031 /** 032 * @since 1.10 033 */ 034 public final class MeasuresFilters { 035 036 private MeasuresFilters() { 037 } 038 039 public static MeasuresFilter<Collection<Measure>> all() { 040 return new MeasuresFilter<Collection<Measure>>() { 041 public Collection<Measure> filter(Collection<Measure> measures) { 042 return measures; 043 } 044 }; 045 } 046 047 public static MeasuresFilter<Measure> metric(final Metric metric) { 048 return metric(metric.getKey()); 049 } 050 051 public static MeasuresFilter<Measure> metric(final String metricKey) { 052 return new MetricFilter<Measure>(metricKey) { 053 054 public Measure filter(Collection<Measure> measures) { 055 if (measures == null) { 056 return null; 057 } 058 for (Measure measure : measures) { 059 if (measure.getClass().equals(Measure.class) && 060 measure.getMetricKey().equals(metricKey) && 061 measure.getCharacteristic()==null) { 062 return measure; 063 } 064 } 065 return null; 066 } 067 }; 068 } 069 070 public static MeasuresFilter<Measure> characteristic(final Metric metric, final Characteristic characteristic) { 071 return new MetricFilter<Measure>(metric) { 072 073 public Measure filter(Collection<Measure> measures) { 074 if (measures == null) { 075 return null; 076 } 077 for (Measure measure : measures) { 078 if (measure.getClass().equals(Measure.class) && 079 measure.getMetric().equals(metric) && 080 measure.getCharacteristic()!=null && 081 measure.getCharacteristic().equals(characteristic)) { 082 return measure; 083 } 084 } 085 return null; 086 } 087 }; 088 } 089 090 /** 091 * @since 2.0 092 */ 093 public static MeasuresFilter<Measure> measure(final Measure measure) { 094 return new MeasuresFilter<Measure>() { 095 public Measure filter(Collection<Measure> measures) { 096 if (measures==null) { 097 return null; 098 } 099 for (Measure m : measures) { 100 if (m.equals(measure)) { 101 return m; 102 } 103 } 104 return null; 105 } 106 }; 107 } 108 109 public static MeasuresFilter<RuleMeasure> rulePriority(final Metric metric, final RulePriority priority) { 110 return new RulePriorityFilter(metric, priority); 111 } 112 113 /** 114 * @deprecated since 2.5. See http://jira.codehaus.org/browse/SONAR-2007 115 */ 116 @Deprecated 117 public static MeasuresFilter<RuleMeasure> ruleCategory(final Metric metric, final Integer category) { 118 return new RuleCategoryFilter(metric, category); 119 } 120 121 public static MeasuresFilter<RuleMeasure> rule(final Metric metric, final Rule rule) { 122 return new RuleFilter(metric, rule); 123 } 124 125 /** 126 * @deprecated since 2.5. See http://jira.codehaus.org/browse/SONAR-2007 127 */ 128 @Deprecated 129 public static MeasuresFilter<Collection<RuleMeasure>> ruleCategories(final Metric metric) { 130 return new MetricFilter<Collection<RuleMeasure>>(metric) { 131 132 public Collection<RuleMeasure> filter(Collection<Measure> measures) { 133 return Collections.emptyList(); 134 } 135 }; 136 } 137 138 public static MeasuresFilter<Collection<RuleMeasure>> rules(final Metric metric) { 139 return new MetricFilter<Collection<RuleMeasure>>(metric) { 140 141 private boolean apply(Measure measure) { 142 return measure instanceof RuleMeasure 143 && metric.equals(measure.getMetric()) 144 && ((RuleMeasure) measure).getRule() != null; 145 } 146 147 public Collection<RuleMeasure> filter(Collection<Measure> measures) { 148 if (measures == null) { 149 return null; 150 } 151 List<RuleMeasure> result = new ArrayList<RuleMeasure>(); 152 for (Measure measure : measures) { 153 if (apply(measure)) { 154 result.add((RuleMeasure) measure); 155 } 156 } 157 return result; 158 } 159 }; 160 } 161 162 /** 163 * Used for internal optimizations. 164 */ 165 public static abstract class MetricFilter<M> implements MeasuresFilter<M> { 166 private final String metricKey; 167 168 protected MetricFilter(Metric metric) { 169 this.metricKey = metric.getKey(); 170 } 171 172 protected MetricFilter(String metricKey) { 173 this.metricKey = metricKey; 174 } 175 176 public String filterOnMetricKey() { 177 return metricKey; 178 } 179 } 180 181 private abstract static class AbstractRuleMeasureFilter<M> extends MetricFilter<M> { 182 protected AbstractRuleMeasureFilter(Metric metric) { 183 super(metric); 184 } 185 186 private boolean apply(Measure measure) { 187 return measure instanceof RuleMeasure 188 && filterOnMetricKey().equals(measure.getMetricKey()) 189 && doApply((RuleMeasure) measure); 190 } 191 192 abstract boolean doApply(RuleMeasure ruleMeasure); 193 194 public M filter(Collection<Measure> measures) { 195 if (measures == null) { 196 return null; 197 } 198 for (Measure measure : measures) { 199 if (apply(measure)) { 200 return (M) measure; 201 } 202 } 203 return null; 204 } 205 } 206 207 private static class RulePriorityFilter extends AbstractRuleMeasureFilter<RuleMeasure> { 208 private RulePriority priority; 209 210 protected RulePriorityFilter(Metric metric, RulePriority priority) { 211 super(metric); 212 this.priority = priority; 213 } 214 215 @Override 216 boolean doApply(RuleMeasure measure) { 217 return measure.getRule() == null 218 && priority.equals(measure.getRulePriority()); 219 } 220 } 221 222 /** 223 * @deprecated since 2.5. See http://jira.codehaus.org/browse/SONAR-2007 224 */ 225 @Deprecated 226 private static class RuleCategoryFilter extends AbstractRuleMeasureFilter<RuleMeasure> { 227 228 protected RuleCategoryFilter(Metric metric, Integer categ) { 229 super(metric); 230 } 231 232 @Override 233 boolean doApply(RuleMeasure measure) { 234 return false; 235 } 236 } 237 238 239 private static class RuleFilter extends AbstractRuleMeasureFilter<RuleMeasure> { 240 private Rule rule; 241 242 protected RuleFilter(Metric metric, Rule rule) { 243 super(metric); 244 this.rule = rule; 245 } 246 247 @Override 248 boolean doApply(RuleMeasure measure) { 249 return measure.getRule() != null 250 && rule.equals(measure.getRule()); 251 } 252 } 253 }