org.jdepend.model

Class MetricPackageModel

java.lang.Object

org.jdepend.model.PackageModel

org.jdepend.model.MetricPackageModel

public class MetricPackageModel
extends PackageModel

The model for a package. In addition to the PackageModel class, this class compute various quality metrics about the package:

• Afferent coupling (Ca): This is the number of classes in other packages that depend upon classes within the package. It is an indicator of the package's responsibility
• Efferent coupling (Ce): This is the number of classes in other packages that the classes in the package depend upon. It is an indicator of the package's dependence on externalities
• Abstractness (A): It is the ratio from abstract classes to total classes
• Instability (I): 0 indicates a completely stable package, while 1 indicates a completely unstable package
• Distance from the main sequence (D): It is the perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability

Since:

0.4

Constructor Summary

Constructors

Constructor and Description
MetricPackageModel()
MetricPackageModel(java.lang.String path)

Method Summary

Modifier and Type	Method and Description
float	abstractness() Return the package's abstractness.
void	addClass(ClassModel clazz) Add a class in the package.
int	afferentCoupling() Return The afferent coupling (Ca) of this package.
void	dependUpon(MetricPackageModel model) Define that this package depend upon another package.
float	distance() Return the package's distance from the main sequence (D).
int	efferentCoupling() Return The efferent coupling (Ce) of this package.
int	getAbstractClassCount() Return the number of abstract classes in the package.
java.util.Map<java.lang.String,MetricPackageModel>	getAfferentCoupling() Return the Map of packages in other packages that that depend upon classes within the package.
int	getClassCount() Return the number of classes in the package.
java.util.Map<java.lang.String,ClassModel>	getClasses() Return the Map of classes in the package.
int	getConcreteClassCount() Return the number of concrete classes in the package.
java.util.Map<java.lang.String,MetricPackageModel>	getEfferentCoupling() Return the Map of packages in other packages that the classes in the package depend upon.
float	instability() Return the instability of this package. 0 indicates a completely stable package, while 1 indicates a completely unstable package.
boolean	isEmpty() Return true if the package does not contain any classes.

Methods inherited from class org.jdepend.model.PackageModel

addChild, getChildren, getName, getParent, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricPackageModel

public MetricPackageModel()

MetricPackageModel

public MetricPackageModel(java.lang.String path)

Method Detail

addClass

public void addClass(ClassModel clazz)

Add a class in the package.

Parameters:

clazz - the class

getClasses

public java.util.Map<java.lang.String,ClassModel> getClasses()

Return the Map of classes in the package.

Returns:

the Map of classes in the package

getClassCount

public int getClassCount()

Return the number of classes in the package.

Returns:

the number of classes in the package

isEmpty

public boolean isEmpty()

Return true if the package does not contain any classes. It should never be true.

Returns:

true if the package does not contain any classes

getAbstractClassCount

public int getAbstractClassCount()

Return the number of abstract classes in the package.

Returns:

the number of abstract classes in the package

getConcreteClassCount

public int getConcreteClassCount()

Return the number of concrete classes in the package.

Returns:

the number of concrete classes in the package

abstractness

public float abstractness()

Return the package's abstractness. It is the ratio from abstract classes to total classes.

Returns:

the package's abstractness

distance

public float distance()

Return the package's distance from the main sequence (D). The perpendicular distance of a package from the idealized line A + I = 1. This metric is an indicator of the package's balance between abstractness and stability. A package squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal packages are either completely abstract and stable (x=0, y=1) or completely concrete and unstable (x=1, y=0). The range for this metric is 0 to 1, with D=0 indicating a package that is coincident with the main sequence and D=1 indicating a package that is as far from the main sequence as possible.

Returns:

the package's distance from the main sequence

getAfferentCoupling

public java.util.Map<java.lang.String,MetricPackageModel> getAfferentCoupling()

Return the Map of packages in other packages that that depend upon classes within the package.

Returns:

the Map of packages in other packages that that depend upon classes within the package

afferentCoupling

public int afferentCoupling()

Return The afferent coupling (Ca) of this package. This is the number of classes in other packages that depend upon classes within the package. It is an indicator of the package's responsibility.

Returns:

the afferent coupling (Ca) of this package

getEfferentCoupling

public java.util.Map<java.lang.String,MetricPackageModel> getEfferentCoupling()

Return the Map of packages in other packages that the classes in the package depend upon.

Returns:

the Map of packages in other packages that the classes in the package depend upon

efferentCoupling

public int efferentCoupling()

Return The efferent coupling (Ce) of this package. This is the number of classes in other packages that the classes in the package depend upon. It is an indicator of the package's dependence on externalities.

Returns:

the efferent coupling (Ce) of this package

instability

public float instability()

Return the instability of this package. 0 indicates a completely stable package, while 1 indicates a completely unstable package.

Returns:

the instability

dependUpon

public void dependUpon(MetricPackageModel model)

Define that this package depend upon another package.

Parameters:

model - the package upon which this pakcage depend on.