Developer Documentation for Quality Functionality (org.fortiss.tooling.ext.quality)

Metrics List

Below is a list of all collected metrics. They are represented by the enum org.fortiss.tooling.ext.quality.data.MetricKey

They are categorized by the respective provider collecting the metric

Provider Qualified Name Metric Type Description
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider UNIQUE_ID Integer This is an unique identifier for each element as specified in org.fortiss.tooling.kernel.model.IIdLabeled.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_CONNECTORS Integer Number of connectors in the respective element.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_CONTAINED_ELEMENTS Integer Number of entries in the containedElements list.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_CONNECTIONS Integer Number of connections in this element. List of aggregated connection model elements. Usually aggregates all connections of its direct sub-structure.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_TOTAL_CONNECTORS Integer Total number of connectors in this element and all contained elements.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_TOTAL_ENTRY_CONNECTORS Integer Sum of all connectors which implement org.fortiss.tooling.base.model.base.EntryConnectorBase.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_TOTAL_EXIT_CONNECTORS Integer Sum of all connectors which implement org.fortiss.tooling.base.model.base.ExitConnectorBase. Usually, the sum over this and NUMBER_OF_TOTAL_ENTRY_CONNECTORS should equal NUMBER_OF_TOTAL_CONNECTORS.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_TOTAL_ELEMENTS Integer Total number of elements contained in this element. Includes the element for which this metric is recorded.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_TOTAL_COMMENTABLE_ELEMENTS Integer Total number of elements implementing org.fortiss.tooling.kernel.model.INamedCommentedElement in this element. Includes the element for which this metric is recorded. Never exceeds NUMBER_OF_TOTAL_ELEMENTS.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_TOTAL_COMMENTED_ELEMENTS Integer Total number of elements which are commentable and do not have null or an empty string as a comment.
HierarchicElementMetricProvider org.fortiss.tooling.ext.quality.HierarchicElementMetricProvider NUMBER_OF_TOTAL_LEAF_ELEMENTS Integer Total number of elements contained in this element which do not contain elements. Includes self.
GraphMetricsProvider org.fortiss.tooling.ext.quality.GraphMetricsProvider BETWEENESS_CENTRALITY Double Value of the betweenness centrality of this element embedded in a graph of consisting of all elements which are contained in the element which contains this element, as well as all neighbors of these elements.
GraphMetricsProvider org.fortiss.tooling.ext.quality.GraphMetricsProvider BETWEENESS_CENTRALITY_RECURSIVELY Double Same as above, but all connections are resolved to leaf elements, i.e. elements which do not contain other elements.
GraphMetricsProvider org.fortiss.tooling.ext.quality.GraphMetricsProvider CLUSTERING_COEFFICIENT Double Clustering coefficient of this element. Ignores connection direction and resolves all neighbors to leaf elements.
ModelQualityService org.fortiss.tooling.ext.quality.service.ModelQualityService NESTING_LEVEL Integer The depth of this element. Defined by the number of elements which have to be traversed to reach this element from the root.
ModelQualityService org.fortiss.tooling.ext.quality.service.ModelQualityService CONSTRAINT_VIOLATIONS_ERROR Integer Number of constraint violations of the severity error which have this element as source.
ModelQualityService org.fortiss.tooling.ext.quality.service.ModelQualityService CONSTRAINT_VIOLATIONS_WARNING Integer Number of constraint violations of the severity warning which have this element as source.

The included packages are: