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