com.nomagic.magicdraw.metrics

Class MetricsManager

java.lang.Object

com.nomagic.magicdraw.metrics.MetricsManager

@OpenApi
public class MetricsManager
extends java.lang.Object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acceptDiagramElement(BaseElement element) Verify if the element is a diagram
boolean	acceptElement(BaseElement element) Verify if the model element is eligible to be shown in the metrics' element list and metrics table results.
void	addMetric(Metric metric) Add a metric to the container.
void	addMetrics(java.util.Collection metrics) Add metrics to the container.
void	addMetricsSuite(MetricsSuite metricsSuite) Add a metric suite to the system.
boolean	contains(java.lang.String metricsSuiteID) Check if exists a metrics suite with the given ID
static MetricsManager	getInstance() Returns a shared instance of metrics manager.
MetricsSuite	getMetricsSuite(java.lang.String name) Return the metrics suites for the given name.
MetricsSuite	getMetricsSuiteByID(java.lang.String id) Return the metrics suites for the given name.
void	removeMetric(Metric metric) Remove the metric from the container.
void	removeMetric(java.lang.String id) Remove the metric with the given id from the metrics container.
void	removeMetricsSuite(MetricsSuite metricsSuite) Remove a metrics suite from the system.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

@OpenApi
public static MetricsManager getInstance()

Returns a shared instance of metrics manager.

Returns:

instance of metrics manager.

acceptElement

@OpenApi
public boolean acceptElement(BaseElement element)

Verify if the model element is eligible to be shown in the metrics' element list and metrics table results.

Parameters:

element - BaseElement

Returns:

boolean

acceptDiagramElement

@OpenApi
public boolean acceptDiagramElement(BaseElement element)

Verify if the element is a diagram

Parameters:

element - BaseElement

Returns:

boolean

removeMetricsSuite

@OpenApi
public void removeMetricsSuite(MetricsSuite metricsSuite)

Remove a metrics suite from the system.

Parameters:

metricsSuite - MetricsSuits

addMetricsSuite

@OpenApi
public void addMetricsSuite(MetricsSuite metricsSuite)

Add a metric suite to the system.

Parameters:

metricsSuite - MetricsSuits

addMetric

@OpenApi
public void addMetric(Metric metric)

Add a metric to the container. If the metric has the same ID, the metric will be replaced.

Parameters:

metric - Metric

getMetricsSuiteByID

@OpenApi
public MetricsSuite getMetricsSuiteByID(java.lang.String id)

Return the metrics suites for the given name.

Parameters:

id - Metrics suites' id

Returns:

MetricsSuite MetricSuit

addMetrics

@OpenApi
public void addMetrics(java.util.Collection metrics)

Add metrics to the container. If the metric already exists (same ID) it will be replaced by the given one.

Parameters:

metrics - Collection of metrics

removeMetric

@OpenApi
public void removeMetric(Metric metric)

Remove the metric from the container.

Parameters:

metric - Metric

removeMetric

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

Remove the metric with the given id from the metrics container.

Parameters:

id - Metric 's id

getMetricsSuite

@OpenApi
public MetricsSuite getMetricsSuite(java.lang.String name)

Return the metrics suites for the given name.

Parameters:

name - Metrics suites' name

Returns:

MetricsSuite

contains

@OpenApi
public boolean contains(java.lang.String metricsSuiteID)

Check if exists a metrics suite with the given ID

Parameters:

metricsSuiteID - MetricsSuite 's id

Returns:

boolean