10139N/A exclude-result-prefixes="xalan"
10139N/A extension-element-prefixes="redirect">
10139N/A<xsl:output method="html" indent="yes" encoding="US-ASCII"/>
10139N/A<xsl:decimal-format decimal-separator="." grouping-separator="," />
10139N/A Copyright 2001-2004 The Apache Software Foundation
15291N/A Licensed under the Apache License, Version 2.0 (the "License");
10139N/A you may not use this file except in compliance with the License.
10615N/A You may obtain a copy of the License at
10139N/A Unless required by applicable law or agreed to in writing, software
10139N/A distributed under the License is distributed on an "AS IS" BASIS,
10139N/A WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16560N/A See the License for the specific language governing permissions and
12773N/A @author Stephane Bailliez <a href="mailto:sbailliez@apache.org"/>
10640N/A<!-- default max value for the metrics -->
14420N/A<!-- create a tree fragment to speed up processing -->
16472N/A <xsl:for-each select=".//class">
16442N/A <xsl:value-of select="(ancestor::package)[last()]/@name"/>
10139N/A <xsl:apply-templates select=".//package"/>
10139N/A <!-- @bug there will be a problem with inner classes having the same name, it will be overwritten -->
10139N/A <!--Processing <xsl:value-of select="$
class.name"/><xsl:text> </xsl:text> -->
11087N/A<!-- little trick to compute the classname for inner and non inner classes -->
11087N/A<!-- this is all in one line to avoid CRLF in the name -->
16998N/A <xsl:if test="parent::class"><xsl:apply-templates select="parent::class" mode="
class.name"/>.<xsl:value-of select="@name"/></xsl:if><xsl:if test="not(parent::class)"><xsl:value-of select="@name"/></xsl:if>
16684N/A <HEAD><TITLE>Metrics Results.</TITLE></HEAD>
10139N/A This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
10139N/A<!-- this is the stylesheet css to use for nearly everything -->
11344N/A<body style="text-align:justify;">
10139N/A<h3>Cyclomatic Complexity - V(G)</h3>
10139N/AThis metric was introduced in the 1970s to measure the amount of control
10139N/Aflow complexity or branching complexity in a module such as a
10139N/Asubroutine. It gives the number of paths that may be taken through the
10139N/Acode, and was initially developed to give some measure of the cost of
10139N/Aproducing a test case for the module by executing each path.
10139N/AMethods with a high cyclomatic complexity tend to be more difficult to
10139N/Aunderstand and maintain. In general the more complex the methods of an
10139N/Aapplication, the more difficult it will be to test it, and this will adversely
10139N/AV(G) is a measure of the control flow complexity of a method or
10139N/Aconstructor. It counts the number of branches in the body of the method,
16786N/AThe metric can also be configured to count each case of a switch
10139N/AThis is perhaps the simplest of all the metrics to define and compute.
10139N/ACounting lines has a long history as a software metric dating from before
10139N/Athe rise of structured programming, and it is still in widespread use today.
10139N/AThe size of a method affects the ease with which it can be understood, its
10139N/Areusability and its maintainability. There are a variety of ways that the size
10139N/Acan be calculated. These include counting all the lines of code, the number
10139N/Aof statements, the blank lines of code, the lines of commentary, and the
10139N/Alines consisting only of syntax such as block delimiters.
10139N/AThis metric can also be used for sizing other constructs as well, for
10139N/Aexample, the overall size of a Java class or package can be measured by
10139N/Acounting the number of source lines it consists of.
10139N/ALOC can be used to determine the size of a compilation unit (source file),
10139N/Aclass or interface, method, constructor, or field. It can be configured to
10139N/A<li>lines consisting only of comments;</li>
10139N/A<li>lines consisting only of opening and closing braces.</li>
10139N/A<h3>Depth of Inheritance Hierarchy - DIT</h3>
10139N/AThis metric calculates how far down the inheritance hierarchy a class is
10139N/Asuperclass, which is defined to have a depth of 1. So a class that
10139N/Asubclasses will have a value of 3, and so on.
10139N/AA class that is deep within the tree inherits more methods and state
10139N/Avariables, thereby increasing its complexity and making it difficult to
10139N/Apredict its behavior. It can be harder to understand a system with many
10139N/ADIT is defined for classes and interfaces:
10139N/A<li>all interface types have a depth of 1;</li>
10139N/A<li>all other classes have a depth of 1 + the depth of their super class.</li>
10139N/A<h3>Number of Attributes - NOA</h3>
10139N/AThe number of distinct state variables in a class serves as one measure of
10139N/Aits complexity. The more state a class represents the more difficult it is to
10139N/Amaintain invariants for it. It also hinders comprehensibility and reuse.
10139N/AIn Java, state can be exposed to subclasses through protected fields, which
10139N/Aentails that the subclass also be aware of and maintain any invariants. This
10139N/Ainterference with the class's data encapsulation can be a source of defects
10139N/Aand hidden dependencies between the state variables.
10139N/ANOA is defined for classes and interfaces. It counts the number of fields
10139N/Adeclared in the class or interface.
10139N/A<h3>Number of Remote Methods - NRM</h3>
10139N/ANRM is defined for classes. A remote method call is defined as an
16998N/Ainvocation of a method that is not declared in any of:
16976N/A<li>a class or interface that the class extends or implements;</li>
16977N/A<li>a class or method that extends the class.</li>
16786N/AThe value is the count of all the remote method calls in all of the methods
16771N/A<h3>Number of Local Methods - NLM</h3>
16690N/ANLM is defined for classes and interfaces. A local method is defined as a
16690N/Amethod that is declared in the class or interface. NLM can be configured to
16684N/Ainclude the local methods of all of the class's superclasses. Methods with
16684N/Apublic, protected, package and private visibility can be independently
16684N/Acounted by setting configuration parameters.
16685N/A<h3>Weighted Methods per Class - WMC</h3>
16640N/AIf the number of methods in a class can be determined during the design
16640N/Aand modeling phase of a project, it can be used as a predictor of how
16640N/Amuch time and effort is needed to develop, debug and maintain it. This
16614N/Ametric can be further refined by incorporating a weighting for the
16614N/Acomplexity of each method. The usual weighting is given by the cyclomatic
16560N/AThe subclasses of a class inherit all of its public and protected methods,
16560N/Aand possibly its package methods as well, so the number of methods a
16560N/Aclass has directly impacts the complexity of its subclasses. Classes with
16560N/Alarge numbers of methods are often specific to a particular application,
16560N/Areducing the ability to reuse them.
16505N/AThe definition of WMC is based upon NLM, and it provides the same
16486N/Aconfiguration parameters for counting inherited methods and of varying
16486N/Avisibility. The main difference is that NLM always counts each method as 1,
16442N/Awhereas WMC will weight each method. There are two weighting schemes:
16442N/A<li>V(G) the cyclomatic complexity of the method is used as its weight.
16442N/A Methods from class files are given a V(G) of 1.</li>
16436N/A<li>the arity, or the number of parameters of the method are used to
16382N/A<h3>Response For Class - RFC</h3>
16356N/AThe response set of a class is the set of all methods that can be invoked as
16347N/Aa result of a message sent to an object of the class. This includes methods
16347N/Ain the class's inheritance hierarchy and methods that can be invoked on
16347N/Aother objects. The Response For Class metric is defined to be size of the
16155N/Aresponse set for the class. A class which provides a larger response set is
16155N/Aconsidered to be more complex than one with a smaller response set.
16026N/AOne reason for this is that if a method call on a class can result in a large
15858N/Anumber of different method calls on the target and other classes, then it
15858N/Acan be harder to test the behavior of the class and debug problems. It will
15759N/Atypically require a deeper understanding of the potential interactions that
15759N/Aobjects of the class can have with the rest of the system.
15700N/ARFC is defined as the sum of NLM and NRM for the class. The local methods
15693N/Ainclude all of the public, protected, package and private methods, but not
15693N/Amethods declared only in a superclass.
15528N/A<h3>Data Abstraction Coupling - DAC</h3>
15528N/ADAC is defined for classes and interfaces. It counts the number of reference
15528N/Atypes that are used in the field declarations of the class or interface. The
15528N/Acomponent types of arrays are also counted. Any field with a type that is
15472N/Aeither a supertype or a subtype of the class is not counted.
15449N/AFANOUT is defined for classes and interfaces, constructors and methods. It
15449N/Acounts the number of reference types that are used in:
15301N/A<li>formal parameters and return types;</li>
15275N/AThe component types of arrays are also counted. Any type that is either a
15219N/Asupertype or a subtype of the class is not counted.
14503N/A<h3>Coupling Between Objects - CBO</h3>
14464N/AWhen one object or class uses another object or class they are said to be
14420N/Acoupled. One major source of coupling is that between a superclass and a
14420N/Asubclass. A coupling is also introduced when a method or field in another
14420N/Aclass is accessed, or when an object of another class is passed into or out
14185N/Aof a method invocation. Coupling Between Objects is a measure of the
14185N/Anon-inheritance coupling between two objects.
14123N/AA high value of coupling reduces the modularity of the class and makes
13925N/Areuse more difficult. The more independent a class is the more likely it is
13925N/Athat it will be possible to reuse it in another part of the system. When a
13932N/Aclass is coupled to another class it becomes sensitive to changes in that
13754N/Aclass, thereby making maintenance for difficult. In addition, a class that is
13754N/Aoverly dependent on other classes can be difficult to understand and test in
13644N/ACBO is defined for classes and interfaces, constructors and methods. It
13644N/Acounts the number of reference types that are used in:
13416N/A<li>formal parameters and return types</li>
13103N/A<li>types from which field and method selections are made</li>
12988N/AThe component types of arrays are also counted. Any type that is either a
12972N/Asupertype or a subtype of the class is not counted.
12571N/A<h3>Lack of Cohesion Of Methods - LCOM</h3>
12571N/AThe cohesion of a class is the degree to which its methods are related to
12466N/Aeach other. It is determined by examining the pattern of state variable
12466N/Aaccesses within the set of methods. If all the methods access the same state
12413N/Avariables then they have high cohesion; if they access disjoint sets of
12413N/Avariables then the cohesion is low. An extreme example of low cohesion
12413N/Awould be if none of the methods accessed any of the state variables.
12402N/AIf a class exhibits low method cohesion it indicates that the design of the
12402N/Aclass has probably been partitioned incorrectly, and could benefit by being
12402N/Asplit into more classes with individually higher cohesion. On the other
12402N/Ahand, a high value of cohesion (a low lack of cohesion) implies that the
12387N/Aclass is well designed. A cohesive class will tend to provide a high degree
12387N/Aof encapsulation, whereas a lack of cohesion decreases encapsulation and
12308N/AAnother form of cohesion that is useful for Java programs is cohesion
12308N/Abetween nested and enclosing classes. A nested class that has very low
12308N/Acohesion with its enclosing class would probably better designed as a peer
12288N/Aclass rather than a nested class.
12219N/ALCOM is defined for classes. Operationally, LCOM takes each pair of
12219N/Amethods in the class and determines the set of fields they each access. If
12071N/Athey have disjoint sets of field accesses increase the count P by one. If they
12071N/Ashare at least one field access then increase Q by one. After considering
11828N/AIndirect access to fields via local methods can be considered by setting a
11819N/A<h3>Number Of Classes - NOC</h3>
11416N/AThe overall size of the system can be estimated by calculating the number
11344N/Aof classes it contains. A large system with more classes is more complex
11344N/Athan a smaller one because the number of potential interactions between
11253N/Aobjects is higher. This reduces the comprehensibility of the system which
11253N/Ain turn makes it harder to test, debug and maintain.
11183N/AIf the number of classes in the system can be projected during the initial
11172N/Adesign phase of the project it can serve as a base for estimating the total
11172N/Aeffort and cost of developing, debugging and maintaining the system.
11120N/AThe NOC metric can also usefully be applied at the package and class level
11067N/ANOCL is defined for class and interfaces. It counts the number of classes or
11067N/Ainterfaces that are declared. This is usually 1, but nested class declarations
10917N/A<!-- this is the stylesheet css to use for nearly everything -->
10820N/A font:normal 80% arial,helvetica,sanserif;
10139N/A<!-- print the metrics of the class -->
10139N/A <xsl:call-template name="pageHeader"/>
10139N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
10139N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
10139N/A <xsl:call-template name="pageFooter"/>
10139N/A<!-- list of classes in a package -->
10139N/A <!-- xalan-nodeset:nodeset for Xalan 1.2.2 -->
10139N/A <a href="{@name}.html" target="classFrame"><xsl:value-of select="@name"/></a>
10139N/A each package existing on testsuites.
10139N/A @bug there will be a problem here, I don't know yet how to handle unnamed package :(
10139N/A <xsl:apply-templates select=".//package[not(./@name = 'unnamed package')]" mode="
all.packages">
10139N/A <xsl:call-template name="pageHeader"/>
10139N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
10139N/A <table border="0" width="100%">
10139N/A <td style="text-align: justify;">
10139N/A Note: Metrics evaluate the quality of software by analyzing the program source and quantifying
10139N/A various kind of complexity. Complexity is a common source of problems and defects in software.
10139N/A High complexity makes it more difficult to develop, understand, maintain, extend, test and debug
10139N/A The primary use of metrics is to focus your attention on those parts of code that potentially are
10139N/A complexity hot spots. Once the complex areas your program have been uncovered, you can take remedial
10139N/A For additional information about metrics and their meaning, please consult
10139N/A <table border="0" cellpadding="5" cellspacing="2" width="100%">
10139N/A <xsl:for-each select=".//package[not(@name = 'unnamed package')]">
10139N/A <xsl:sort select="@name" order="ascending"/>
10139N/A <!-- @bug there could some classes at this level (classes in unnamed package) -->
10139N/A <xsl:call-template name="pageFooter"/>
10139N/A <xsl:call-template name="pageHeader"/>
10139N/A <!-- create an anchor to this package name -->
10139N/A <h3>Package <xsl:value-of select="@name"/></h3>
10139N/A <table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
<table border="0" width="100%">
<td style="text-align: justify;">
Note: Metrics evaluate the quality of software by analyzing the program source and quantifying
various kind of complexity. Complexity is a common source of problems and defects in software.
High complexity makes it more difficult to develop, understand, maintain, extend, test and debug
The primary use of metrics is to focus your attention on those parts of code that potentially are
complexity hot spots. Once the complex areas your program have been uncovered, you can take remedial
For additional information about metrics and their meaning, please consult
<xsl:if test="count($classes-in-package) > 0">
<table class="log" border="0" cellpadding="5" cellspacing="2" width="100%">
<xsl:for-each select="$classes-in-package">
<xsl:sort select="@name"/>
<xsl:call-template name="pageFooter"/>
transform string like
a.b.c to ../../../
@param path the path to transform into a descending directory path
<xsl:template name="path">
<xsl:if test="contains($path,'.')">
<xsl:call-template name="path">
<xsl:with-param name="path"><xsl:value-of select="substring-after($path,'.')"/></xsl:with-param>
<xsl:if test="not(contains($path,'.')) and not($path = '')">
<!-- create the link to the stylesheet based on the package name -->
<LINK REL ="stylesheet" TYPE="
text/css" TITLE="Style"><xsl:attribute name="href"><xsl:if test="not($
package.name = 'unnamed package')"><xsl:call-template name="path"><xsl:with-param name="path" select="$
package.name"/></xsl:call-template></xsl:if>
stylesheet.css</xsl:attribute></LINK>
<xsl:template name="pageHeader">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<td class="bannercell" rowspan="2">
<td style="text-align:right"><h2>Source Code Metrics</h2></td>
<xsl:template name="pageFooter">
<tr><td><hr noshade="yes" size="1"/></td></tr>
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2001, Apache Software Foundation
<th width="80%">Name</th>
<th nowrap="nowrap">V(G)</th>
<th width="80%">Name</th>
<th nowrap="nowrap">V(G)</th>
<!-- method information -->
<xsl:call-template name="alternate-row"/>
<td><xsl:apply-templates select="@name"/></td>
<td><xsl:apply-templates select="@vg"/></td>
<td><xsl:apply-templates select="@loc"/></td>
<td><xsl:apply-templates select="@fanout"/></td>
<td><xsl:apply-templates select="@cbo"/></td>
<!-- class information -->
<xsl:call-template name="alternate-row"/>
<td><a href="{@name}.html"><xsl:value-of select="@name"/></a></td>
<td><xsl:apply-templates select="@vg"/></td>
<td><xsl:apply-templates select="@loc"/></td>
<td><xsl:apply-templates select="@dit"/></td>
<td><xsl:apply-templates select="@noa"/></td>
<td><xsl:apply-templates select="@nrm"/></td>
<td><xsl:apply-templates select="@nlm"/></td>
<td><xsl:apply-templates select="@wmc"/></td>
<td><xsl:apply-templates select="@rfc"/></td>
<td><xsl:apply-templates select="@dac"/></td>
<td><xsl:apply-templates select="@fanout"/></td>
<td><xsl:apply-templates select="@cbo"/></td>
<td><xsl:apply-templates select="@lcom"/></td>
<td><xsl:apply-templates select="@nocl"/></td>
<xsl:call-template name="alternate-row"/>
<xsl:value-of select="@name"/>
<td><xsl:apply-templates select="@vg"/></td>
<td><xsl:apply-templates select="@loc"/></td>
<td><xsl:apply-templates select="@dit"/></td>
<td><xsl:apply-templates select="@noa"/></td>
<td><xsl:apply-templates select="@nrm"/></td>
<td><xsl:apply-templates select="@nlm"/></td>
<td><xsl:apply-templates select="@wmc"/></td>
<td><xsl:apply-templates select="@rfc"/></td>
<td><xsl:apply-templates select="@dac"/></td>
<td><xsl:apply-templates select="@fanout"/></td>
<td><xsl:apply-templates select="@cbo"/></td>
<td><xsl:apply-templates select="@lcom"/></td>
<td><xsl:apply-templates select="@nocl"/></td>
<xsl:call-template name="alternate-row"/>
<!-- the global metrics is the top package metrics -->
<td><xsl:apply-templates select="./package/@vg"/></td>
<td><xsl:apply-templates select="./package/@loc"/></td>
<td><xsl:apply-templates select="./package/@dit"/></td>
<td><xsl:apply-templates select="./package/@noa"/></td>
<td><xsl:apply-templates select="./package/@nrm"/></td>
<td><xsl:apply-templates select="./package/@nlm"/></td>
<td><xsl:apply-templates select="./package/@wmc"/></td>
<td><xsl:apply-templates select="./package/@rfc"/></td>
<td><xsl:apply-templates select="./package/@dac"/></td>
<td><xsl:apply-templates select="./package/@fanout"/></td>
<td><xsl:apply-templates select="./package/@cbo"/></td>
<td><xsl:apply-templates select="./package/@lcom"/></td>
<td><xsl:apply-templates select="./package/@nocl"/></td>
<!-- alternated row style -->
<xsl:template name="alternate-row">
<xsl:attribute name="class">
<xsl:if test="position() mod 2 = 1">a</xsl:if>
<xsl:if test="position() mod 2 = 0">b</xsl:if>
<!-- how to display the metrics with their max value -->
<!-- @todo the max values must be external to the xsl -->
<xsl:template match="@vg">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
vg.max"/>
<xsl:template match="@loc">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
loc.max"/>
<xsl:template match="@dit">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
dit.max"/>
<xsl:template match="@noa">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
noa.max"/>
<xsl:template match="@nrm">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
nrm.max"/>
<xsl:template match="@nlm">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
nlm.max"/>
<xsl:template match="@wmc">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
wmc.max"/>
<xsl:template match="@rfc">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
rfc.max"/>
<xsl:template match="@dac">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
dac.max"/>
<xsl:template match="@fanout">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:template match="@cbo">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
cbo.max"/>
<xsl:template match="@lcom">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
lcom.max"/>
<xsl:template match="@nocl">
<xsl:call-template name="display-value">
<xsl:with-param name="value" select="current()"/>
<xsl:with-param name="max" select="$
nocl.max"/>
<xsl:template name="display-value">
<xsl:param name="value"/>
<xsl:if test="$value > $max">
<xsl:attribute name="class">Error</xsl:attribute>
<xsl:value-of select="$value"/>
