Package org.somox.analyzer.simplemodelanalyzer.metrics

Class DefaultCompositionIndicatingMetric

java.lang.Object
org.somox.metrics.abstractmetrics.AbstractMetric
org.somox.metrics.abstractmetrics.AbstractComposedMetric
org.somox.analyzer.simplemodelanalyzer.metrics.DefaultCompositionIndicatingMetric
All Implemented Interfaces:
IMetric
public class DefaultCompositionIndicatingMetric extends AbstractComposedMetric
This class encapsulates the strategy used to compute the overall metric of the relationship of two components

  • Field Details

    • METRIC_ID

      public static final MetricID METRIC_ID
      ID of this metric

  • Constructor Details

    • DefaultCompositionIndicatingMetric

      public DefaultCompositionIndicatingMetric()

  • Method Details

    • getMID

      public MetricID getMID()
      Description copied from interface: IMetric
      Returns the Metric ID of the Metric
      Returns:
      the metric id of the instance

    • 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

    • 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

    • getLaunchConfigurationTab

      public MetricTab getLaunchConfigurationTab()
      Returns the GUI launch configuration tab that can be used to configure the metric. Override if the metric supplies a tab
      Specified by:
      getLaunchConfigurationTab in interface IMetric
      Overrides:
      getLaunchConfigurationTab in class AbstractMetric

    • 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.