com.nomagic.magicdraw.metrics.types

Class Metric

java.lang.Object

com.nomagic.magicdraw.metrics.types.Metric

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

com.nomagic.magicdraw.metrics.types.BasicType, com.nomagic.magicdraw.metrics.types.DiagramsMetrics, com.nomagic.magicdraw.metrics.types.MetricsDifferentCalculationForPackagesAndClasses, com.nomagic.magicdraw.metrics.types.MetricsForClassEmploymentAbstract, com.nomagic.magicdraw.metrics.types.MetricsForPackageAbstract, com.nomagic.magicdraw.metrics.types.MetricsForPackagesAndClassesAbstract, com.nomagic.magicdraw.metrics.types.MetricsForWholeProject, NumberOfClassesMetric, com.nomagic.magicdraw.metrics.types.RelationshipsMetrics

@OpenApi
public abstract class Metric
extends java.lang.Object
implements java.lang.Cloneable

Metric class.

Constructor Summary

Constructors

Constructor and Description
Metric(java.lang.String name, java.lang.String abbreviation, MetricType type, java.lang.String id, int metricValueType) Metric constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptChild(BaseElement child) Return if the child is eligible to have their values calculated.
abstract boolean	acceptModelElement(BaseElement element) Check if the metrics can be calculated to the given element.
void	addProperties(java.util.Collection properties) Add a collection of properties to the metric properties.
void	addProperty(Property property) Add property to the metric properties.
MetricResult	calculate(BaseElement target, MetricsCalculator calculator) Calculate metrics values for local, global, average, min and max modes.
protected abstract MetricResult	calculateLocalMetricValue(BaseElement target) Implement this method to calculate the local metric value.
java.lang.String	getAbbreviation()
java.lang.String	getDescription()
java.lang.String	getID() Getter for id
java.lang.String	getName()
protected java.util.List	getPropertiesList() Must return a List of metrics properties.
MetricType	getType()
protected boolean	isCounted(BaseElement target) Used for determine if the element should be counted to get average values.
void	removeProperties(java.util.Collection properties) Remove a collection of properties from metric properties.
void	removeProperty(Property property) Remove the property from the metric properties.
static int	round(float number) Round to down.
void	setAbbreviation(java.lang.String abbreviation)
void	setDescription(java.lang.String description)
void	setID(java.lang.String id) Setter for id
protected void	setLimits(MetricResult result, BaseElement element) Set if the result is out of limits.
void	setName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

Metric

@OpenApi
public Metric(java.lang.String name,
                       java.lang.String abbreviation,
                       MetricType type,
                       java.lang.String id,
                       int metricValueType)

Metric constructor. Will create a metrics using the given parameters.

Parameters:

name - Unique name of the metric

abbreviation - Unique abbreviation of metric

type - MetricType

id - - Id unique for the metrics

metricValueType - metricValueType Use type from MetricValue constants class.

See Also:

MetricType, MetricValue, MetricResult

Method Detail

calculate

@OpenApi
public MetricResult calculate(BaseElement target,
                                       MetricsCalculator calculator)

Calculate metrics values for local, global, average, min and max modes. Override this method if your metric will use a different way to calculate these modes, or if you want to not to use them at all. Otherwise override the calculateLocalValue method

Parameters:

target - BaseElement.

calculator - MetricsCalculator

Returns:

MetricResult

See Also:

MetricsCalculator

acceptChild

@OpenApi
protected boolean acceptChild(BaseElement child)

Return if the child is eligible to have their values calculated. By default accept all elements that can be calculated for the metric.

Parameters:

child - BaseElement.

Returns:

boolean

isCounted

@OpenApi
protected boolean isCounted(BaseElement target)

Used for determine if the element should be counted to get average values. By default count all elements that can have metrics calculated for. Override if you need for example to calculate element metrics but dont include the element itself in the average count

Parameters:

target - BaseElement

Returns:

boolean

calculateLocalMetricValue

@OpenApi
protected abstract MetricResult calculateLocalMetricValue(BaseElement target)

Implement this method to calculate the local metric value. Will be called only if acceptModelElement(element) returns true.

Parameters:

target - BaseElement

Returns:

MetricResult MetricResult

acceptModelElement

@OpenApi
public abstract boolean acceptModelElement(BaseElement element)

Check if the metrics can be calculated to the given element. You have to provide verification if the given element is eligible to have metrics calculated for. However there are limitations regards the elements types that can be showed in metrics results windows. The allowed elements that can be displayed are: Class, Interfaces, Diagrams, Packages or Model packages You can check the if the element is eligible using acceptElement() method of MetricsManager

Parameters:

element - BaseElement

Returns:

boolean

round

@OpenApi
public static int round(float number)

Round to down. Ex. 1.5 is rounded to 1.

Parameters:

number - float to be rounded

Returns:

int

addProperty

@OpenApi
public void addProperty(Property property)

Add property to the metric properties. This property must be an instance of Property class or its subclasses.

Parameters:

property - Property

See Also:

Property

addProperties

@OpenApi
public void addProperties(java.util.Collection properties)

Add a collection of properties to the metric properties. If already exist a property with the same id, the property will be replaced. The property must be an instance of Property class or its subclasses.

Parameters:

properties - Collection of properties

See Also:

Property

removeProperties

@OpenApi
public void removeProperties(java.util.Collection properties)

Remove a collection of properties from metric properties. If already exist a property with the same id, the property will be replaced. The property must be an instance of Property class or its subclasses.

Parameters:

properties - Collection of properties

See Also:

Property

removeProperty

@OpenApi
public void removeProperty(Property property)

Remove the property from the metric properties. This property must be an instance of Property class or its subclasses.

Parameters:

property - Property

See Also:

Property

getAbbreviation

@OpenApi
public java.lang.String getAbbreviation()

Returns:

Returns the abbreviation.

setAbbreviation

@OpenApi
public void setAbbreviation(java.lang.String abbreviation)

Parameters:

abbreviation - The abbreviation to set.

getDescription

@OpenApi
public java.lang.String getDescription()

Returns:

Returns the description.

setDescription

@OpenApi
public void setDescription(java.lang.String description)

Parameters:

description - The description to set.

getName

@OpenApi
public java.lang.String getName()

Returns:

Returns the name.

setName

@OpenApi
public void setName(java.lang.String name)

Parameters:

name - The name to set.

getType

@OpenApi
public MetricType getType()

Returns:

Returns the type.

setLimits

@OpenApi
protected void setLimits(MetricResult result,
                                  BaseElement element)

Set if the result is out of limits. Works for class, diagrams and packages limits properties

Parameters:

result - MetricResult

element - BaseElement.

getPropertiesList

@OpenApi
protected java.util.List getPropertiesList()

Must return a List of metrics properties. Properties must form Property kind.

Returns:

List of properties

getID

@OpenApi
public java.lang.String getID()

Getter for id

Returns:

Metric ID

setID

@OpenApi
public void setID(java.lang.String id)

Setter for id

Parameters:

id -