1/* Copyright (C) 2003 Vladimir Roubtsov. All rights reserved.
2 *
3 * This program and the accompanying materials are made available under
4 * the terms of the Common Public License v1.0 which accompanies this distribution,
5 * and is available at http://www.eclipse.org/legal/cpl-v10.html
6 *
7 * $Id: IReportProperties.java,v 1.1.1.1 2004/05/09 16:57:37 vlad_r Exp $
8 */
9package com.vladium.emma.report;
10
11// ----------------------------------------------------------------------------
12/**
13 * @author Vlad Roubtsov, (C) 2003
14 */
15public
16interface IReportProperties
17{
18    // public: ................................................................
19
20    // TODO: separate props for diff kinds of files (m, c, reports) ?
21
22    String PREFIX = "report.";
23
24    // parameter:
25    String OUT_ENCODING     = "out.encoding";
26    String OUT_DIR          = "out.dir";
27    String OUT_FILE         = "out.file";
28
29    // parameter:
30    String UNITS_TYPE       = "units";
31    // values:
32    String COUNT_UNITS      = "count";
33    String INSTR_UNITS      = "instr";
34
35    // parameter:
36    String VIEW_TYPE        = "view";
37    // values:
38    String CLS_VIEW         = "class";
39    String SRC_VIEW         = "source";
40
41    // parameter:
42    String HIDE_CLASSES     = "hideclasses"; // boolean
43
44    // parameter:
45    String DEPTH            = "depth";
46    // values:
47    String DEPTH_ALL        = "all";
48    String DEPTH_PACKAGE    = "package";
49    String DEPTH_SRCFILE    = "source";
50    String DEPTH_CLASS      = "class";
51    String DEPTH_METHOD     = "method";
52
53    // parameter:
54    String COLUMNS          = "columns"; // comma-separated list
55    // values:
56    String ITEM_NAME_COLUMN         = "name";
57    String CLASS_COVERAGE_COLUMN    = "class";
58    String METHOD_COVERAGE_COLUMN   = "method";
59    String BLOCK_COVERAGE_COLUMN    = "block";
60    String LINE_COVERAGE_COLUMN     = "line";
61
62    // parameter:
63    String SORT             = "sort"; // comma-separated list of ('+'/'-'-prefixed column names)
64    char ASC                = '+'; // default
65    char DESC               = '-';
66
67    // parameter:
68    String METRICS          = "metrics"; // comma-separated list of (column name:metric) pairs
69    char MSEPARATOR         = ':';
70
71    // defaults:
72
73    String DEFAULT_UNITS_TYPE = INSTR_UNITS;
74    String DEFAULT_VIEW_TYPE = SRC_VIEW;
75    String DEFAULT_HIDE_CLASSES = "true";
76    String DEFAULT_DEPTH = DEPTH_PACKAGE;
77    String DEFAULT_COLUMNS = CLASS_COVERAGE_COLUMN + "," + METHOD_COVERAGE_COLUMN + "," + BLOCK_COVERAGE_COLUMN + "," + LINE_COVERAGE_COLUMN + "," + ITEM_NAME_COLUMN;
78    String DEFAULT_SORT = ASC + BLOCK_COVERAGE_COLUMN + "," + ASC + ITEM_NAME_COLUMN;
79    String DEFAULT_METRICS = METHOD_COVERAGE_COLUMN + MSEPARATOR + "70," + BLOCK_COVERAGE_COLUMN + MSEPARATOR + "80," + LINE_COVERAGE_COLUMN + MSEPARATOR + "80," + CLASS_COVERAGE_COLUMN + MSEPARATOR + "100";
80
81} // end of inteface
82// ----------------------------------------------------------------------------