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.utils.SonarException; 023 024 import java.lang.reflect.Field; 025 import java.util.ArrayList; 026 import java.util.HashSet; 027 import java.util.List; 028 import java.util.Set; 029 030 /** 031 * @since 1.10 032 */ 033 public final class CoreMetrics { 034 035 private CoreMetrics() { 036 // only static stuff 037 } 038 039 public static final String DOMAIN_SIZE = "Size"; 040 public static final String DOMAIN_TESTS = "Tests"; 041 public static final String DOMAIN_COMPLEXITY = "Complexity"; 042 public static final String DOMAIN_DOCUMENTATION = "Documentation"; 043 public static final String DOMAIN_RULES = "Rules"; 044 public static final String DOMAIN_RULE_CATEGORIES = "Rule categories"; 045 public static final String DOMAIN_GENERAL = "General"; 046 public static final String DOMAIN_DUPLICATION = "Duplication"; 047 public static final String DOMAIN_DESIGN = "Design"; 048 049 public static final String LINES_KEY = "lines"; 050 public static final Metric LINES = new Metric(LINES_KEY, "Lines", "Lines", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 051 .setFormula(new SumChildValuesFormula(false)); 052 053 054 public static final String NCLOC_KEY = "ncloc"; 055 public static final Metric NCLOC = new Metric(NCLOC_KEY, "Lines of code", "Non Commenting Lines of Code", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 056 .setFormula(new SumChildValuesFormula(false)); 057 058 059 public static final String CLASSES_KEY = "classes"; 060 public static final Metric CLASSES = new Metric(CLASSES_KEY, "Classes", "Classes", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 061 .setFormula(new SumChildValuesFormula(false)); 062 063 064 public static final String FILES_KEY = "files"; 065 public static final Metric FILES = new Metric(FILES_KEY, "Files", "Number of files", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 066 .setFormula(new SumChildValuesFormula(false)); 067 068 public static final String DIRECTORIES_KEY = "directories"; 069 public static final Metric DIRECTORIES = new Metric(DIRECTORIES_KEY, "Directories", "Directories", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 070 .setFormula(new SumChildValuesFormula(false)); 071 072 073 public static final String PACKAGES_KEY = "packages"; 074 public static final Metric PACKAGES = new Metric(PACKAGES_KEY, "Packages", "Packages", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 075 .setFormula(new SumChildValuesFormula(false)); 076 077 078 public static final String FUNCTIONS_KEY = "functions"; 079 public static final Metric FUNCTIONS = new Metric(FUNCTIONS_KEY, "Methods", "Methods", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 080 .setFormula(new SumChildValuesFormula(false)); 081 082 083 public static final String ACCESSORS_KEY = "accessors"; 084 public static final Metric ACCESSORS = new Metric(ACCESSORS_KEY, "Accessors", "Accessors", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 085 .setFormula(new SumChildValuesFormula(false)); 086 087 088 public static final String STATEMENTS_KEY = "statements"; 089 public static final Metric STATEMENTS = new Metric(STATEMENTS_KEY, "Statements", "Number of statements", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 090 .setFormula(new SumChildValuesFormula(false)); 091 092 093 public static final String PUBLIC_API_KEY = "public_api"; 094 public static final Metric PUBLIC_API = new Metric(PUBLIC_API_KEY, "Public API", "Public API", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_SIZE) 095 .setFormula(new SumChildValuesFormula(false)); 096 097 098 public static final String COMPLEXITY_KEY = "complexity"; 099 public static final Metric COMPLEXITY = new Metric(COMPLEXITY_KEY, "Complexity", "Cyclomatic complexity", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_COMPLEXITY) 100 .setFormula(new SumChildValuesFormula(false)); 101 102 103 public static final String CLASS_COMPLEXITY_KEY = "class_complexity"; 104 public static final Metric CLASS_COMPLEXITY = new Metric(CLASS_COMPLEXITY_KEY, "Complexity /class", "Complexity average by class", Metric.ValueType.FLOAT, Metric.DIRECTION_WORST, true, DOMAIN_COMPLEXITY); 105 106 public static final String FUNCTION_COMPLEXITY_KEY = "function_complexity"; 107 public static final Metric FUNCTION_COMPLEXITY = new Metric(FUNCTION_COMPLEXITY_KEY, "Complexity /method", "Complexity average by method", Metric.ValueType.FLOAT, Metric.DIRECTION_WORST, true, DOMAIN_COMPLEXITY); 108 109 110 public static final String FILE_COMPLEXITY_KEY = "file_complexity"; 111 public static final Metric FILE_COMPLEXITY = new Metric(FILE_COMPLEXITY_KEY, "Complexity /file", "Complexity average by file", Metric.ValueType.FLOAT, Metric.DIRECTION_WORST, true, DOMAIN_COMPLEXITY); 112 113 114 public static final String CLASS_COMPLEXITY_DISTRIBUTION_KEY = "class_complexity_distribution"; 115 public static final Metric CLASS_COMPLEXITY_DISTRIBUTION = new Metric(CLASS_COMPLEXITY_DISTRIBUTION_KEY, "Classes distribution /complexity", "Classes distribution /complexity", Metric.ValueType.DISTRIB, Metric.DIRECTION_NONE, true, DOMAIN_COMPLEXITY) 116 .setFormula(new SumChildDistributionFormula()); 117 118 public static final String FUNCTION_COMPLEXITY_DISTRIBUTION_KEY = "function_complexity_distribution"; 119 public static final Metric FUNCTION_COMPLEXITY_DISTRIBUTION = new Metric(FUNCTION_COMPLEXITY_DISTRIBUTION_KEY, "Functions distribution /complexity", "Functions distribution /complexity", Metric.ValueType.DISTRIB, Metric.DIRECTION_NONE, true, DOMAIN_COMPLEXITY).setFormula(new SumChildDistributionFormula()); 120 121 122 public static final String COMMENT_LINES_KEY = "comment_lines"; 123 public static final Metric COMMENT_LINES = new Metric(COMMENT_LINES_KEY, "Comment lines", "Number of comment lines", Metric.ValueType.INT, Metric.DIRECTION_BETTER, false, DOMAIN_DOCUMENTATION).setFormula(new SumChildValuesFormula(false)); 124 125 public static final String COMMENT_LINES_DENSITY_KEY = "comment_lines_density"; 126 public static final Metric COMMENT_LINES_DENSITY = new Metric(COMMENT_LINES_DENSITY_KEY, "Comments (%)", "Comments balanced by ncloc + comment lines", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_DOCUMENTATION); 127 128 public static final String PUBLIC_DOCUMENTED_API_DENSITY_KEY = "public_documented_api_density"; 129 public static final Metric PUBLIC_DOCUMENTED_API_DENSITY = new Metric(PUBLIC_DOCUMENTED_API_DENSITY_KEY, "Public documented API (%)", "Public documented classes and methods balanced by ncloc", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_DOCUMENTATION) 130 .setWorstValue(0.0) 131 .setBestValue(100.0) 132 .setOptimizedBestValue(true); 133 134 public static final String PUBLIC_UNDOCUMENTED_API_KEY = "public_undocumented_api"; 135 public static final Metric PUBLIC_UNDOCUMENTED_API = new Metric(PUBLIC_UNDOCUMENTED_API_KEY, "Public undocumented API", "Public undocumented classes, methods and variables", Metric.ValueType.INT, Metric.DIRECTION_WORST, true, DOMAIN_DOCUMENTATION) 136 .setWorstValue(100.0) 137 .setBestValue(0.0) 138 .setDirection(Metric.DIRECTION_WORST) 139 .setOptimizedBestValue(true) 140 .setFormula(new SumChildValuesFormula(false)); 141 142 143 public static final String COMMENTED_OUT_CODE_LINES_KEY = "commented_out_code_lines"; 144 public static final Metric COMMENTED_OUT_CODE_LINES = new Metric(COMMENTED_OUT_CODE_LINES_KEY, "Commented LOCs", "Commented lines of code", Metric.ValueType.INT, Metric.DIRECTION_WORST, true, DOMAIN_DOCUMENTATION) 145 .setFormula(new SumChildValuesFormula(false)) 146 .setBestValue(0.0) 147 .setOptimizedBestValue(true); 148 149 /* unit tests */ 150 public static final String TESTS_KEY = "tests"; 151 public static final Metric TESTS = new Metric(TESTS_KEY, "Unit tests", "Number of unit tests", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_TESTS); 152 153 154 public static final String TEST_EXECUTION_TIME_KEY = "test_execution_time"; 155 public static final Metric TEST_EXECUTION_TIME = new Metric(TEST_EXECUTION_TIME_KEY, "Unit tests duration", "Execution duration of unit tests ", Metric.ValueType.MILLISEC, Metric.DIRECTION_WORST, false, DOMAIN_TESTS); 156 157 158 public static final String TEST_ERRORS_KEY = "test_errors"; 159 public static final Metric TEST_ERRORS = new Metric(TEST_ERRORS_KEY, "Unit test errors", "Number of unit test errors", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_TESTS) 160 .setBestValue(0.0) 161 .setOptimizedBestValue(true); 162 public static final String SKIPPED_TESTS_KEY = "skipped_tests"; 163 public static final Metric SKIPPED_TESTS = new Metric(SKIPPED_TESTS_KEY, "Skipped unit tests", "Number of skipped unit tests", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_TESTS) 164 .setBestValue(0.0) 165 .setOptimizedBestValue(true); 166 public static final String TEST_FAILURES_KEY = "test_failures"; 167 public static final Metric TEST_FAILURES = new Metric(TEST_FAILURES_KEY, "Unit test failures", "Number of unit test failures", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_TESTS) 168 .setBestValue(0.0) 169 .setOptimizedBestValue(true); 170 public static final String TEST_SUCCESS_DENSITY_KEY = "test_success_density"; 171 public static final Metric TEST_SUCCESS_DENSITY = new Metric(TEST_SUCCESS_DENSITY_KEY, "Unit test success (%)", "Density of successful unit tests", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_TESTS) 172 .setWorstValue(0.0) 173 .setBestValue(100.0) 174 .setOptimizedBestValue(true); 175 public static final String TEST_DATA_KEY = "test_data"; 176 public static final Metric TEST_DATA = new Metric(TEST_DATA_KEY, "Unit tests details", "Unit tests details", Metric.ValueType.DATA, Metric.DIRECTION_WORST, false, DOMAIN_TESTS); 177 178 public static final String COVERAGE_KEY = "coverage"; 179 public static final Metric COVERAGE = new Metric(COVERAGE_KEY, "Coverage", "Coverage by unit tests", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_TESTS) 180 .setWorstValue(0.0) 181 .setBestValue(100.0); 182 183 public static final String LINES_TO_COVER_KEY = "lines_to_cover"; 184 public static final Metric LINES_TO_COVER = new Metric(LINES_TO_COVER_KEY, "Lines to cover", "Lines to cover", Metric.ValueType.INT, Metric.DIRECTION_BETTER, false, DOMAIN_TESTS) 185 .setFormula(new SumChildValuesFormula(false)) 186 .setHidden(true); 187 188 public static final String UNCOVERED_LINES_KEY = "uncovered_lines"; 189 public static final Metric UNCOVERED_LINES = new Metric(UNCOVERED_LINES_KEY, "Uncovered lines", "Uncovered lines", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_TESTS) 190 .setFormula(new SumChildValuesFormula(false)) 191 .setHidden(true); 192 193 public static final String LINE_COVERAGE_KEY = "line_coverage"; 194 public static final Metric LINE_COVERAGE = new Metric(LINE_COVERAGE_KEY, "Line coverage", "Line coverage", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_TESTS); 195 196 public static final String COVERAGE_LINE_HITS_DATA_KEY = "coverage_line_hits_data"; 197 public static final Metric COVERAGE_LINE_HITS_DATA = new Metric(COVERAGE_LINE_HITS_DATA_KEY, "Coverage hits data", "Code coverage line hits data", Metric.ValueType.DATA, Metric.DIRECTION_NONE, false, DOMAIN_TESTS); 198 199 public static final String CONDITIONS_TO_COVER_KEY = "conditions_to_cover"; 200 public static final Metric CONDITIONS_TO_COVER = new Metric(CONDITIONS_TO_COVER_KEY, "Conditions to cover", "Conditions to cover", Metric.ValueType.INT, Metric.DIRECTION_BETTER, false, DOMAIN_TESTS) 201 .setFormula(new SumChildValuesFormula(false)) 202 .setHidden(true); 203 204 public static final String UNCOVERED_CONDITIONS_KEY = "uncovered_conditions"; 205 public static final Metric UNCOVERED_CONDITIONS = new Metric(UNCOVERED_CONDITIONS_KEY, "Uncovered conditions", "Uncovered conditions", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_TESTS) 206 .setFormula(new SumChildValuesFormula(false)) 207 .setHidden(true); 208 209 public static final String BRANCH_COVERAGE_KEY = "branch_coverage"; 210 public static final Metric BRANCH_COVERAGE = new Metric(BRANCH_COVERAGE_KEY, "Branch coverage", "Branch coverage", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_TESTS) 211 .setWorstValue(0.0) 212 .setBestValue(100.0); 213 214 public static final String BRANCH_COVERAGE_HITS_DATA_KEY = "branch_coverage_hits_data"; 215 public static final Metric BRANCH_COVERAGE_HITS_DATA = new Metric(BRANCH_COVERAGE_HITS_DATA_KEY, "Branch coverage hits", "Branch coverage hits", Metric.ValueType.DATA, Metric.DIRECTION_NONE, false, DOMAIN_TESTS); 216 217 /** 218 * @deprecated replaced since 1.11 by UNCOVERED_LINES and UNCOVERED_CONDITIONS 219 */ 220 @Deprecated 221 public static final String UNCOVERED_COMPLEXITY_BY_TESTS_KEY = "uncovered_complexity_by_tests"; 222 /** 223 * @deprecated replaced since 1.11 by UNCOVERED_LINES and UNCOVERED_CONDITIONS 224 */ 225 @Deprecated 226 public static final Metric UNCOVERED_COMPLEXITY_BY_TESTS = new Metric(UNCOVERED_COMPLEXITY_BY_TESTS_KEY, "Uncovered complexity", "Uncovered complexity", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_COMPLEXITY).setFormula(new SumChildValuesFormula(false)); 227 228 229 public static final String DUPLICATED_LINES_KEY = "duplicated_lines"; 230 public static final Metric DUPLICATED_LINES = new Metric(DUPLICATED_LINES_KEY, "Duplicated lines", "Duplicated lines", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DUPLICATION) 231 .setBestValue(0.0) 232 .setOptimizedBestValue(true); 233 234 public static final String DUPLICATED_BLOCKS_KEY = "duplicated_blocks"; 235 public static final Metric DUPLICATED_BLOCKS = new Metric(DUPLICATED_BLOCKS_KEY, "Duplicated blocks", "Duplicated blocks", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DUPLICATION) 236 .setBestValue(0.0) 237 .setOptimizedBestValue(true); 238 239 public static final String DUPLICATED_FILES_KEY = "duplicated_files"; 240 public static final Metric DUPLICATED_FILES = new Metric(DUPLICATED_FILES_KEY, "Duplicated files", "Duplicated files", Metric.ValueType.INT, Metric.DIRECTION_WORST, true, DOMAIN_DUPLICATION) 241 .setBestValue(0.0) 242 .setOptimizedBestValue(true); 243 244 public static final String DUPLICATED_LINES_DENSITY_KEY = "duplicated_lines_density"; 245 public static final Metric DUPLICATED_LINES_DENSITY = new Metric(DUPLICATED_LINES_DENSITY_KEY, "Duplicated lines (%)", "Duplicated lines balanced by statements", Metric.ValueType.PERCENT, Metric.DIRECTION_WORST, true, DOMAIN_DUPLICATION) 246 .setWorstValue(50.0) 247 .setBestValue(0.0) 248 .setOptimizedBestValue(true); 249 250 public static final String DUPLICATIONS_DATA_KEY = "duplications_data"; 251 public static final Metric DUPLICATIONS_DATA = new Metric(DUPLICATIONS_DATA_KEY, "Duplications details", "Duplications details", Metric.ValueType.DATA, Metric.DIRECTION_NONE, false, DOMAIN_DUPLICATION); 252 253 254 /* coding rules */ 255 public static final String USABILITY_KEY = "usability"; 256 public static final Metric USABILITY = new Metric(USABILITY_KEY, "Usability", "Usability", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_RULE_CATEGORIES) 257 .setBestValue(100.0) 258 .setOptimizedBestValue(true); 259 public static final String RELIABILITY_KEY = "reliability"; 260 public static final Metric RELIABILITY = new Metric(RELIABILITY_KEY, "Reliability", "Reliability", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_RULE_CATEGORIES) 261 .setBestValue(100.0) 262 .setOptimizedBestValue(true); 263 public static final String EFFICIENCY_KEY = "efficiency"; 264 public static final Metric EFFICIENCY = new Metric(EFFICIENCY_KEY, "Efficiency", "Efficiency", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_RULE_CATEGORIES) 265 .setBestValue(100.0) 266 .setOptimizedBestValue(true); 267 public static final String PORTABILITY_KEY = "portability"; 268 public static final Metric PORTABILITY = new Metric(PORTABILITY_KEY, "Portability", "Portability", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_RULE_CATEGORIES) 269 .setBestValue(100.0) 270 .setOptimizedBestValue(true); 271 public static final String MAINTAINABILITY_KEY = "maintainability"; 272 public static final Metric MAINTAINABILITY = new Metric(MAINTAINABILITY_KEY, "Maintainability", "Maintainability", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_RULE_CATEGORIES) 273 .setBestValue(100.0) 274 .setOptimizedBestValue(true); 275 276 public static final String WEIGHTED_VIOLATIONS_KEY = "weighted_violations"; 277 public static final Metric WEIGHTED_VIOLATIONS = new Metric(WEIGHTED_VIOLATIONS_KEY, "Weighted violations", "Weighted Violations", Metric.ValueType.INT, Metric.DIRECTION_WORST, true, DOMAIN_RULES) 278 .setHidden(true); 279 280 public static final String VIOLATIONS_DENSITY_KEY = "violations_density"; 281 public static final Metric VIOLATIONS_DENSITY = new Metric(VIOLATIONS_DENSITY_KEY, "Rules compliance", "Rules compliance", Metric.ValueType.PERCENT, Metric.DIRECTION_BETTER, true, DOMAIN_RULES); 282 283 public static final String VIOLATIONS_KEY = "violations"; 284 public static final Metric VIOLATIONS = new Metric(VIOLATIONS_KEY, "Violations", "Violations", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_RULES) 285 .setBestValue(0.0) 286 .setOptimizedBestValue(true); 287 288 public static final String BLOCKER_VIOLATIONS_KEY = "blocker_violations"; 289 public static final Metric BLOCKER_VIOLATIONS = new Metric(BLOCKER_VIOLATIONS_KEY, "Blocker violations", "Blocker violations", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_RULES) 290 .setBestValue(0.0) 291 .setOptimizedBestValue(true); 292 293 public static final String CRITICAL_VIOLATIONS_KEY = "critical_violations"; 294 public static final Metric CRITICAL_VIOLATIONS = new Metric(CRITICAL_VIOLATIONS_KEY, "Critical violations", "Critical violations", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_RULES) 295 .setBestValue(0.0) 296 .setOptimizedBestValue(true); 297 298 public static final String MAJOR_VIOLATIONS_KEY = "major_violations"; 299 public static final Metric MAJOR_VIOLATIONS = new Metric(MAJOR_VIOLATIONS_KEY, "Major violations", "Major violations", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_RULES) 300 .setBestValue(0.0) 301 .setOptimizedBestValue(true); 302 303 public static final String MINOR_VIOLATIONS_KEY = "minor_violations"; 304 public static final Metric MINOR_VIOLATIONS = new Metric(MINOR_VIOLATIONS_KEY, "Minor violations", "Minor violations", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_RULES) 305 .setBestValue(0.0) 306 .setOptimizedBestValue(true); 307 308 public static final String INFO_VIOLATIONS_KEY = "info_violations"; 309 public static final Metric INFO_VIOLATIONS = new Metric(INFO_VIOLATIONS_KEY, "Info violations", "Info violations", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_RULES) 310 .setBestValue(0.0) 311 .setOptimizedBestValue(true); 312 313 /* Design */ 314 315 public static final String ABSTRACTNESS_KEY = "abstractness"; 316 public static final Metric ABSTRACTNESS = new Metric(ABSTRACTNESS_KEY, "Abstractness", "Abstractness", Metric.ValueType.PERCENT, Metric.DIRECTION_NONE, false, DOMAIN_DESIGN); 317 public static final String INSTABILITY_KEY = "instability"; 318 public static final Metric INSTABILITY = new Metric(INSTABILITY_KEY, "Instability", "Instability", Metric.ValueType.PERCENT, Metric.DIRECTION_NONE, false, DOMAIN_DESIGN); 319 public static final String DISTANCE_KEY = "distance"; 320 public static final Metric DISTANCE = new Metric(DISTANCE_KEY, "Distance", "Distance", Metric.ValueType.FLOAT, Metric.DIRECTION_NONE, false, DOMAIN_DESIGN); 321 322 323 public static final String DEPTH_IN_TREE_KEY = "dit"; 324 public static final Metric DEPTH_IN_TREE = new Metric(DEPTH_IN_TREE_KEY, "Depth in Tree", "Depth in Inheritance Tree", Metric.ValueType.INT, Metric.DIRECTION_NONE, false, DOMAIN_DESIGN); 325 326 public static final String NUMBER_OF_CHILDREN_KEY = "noc"; 327 public static final Metric NUMBER_OF_CHILDREN = new Metric(NUMBER_OF_CHILDREN_KEY, "Number of Children", "Number of Children", Metric.ValueType.INT, Metric.DIRECTION_NONE, false, DOMAIN_DESIGN); 328 329 public static final String RFC_KEY = "rfc"; 330 public static final Metric RFC = new Metric(RFC_KEY, "RFC", "Response for Class", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DESIGN) 331 .setFormula(new WeightedMeanAggregationFormula(CoreMetrics.FILES, false)); 332 333 public static final String RFC_DISTRIBUTION_KEY = "rfc_distribution"; 334 public static final Metric RFC_DISTRIBUTION = new Metric(RFC_DISTRIBUTION_KEY, "Class distribution /RFC", "Class distribution /RFC", Metric.ValueType.DISTRIB, Metric.DIRECTION_NONE, true, DOMAIN_DESIGN) 335 .setFormula(new SumChildDistributionFormula()); 336 337 public static final String LCOM4_KEY = "lcom4"; 338 public static final Metric LCOM4 = new Metric(LCOM4_KEY, "LCOM4", "Lack of Cohesion of Methods", Metric.ValueType.FLOAT, Metric.DIRECTION_WORST, true, DOMAIN_DESIGN) 339 .setFormula(new WeightedMeanAggregationFormula(CoreMetrics.FILES, false)); 340 341 public static final String LCOM4_BLOCKS_KEY = "lcom4_blocks"; 342 public static final Metric LCOM4_BLOCKS = new Metric(LCOM4_BLOCKS_KEY, "LCOM4 blocks", "LCOM4 blocks", Metric.ValueType.DATA, Metric.DIRECTION_NONE, false, DOMAIN_DESIGN) 343 .setHidden(true); 344 345 public static final String LCOM4_DISTRIBUTION_KEY = "lcom4_distribution"; 346 public static final Metric LCOM4_DISTRIBUTION = new Metric(LCOM4_DISTRIBUTION_KEY, "Class distribution /LCOM4", "Class distribution /LCOM4", Metric.ValueType.DISTRIB, Metric.DIRECTION_NONE, true, DOMAIN_DESIGN) 347 .setFormula(new SumChildDistributionFormula()); 348 349 public static final String SUSPECT_LCOM4_DENSITY_KEY = "suspect_lcom4_density"; 350 public static final Metric SUSPECT_LCOM4_DENSITY = new Metric(SUSPECT_LCOM4_DENSITY_KEY, "Suspect LCOM4 density", "Density of classes having LCOM4>1", Metric.ValueType.PERCENT, Metric.DIRECTION_WORST, true, DOMAIN_DESIGN); 351 352 public static final String AFFERENT_COUPLINGS_KEY = "ca"; 353 public static final Metric AFFERENT_COUPLINGS = new Metric(AFFERENT_COUPLINGS_KEY, "Afferent couplings", "Afferent couplings", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DESIGN); 354 public static final String EFFERENT_COUPLINGS_KEY = "ce"; 355 public static final Metric EFFERENT_COUPLINGS = new Metric(EFFERENT_COUPLINGS_KEY, "Efferent couplings", "Efferent couplings", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DESIGN); 356 357 public static final String DEPENDENCY_MATRIX_KEY = "dsm"; 358 public static final Metric DEPENDENCY_MATRIX = new Metric(DEPENDENCY_MATRIX_KEY, "Dependency Matrix", "Dependency Matrix", Metric.ValueType.DATA, Metric.DIRECTION_NONE, false, DOMAIN_DESIGN); 359 360 public static final String PACKAGE_CYCLES_KEY = "package_cycles"; 361 public static final Metric PACKAGE_CYCLES = new Metric(PACKAGE_CYCLES_KEY, "Package cycles", "Package cycles", Metric.ValueType.INT, Metric.DIRECTION_WORST, true, DOMAIN_DESIGN) 362 .setFormula(new SumChildValuesFormula(false)); 363 364 public static final String PACKAGE_TANGLE_INDEX_KEY = "package_tangle_index"; 365 public static final Metric PACKAGE_TANGLE_INDEX = new Metric(PACKAGE_TANGLE_INDEX_KEY, "Package tangle index", "Package tangle index", Metric.ValueType.PERCENT, Metric.DIRECTION_WORST, true, DOMAIN_DESIGN); 366 367 public static final String PACKAGE_TANGLES_KEY = "package_tangles"; 368 public static final Metric PACKAGE_TANGLES = new Metric(PACKAGE_TANGLES_KEY, "File dependencies to cut", "File dependencies to cut", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DESIGN) 369 .setFormula(new SumChildValuesFormula(false)); 370 371 public static final String PACKAGE_FEEDBACK_EDGES_KEY = "package_feedback_edges"; 372 public static final Metric PACKAGE_FEEDBACK_EDGES = new Metric(PACKAGE_FEEDBACK_EDGES_KEY, "Package dependencies to cut", "Package dependencies to cut", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DESIGN) 373 .setFormula(new SumChildValuesFormula(false)); 374 375 public static final String PACKAGE_EDGES_WEIGHT_KEY = "package_edges_weight"; 376 public static final Metric PACKAGE_EDGES_WEIGHT = new Metric(PACKAGE_EDGES_WEIGHT_KEY, "Package edges weight", "Package edges weight", Metric.ValueType.INT, Metric.DIRECTION_BETTER, false, DOMAIN_DESIGN) 377 .setFormula(new SumChildValuesFormula(false)) 378 .setHidden(true); 379 380 public static final String FILE_CYCLES_KEY = "file_cycles"; 381 public static final Metric FILE_CYCLES = new Metric(FILE_CYCLES_KEY, "File cycles", "File cycles", Metric.ValueType.INT, Metric.DIRECTION_WORST, true, DOMAIN_DESIGN) 382 .setHidden(true); 383 384 public static final String FILE_TANGLE_INDEX_KEY = "file_tangle_index"; 385 public static final Metric FILE_TANGLE_INDEX = new Metric(FILE_TANGLE_INDEX_KEY, "File tangle index", "File tangle index", Metric.ValueType.PERCENT, Metric.DIRECTION_WORST, true, DOMAIN_DESIGN) 386 .setHidden(true); 387 388 public static final String FILE_TANGLES_KEY = "file_tangles"; 389 public static final Metric FILE_TANGLES = new Metric(FILE_TANGLES_KEY, "File tangles", "Files tangles", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DESIGN) 390 .setHidden(true); 391 392 public static final String FILE_FEEDBACK_EDGES_KEY = "file_feedback_edges"; 393 public static final Metric FILE_FEEDBACK_EDGES = new Metric(FILE_FEEDBACK_EDGES_KEY, "Suspect file dependencies", "Suspect file dependencies", Metric.ValueType.INT, Metric.DIRECTION_WORST, false, DOMAIN_DESIGN) 394 .setHidden(true); 395 396 public static final String FILE_EDGES_WEIGHT_KEY = "file_edges_weight"; 397 public static final Metric FILE_EDGES_WEIGHT = new Metric(FILE_EDGES_WEIGHT_KEY, "File edges weight", "File edges weight", Metric.ValueType.INT, Metric.DIRECTION_BETTER, false, DOMAIN_DESIGN) 398 .setHidden(true); 399 400 401 /* alerts */ 402 public static final String ALERT_STATUS_KEY = "alert_status"; 403 public static final Metric ALERT_STATUS = new Metric(ALERT_STATUS_KEY, "Alert", "Alert", Metric.ValueType.LEVEL, Metric.DIRECTION_BETTER, true, DOMAIN_GENERAL); 404 405 /* quality profile */ 406 public static final String PROFILE_KEY = "profile"; 407 public static final Metric PROFILE = new Metric(PROFILE_KEY, "Profile", "Selected quality profile", Metric.ValueType.DATA, Metric.DIRECTION_NONE, false, DOMAIN_GENERAL); 408 409 public static List<Metric> metrics = new ArrayList<Metric>(); 410 411 public static Set<String> metricKeys = new HashSet<String>(); 412 413 414 public static List<Metric> getMetrics() { 415 if (metrics.isEmpty()) { 416 for (Field field : CoreMetrics.class.getFields()) { 417 if (Metric.class.isAssignableFrom(field.getType())) { 418 try { 419 metrics.add((Metric) field.get(null)); 420 } catch (IllegalAccessException e) { 421 throw new SonarException("can not load metrics from " + CoreMetrics.class.getSimpleName(), e); 422 } 423 } 424 } 425 } 426 return metrics; 427 } 428 }