org.somox.metrics.abstractmetrics

Class AbstractMetric

java.lang.Object

org.somox.metrics.abstractmetrics.AbstractMetric

All Implemented Interfaces:

IMetric

Direct Known Subclasses:

AbstractComposedMetric, AbstractCountingMetric, AbstractHierarchyMapping, NameResemblance, SliceLayerArchitectureQuality, SubsystemComponent

public abstract class AbstractMetric
extends Object
implements IMetric

Abstract base class of all metrics, contains convenience functions and basic method implementations

Author:

Steffen Becker

Constructor Summary

Constructors

Constructor and Description
AbstractMetric()

Method Summary

Modifier and Type	Method and Description
void	computeDirected(ClusteringRelation relationToCompute) Computes the metric for the given clustering relation and stores the value in it
MetricTab	getLaunchConfigurationTab() Returns the GUI launch configuration tab that can be used to configure the metric.
ParameterDescriptor[]	getMetricParameters() The parameters needed by this metric for its computation.
void	initialize(Root gastModel, SoMoXConfiguration somoxConfiguration, Map<MetricID,IMetric> allMetrics, <any> accessGraph, ComponentToImplementingClassesHelper componentToClassHelper) Initializes the Metric.
abstract boolean	isCommutative()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.somox.metrics.IMetric

getMID, isNormalised

Constructor Detail

AbstractMetric

public AbstractMetric()

Method Detail

computeDirected

public void computeDirected(ClusteringRelation relationToCompute)

Description copied from interface: IMetric

Computes the metric for the given clustering relation and stores the value in it

Specified by:

computeDirected in interface IMetric

getLaunchConfigurationTab

public MetricTab getLaunchConfigurationTab()

Description copied from interface: IMetric

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

getMetricParameters

public ParameterDescriptor[] getMetricParameters()

Description copied from interface: IMetric

The parameters needed by this metric for its computation. Parameters will be shown on the UI and their values will be passed to the metric during initialization of the metric

Specified by:

getMetricParameters in interface IMetric

Returns:

A list of parameter descriptors for the parameters of this metric

isCommutative

public abstract boolean isCommutative()

Specified by:

isCommutative in interface IMetric

Returns:

true if the metric gives the same result if firstComponent and secondComponent are swapped

initialize

public void initialize(Root gastModel,
                       SoMoXConfiguration somoxConfiguration,
                       Map<MetricID,IMetric> allMetrics,
                       <any> accessGraph,
                       ComponentToImplementingClassesHelper componentToClassHelper)

Description copied from interface: IMetric

Initializes the Metric. Must be called before metrics are computed. Should be called again, if the model changed

Specified by:

initialize in interface IMetric

Parameters:

gastModel - the Root object of the GAST model

somoxConfiguration - the configuration of the metric computation

allMetrics - A map of all metrics available in the running SoMoX instance, maps metricID to Metric implementation

accessGraph - A graph which contains the number of accesses from the source GASTClass to the target GASTClass for all edges in the

componentToClassHelper - Helper initialized graph