1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- Generated by Apache Maven Doxia at Jan 31, 2015 -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>GMetrics - GMetrics SingleSeriesHtmlReportWriter</title>
<style type="text/css" media="all">
@import url("./css/maven-base.css");
@import url("./css/maven-theme.css");
@import url("./css/site.css");
</style>
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
<meta name="Date-Revision-yyyymmdd" content="20150131" />
<meta http-equiv="Content-Language" content="en" />
</head>
<body class="composite">
<div id="banner">
<a href="" id="bannerLeft">
GMetrics
</a>
<div class="clear">
<hr/>
</div>
</div>
<div id="breadcrumbs">
<div class="xleft">
<span id="publishDate">Last Published: 31 Jan 2015</span>
| <span id="projectVersion">Version: 0.7</span>
</div>
<div class="xright">
</div>
<div class="clear">
<hr/>
</div>
</div>
<div id="leftColumn">
<div id="navcolumn">
<h5>General</h5>
<ul>
<li class="none">
<a href="index.html" title="Home">Home</a>
</li>
<li class="none">
<a href="http://sourceforge.net/projects/gmetrics/files/" class="externalLink" title="Downloads">Downloads</a>
</li>
<li class="none">
<a href="apidocs/index.html" title="Javadocs">Javadocs</a>
</li>
<li class="none">
<a href="http://sourceforge.net/projects/gmetrics" class="externalLink" title="SourceForge Project">SourceForge Project</a>
</li>
</ul>
<h5>Running</h5>
<ul>
<li class="none">
<a href="gmetrics-ant-task.html" title="Ant Task Usage">Ant Task Usage</a>
</li>
<li class="none">
<a href="gmetrics-other-tools-frameworks.html" title="Other Tools/Frameworks">Other Tools/Frameworks</a>
</li>
</ul>
<h5>Using</h5>
<ul>
<li class="none">
<a href="gmetrics-creating-metricset.html" title="Creating a MetricSet">Creating a MetricSet</a>
</li>
<li class="none">
<a href="gmetrics-DefaultMetricSet.html" title="The Default MetricSet">The Default MetricSet</a>
</li>
</ul>
<h5>Reports</h5>
<ul>
<li class="none">
<a href="gmetrics-BasicHtmlReportWriter.html" title="BasicHtmlReportWriter">BasicHtmlReportWriter</a>
</li>
<li class="none">
<strong>SingleSeriesHtmlReportWriter</strong>
</li>
<li class="none">
<a href="gmetrics-XmlReportWriter.html" title="XmlReportWriter">XmlReportWriter</a>
</li>
<li class="none">
<a href="gmetrics-sampleReports.html" title="Sample Reports">Sample Reports</a>
</li>
</ul>
<h5>Metrics</h5>
<ul>
<li class="none">
<a href="gmetrics-AbcMetric.html" title="ABC">ABC</a>
</li>
<li class="none">
<a href="gmetrics-AfferentCouplingMetric.html" title="AfferentCoupling">AfferentCoupling</a>
</li>
<li class="none">
<a href="gmetrics-ClassCountMetric.html" title="ClassCount">ClassCount</a>
</li>
<li class="none">
<a href="gmetrics-ClassLineCountMetric.html" title="ClassLineCount">ClassLineCount</a>
</li>
<li class="none">
<a href="gmetrics-CoberturaBranchCoverageMetric.html" title="CoberturaBranchCoverageMetric">CoberturaBranchCoverageMetric</a>
</li>
<li class="none">
<a href="gmetrics-CoberturaLineCoverageMetric.html" title="CoberturaLineCoverageMetric">CoberturaLineCoverageMetric</a>
</li>
<li class="none">
<a href="gmetrics-CrapMetric.html" title="CrapMetric">CrapMetric</a>
</li>
<li class="none">
<a href="gmetrics-CyclomaticComplexityMetric.html" title="CyclomaticComplexity">CyclomaticComplexity</a>
</li>
<li class="none">
<a href="gmetrics-EfferentCouplingMetric.html" title="EfferentCoupling">EfferentCoupling</a>
</li>
<li class="none">
<a href="gmetrics-FieldCountMetric.html" title="FieldCount">FieldCount</a>
</li>
<li class="none">
<a href="gmetrics-MethodLineCountMetric.html" title="MethodLineCount">MethodLineCount</a>
</li>
<li class="none">
<a href="gmetrics-MethodCountMetric.html" title="MethodCount">MethodCount</a>
</li>
</ul>
<a href="http://sourceforge.net" title="Hosted on SourceForge.net" class="poweredBy">
<img class="poweredBy" alt="Hosted on SourceForge.net" src="http://sflogo.sourceforge.net/sflogo.php?group_id=208647&type=2" />
</a>
<a href="http://maven.apache.org" title="Build with Maven 2" class="poweredBy">
<img class="poweredBy" alt="Build with Maven 2" src="images/logos/maven-feather.png" />
</a>
</div>
</div>
<div id="bodyColumn">
<div id="contentBox">
<div class="section"><h2>SingleSeriesHtmlReportWriter<a name="SingleSeriesHtmlReportWriter"></a></h2><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ --><div class="section"><h3>Description<a name="Description"></a></h3><!-- ~~~~~~~~~~~ --><p>The <tt>org.gmetrics.report.SingleSeriesHtmlReportWriter</tt> class produces an HTML report of metric results based on a single metric, single level and single function to provide a single series of data.</p><p>The <i>metric</i>, <i>level</i> and <i>function</i> properties are required (must be non-null and non-empty). These three properties uniquely identify a single series of metric values.</p><p>See a <a href="./SampleGMetricsSingleSeriesReport.html">Sample Report</a>.</p></div><div class="section"><h3>Option Nested Elements<a name="Option_Nested_Elements"></a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~ --><p>The <b>option</b> element is a child of the <b>report</b> element and defines a report-specific option for a report.</p><p><tt>org.gmetrics.report.SingleSeriesHtmlReportWriter</tt> supports the following options:</p><table border="1" class="bodyTable"><tr class="a"><td align="left"><b>Attribute</b></td><td align="left"><b>Description</b></td><td align="left"><b>Required</b></td></tr><tr class="b"><td align="left">metric</td><td align="left">The name (case-sensitive) of a single Metric included in the analysis results (e.g. "CyclomaticComplexity").</td><td align="left">Yes</td></tr><tr class="a"><td align="left">level</td><td align="left">The single level at which results are included in the report. Valid <i>level</i> values are "package", "class" and "method".</td><td align="left">Yes</td></tr><tr class="b"><td align="left">function</td><td align="left">The function for which results are included in the report. Valid <i>function</i> values are metric-specific, but are typically "total", "average", "minimum" or "maximum".</td><td align="left">Yes</td></tr><tr class="a"><td align="left">outputFile</td><td align="left">The path and filename for the output report file.</td><td align="left">No</td></tr><tr class="b"><td align="left">title</td><td align="left">The title for the output report.</td><td align="left">No</td></tr><tr class="a"><td align="left">writeToStandardOut</td><td align="left">Set to "true" or <tt>true</tt> to write out the report to <i>stdout</i> (<tt>System.out</tt>) instead of writing to a file.</td><td align="left">No</td></tr><tr class="b"><td align="left">sort</td><td align="left">Controls whether the report results are sorted numerically. A value of <i>null</i> or empty means no sorting is performed; otherwise, the value must be either "ascending" or "descending".</td><td align="left">No</td></tr><tr class="a"><td align="left">maxResults</td><td align="left">Specifies the limit on the number of results included in the report. A value of <i>null</i>, zero or empty means no limit is applied; otherwise the value must be a positive integer.</td><td align="left">No</td></tr><tr class="b"><td align="left">greaterThan</td><td align="left">Specifies a lower-bound threshold -- only results with a larger value are included within the report. A value of <i>null</i> or empty means no lower-bound threshold is applied.</td><td align="left">No</td></tr><tr class="a"><td align="left">lessThan</td><td align="left">Specifies an upper-bound threshold -- only results with a smaller value are included within the report. A value of <i>null</i> or empty means no upper-bound threshold is applied.</td><td align="left">No</td></tr></table></div><div class="section"><h3>Example<a name="Example"></a></h3><!-- ~~~~~~~ --><p>Here is an example Ant XML build file illustrating configuration of <tt>org.gmetrics.report.SingleSeriesHtmlReportWriter</tt>.</p><div class="source"><pre><taskdef name="gmetrics" classname="org.gmetrics.ant.GMetricsTask">
<target name="runGMetrics">
<gmetrics>
<report type="org.gmetrics.report.SingleSeriesHtmlReportWriter">
<option name="outputFile" value="SampleGMetricsReport.html" />
<option name="title" value="Sample" />
<option name="metric" value="CyclomaticComplexity" />
<option name="level" value="class" />
<option name="function" value="average" />
<option name="maxResults" value="50" />
<option name="greaterThan" value="100.0" />
</report>
<fileset dir="src">
<include name="**/*.groovy"/>
</fileset>
</gmetrics>
</target>
</pre></div></div></div>
</div>
</div>
<div class="clear">
<hr/>
</div>
<div id="footer">
<div class="xright">Copyright © 2015.
All Rights Reserved.
</div>
<div class="clear">
<hr/>
</div>
</div>
</body>
</html>
|