Package org.somox.metrics.ratio

Class DMS

java.lang.Object
org.somox.metrics.abstractmetrics.AbstractMetric
org.somox.metrics.abstractmetrics.AbstractComposedMetric
org.somox.metrics.ratio.DMS
All Implemented Interfaces:
IMetric
public class DMS extends AbstractComposedMetric
DMS metric, calculated by using Abstractness and Instability The perpendicular normalized distance of an assembly from the idealized line A + I = 1 (called main sequence). This metric is an indicator of the assembly's balance between abstractness and stability. An assembly squarely on the main sequence is optimally balanced with respect to its abstractness and stability. Ideal assemblies are either completely abstract and stable (I=0, A=1) or completely concrete and instable (I=1, A=0). The range for this metric is 0 to 1, with D=0 indicating an assembly that is coincident with the main sequence and D=1 indicating an assembly that is as far from the main sequence as possible. see http://www.ndepend.com/Metrics.aspx#DitFromMainSeq

  • Field Details

    • METRIC_ID

      public static final MetricID METRIC_ID

  • Constructor Details

    • DMS

      public DMS()

  • Method Details

    • getMID

      public MetricID getMID()
      Returns the Metric ID of the Metric
      Returns:
      the metric id of the instance

    • getChildMetrics

      protected IMetric[] getChildMetrics(Map<MetricID,IMetric> allMetrics)
      Description copied from class: AbstractComposedMetric
      In a subclass override this method and return the subset of metrics in allMetrics which are needed in this composed metric.
      Specified by:
      getChildMetrics in class AbstractComposedMetric
      Parameters:
      allMetrics - The set of all metrics registered in the system via the metric extension point
      Returns:
      The subset of all metrics needed in this composed metric

    • getCompositionFunction

      protected ICompositionFunction getCompositionFunction(SoMoXConfiguration somoxConfiguration)
      Description copied from class: AbstractComposedMetric
      Return the function used to compose the set of child metrics
      Specified by:
      getCompositionFunction in class AbstractComposedMetric
      Parameters:
      somoxConfiguration - The somox configuration object used to initialize the function
      Returns:
      The function used to compute the composed metric

    • isNormalised

      public boolean isNormalised()
      Returns:
      whether the metric is normalized. If it is normalized, values of this metric must be between 0.0 and 1.0.