com.nomagic.magicdraw.metrics

Class MetricsSuite

java.lang.Object

com.nomagic.magicdraw.metrics.MetricsSuite

All Implemented Interfaces:

java.lang.Cloneable

@OpenApi
public class MetricsSuite
extends java.lang.Object
implements java.lang.Cloneable

MetricSuite class.

Constructor Summary

Constructors

Constructor and Description
MetricsSuite() Default Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addMetric(Metric metric) Add a metric to the metrics container.
java.lang.String	getDescription()
java.lang.String	getId() Return id
Metric	getMetricByID(java.lang.String id) Return the metric with the given Id
java.lang.String	getName() Getter for MetricsSuite's name.
java.util.Collection	getSelectedMetrics() Return the list of selected metrics
boolean	isSelected(Metric metric) Check if the metric is selected for this metric suite
void	removeMetric(Metric metric) Remove the metric
void	removeMetric(java.lang.String id) Remove the metric with the given ID
void	selectAllMetrics() Select all metrics.
void	selectMetric(Metric metric) Select the given metric.
void	selectMetric(java.lang.String id) Select the metric with the given ID
void	setDescription(java.lang.String description)
void	setName(java.lang.String name) Setter for MetricsSuite's name
void	unselectAllMetrics() Unselect all metrics.
void	unselectMetric(Metric metric) Unselect the given metric.
void	unselectMetric(java.lang.String id) Unselect the metric with the given ID
void	update(MetricsSuite sourceMetricsSuite, boolean updateName) Update metrics suite data.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsSuite

@OpenApi
public MetricsSuite()

Default Constructor

Method Detail

isSelected

@OpenApi
public boolean isSelected(Metric metric)

Check if the metric is selected for this metric suite

Parameters:

metric - The given metric.

Returns:

boolean

selectMetric

@OpenApi
public void selectMetric(Metric metric)

Select the given metric.

Parameters:

metric - The given Metric

unselectMetric

@OpenApi
public void unselectMetric(Metric metric)

Unselect the given metric.

Parameters:

metric - The given metric

selectMetric

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

Select the metric with the given ID

Parameters:

id - The metric 's id.

unselectMetric

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

Unselect the metric with the given ID

Parameters:

id - The metric 's id.

addMetric

@OpenApi
public void addMetric(Metric metric)

Add a metric to the metrics container.

Parameters:

metric - Metric

removeMetric

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

Remove the metric with the given ID

Parameters:

id - The metric 's id.

removeMetric

@OpenApi
public void removeMetric(Metric metric)

Remove the metric

Parameters:

metric - The given metric.

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()

Getter for MetricsSuite's name.

Returns:

Returns the name or "Unnamed" if there is no name.

setName

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

Setter for MetricsSuite's name

Parameters:

name - The name to set.

update

@OpenApi
public void update(MetricsSuite sourceMetricsSuite,
                  boolean updateName)

Update metrics suite data. Update everything but ID.

Parameters:

sourceMetricsSuite -

updateName - indicate if name should be updated

getMetricByID

@OpenApi
public Metric getMetricByID(java.lang.String id)

Return the metric with the given Id

Parameters:

id - The metric 's id.

Returns:

Metric

selectAllMetrics

@OpenApi
public void selectAllMetrics()

Select all metrics.

unselectAllMetrics

@OpenApi
public void unselectAllMetrics()

Unselect all metrics.

getSelectedMetrics

@OpenApi
public java.util.Collection getSelectedMetrics()

Return the list of selected metrics

Returns:

Collection metric

getId

@OpenApi
public java.lang.String getId()

Return id

Returns:

MetricsSuite 's id.