net.sourceforge.pmd.lang.java.oom

Class AbstractMetric

java.lang.Object

net.sourceforge.pmd.lang.java.oom.AbstractMetric

All Implemented Interfaces:

Metric

Direct Known Subclasses:

AtfdMetric, CycloMetric, LocMetric, NcssMetric, WmcMetric

public abstract class AbstractMetric
extends Object
implements Metric

Base class for metrics. Metric objects encapsulate the computational logic required to compute a metric from a PackageStats and node. They're stateless.

Author:

Clément Fournier

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.pmd.lang.java.oom.api.Metric

Metric.Version

Constructor Summary

Constructors

Constructor and Description
AbstractMetric()

Method Summary

Methods

Modifier and Type	Method and Description
protected static double	averageMetricOverOperations(ASTClassOrInterfaceDeclaration node, OperationMetricKey key, MetricVersion version, boolean includeNested) Gets the average of the value of an operation metric over all operations in this class (excluding nested classes).
protected List<QualifiedName>	findAllCalls(ASTMethodOrConstructorDeclaration node)
static List<ASTMethodOrConstructorDeclaration>	findOperations(ASTClassOrInterfaceDeclaration node, boolean includeNested) Finds the declaration nodes of all methods or constructors that are declared inside a class.
protected static PackageStats	getTopLevelPackageStats() Gives access to the toplevel package stats to metrics without having to pass them as a parameter to metrics.
protected static double	highestMetricOverOperations(ASTClassOrInterfaceDeclaration node, OperationMetricKey key, MetricVersion version, boolean includeNested) Gets the highest value of an operation metric over all operations in this class (excluding nested classes).
protected static double	sumMetricOverOperations(ASTClassOrInterfaceDeclaration node, OperationMetricKey key, MetricVersion version, boolean includeNested) Gets the sum of the value of an operation metric over all operations in this class (excluding nested classes).
boolean	supports(AccessNode node) Default implementation of the supports method, which filters out abstract nodes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMetric

public AbstractMetric()

Method Detail

getTopLevelPackageStats

protected static PackageStats getTopLevelPackageStats()

Gives access to the toplevel package stats to metrics without having to pass them as a parameter to metrics.

Returns:

The toplevel package stats (singleton contained within Metrics.

sumMetricOverOperations

protected static double sumMetricOverOperations(ASTClassOrInterfaceDeclaration node,
                             OperationMetricKey key,
                             MetricVersion version,
                             boolean includeNested)

Gets the sum of the value of an operation metric over all operations in this class (excluding nested classes). The computation is not forced (memoized results are used if they can be found).

Parameters:

node - The class node.

key - The operation metric to use.

version - Version of the metric.

includeNested - Adds the operations of nested classes to the sum.

Returns:

Returns the sum of a metric over all operations of a class.

averageMetricOverOperations

protected static double averageMetricOverOperations(ASTClassOrInterfaceDeclaration node,
                                 OperationMetricKey key,
                                 MetricVersion version,
                                 boolean includeNested)

Gets the average of the value of an operation metric over all operations in this class (excluding nested classes). The computation is not forced (memoized results are used if they can be found).

Parameters:

node - The class node.

key - The operation metric to use.

version - Version of the metric.

includeNested - Adds the operations of nested classes to the sum.

Returns:

Returns the average of a metric over all operations of a class.

highestMetricOverOperations

protected static double highestMetricOverOperations(ASTClassOrInterfaceDeclaration node,
                                 OperationMetricKey key,
                                 MetricVersion version,
                                 boolean includeNested)

Gets the highest value of an operation metric over all operations in this class (excluding nested classes). The computation is not forced (memoized results are used if they can be found).

Parameters:

node - The class node.

key - The operation metric to use.

version - Version of the metric.

includeNested - Adds the operations of nested classes to the sum.

Returns:

Returns the highest value of a metric over all operations of a class.

findOperations

public static List<ASTMethodOrConstructorDeclaration> findOperations(ASTClassOrInterfaceDeclaration node,
                                                     boolean includeNested)

Finds the declaration nodes of all methods or constructors that are declared inside a class.

Parameters:

node - The class in which to look for.

includeNested - Include operations found in nested classes?

Returns:

The list of all operations declared inside the specified class.

findAllCalls

protected List<QualifiedName> findAllCalls(ASTMethodOrConstructorDeclaration node)

supports

public boolean supports(AccessNode node)

Default implementation of the supports method, which filters out abstract nodes. Metrics that support abstract nodes should override this method.

Specified by:

supports in interface Metric

Parameters:

node - The node to check.

Returns:

True if the metric can be computed on this node.