org.opalj.hermes.queries.Metrics.markdown Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opal-developer-tools_2.11 Show documentation

OPAL-Developer Tools

The newest version!

# Metrics
Computes basic metrics for a given project. Each given metric is represented in different feature categories.


  
    Name
    Description
  
  
    Fields Per Class (FPC)
    Extracts how often a class has 0, between 1 and 3, between 4 and 10, or more than 10 fields.
  
  
    Methods Per Class (MPC)
    Extracts how often a class has 0, between 1 and 3, between 4 and 10, or more than 10 methods.
  
  
    Classes Per Package (CPP)
    Extracts how often a package has between 1 and 3, between 4 and 10, or more than 10 classes.
  
  
      McCabe
      Extracts how often a method has a complexity of 1 (linear), between 2 and 3, between 4 and 10, or more than 10.
      Please note that this analysis also takes exceptions into account.
    
  
      number of children (NOC)
      Extracts how often a class has 0, between 1 and 3, between 4 and 10, or more than 10 children. 
      This metric is the number of direct descendants (subclasses) for each class. Classes with large number of children are considered to be difficult to modify and usually require more testing because of the effects on changes on all the children. They are also considered more complex and fault-prone because a class with numerous children may have to provide services in a larger number of contexts and therefore must be more flexible [1].
    


[1] Basili, V. R., Briand, L. C., and Melo, W. L., "A Validation of Object Orient Design Metrics as
Quality Indicators," IEEE Transactions on Software Engineering, vol. 21, pp. 751-761, 1996.

Name	Description
Fields Per Class (FPC)	Extracts how often a class has 0, between 1 and 3, between 4 and 10, or more than 10 fields.
Methods Per Class (MPC)	Extracts how often a class has 0, between 1 and 3, between 4 and 10, or more than 10 methods.
Classes Per Package (CPP)	Extracts how often a package has between 1 and 3, between 4 and 10, or more than 10 classes.
McCabe	Extracts how often a method has a complexity of 1 (linear), between 2 and 3, between 4 and 10, or more than 10. Please note that this analysis also takes exceptions into account.
number of children (NOC)	Extracts how often a class has 0, between 1 and 3, between 4 and 10, or more than 10 children. This metric is the number of direct descendants (subclasses) for each class. Classes with large number of children are considered to be difficult to modify and usually require more testing because of the effects on changes on all the children. They are also considered more complex and fault-prone because a class with numerous children may have to provide services in a larger number of contexts and therefore must be more flexible [1].