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

Number Provider Qualified Name Metric Type Description
1 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider UNIQUE_ID Integer This is an unique identifier for each element as specified in org.fortiss.tooling.kernel.model.IIdLabeled.
2 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider NUMBER_OF_CONNECTORS Integer Number of connectors in the respective element.
3 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider NUMBER_OF_CONTAINED_ELEMENTS Integer Number of entries in the containedElements list.
4 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider 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.
5 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider NUMBER_OF_TOTAL_CONNECTORS Integer Total number of connectors in this element and all contained elements.
6 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider NUMBER_OF_TOTAL_ENTRY_CONNECTORS Integer Sum of all connectors which implement org.fortiss.tooling.base.model.base.EntryConnectorBase.
7 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider 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.
8 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider NUMBER_OF_TOTAL_ELEMENTS Integer Total number of elements contained in this element. Includes the element for which this metric is recorded.
9 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider 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.
10 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider 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.
11 HierarchicElementProvider org.fortiss.tooling.ext.quality.HierarchicElementProvider NUMBER_OF_TOTAL_LEAF_ELEMENTS Integer Total number of elements contained in this element which do not contain elements. Includes self.
12 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.
13 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.
14 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.
15 ComponentMetricProvider TODO (SB): Documentation of providers should be distributed to respective plugins. org.fortiss.af3.component.quality.ComponentMetricProvider NUMBER_OF_TOTAL_CODE_CONSTANTS Integer Total number of constants in code specifications in this element and all contained elements.
16 ComponentMetricProvider org.fortiss.af3.component.quality.ComponentMetricProvider NUMBER_OF_TOTAL_CODE_CYCLOMATIC_COMPLEXITY Integer The total cyclomatic complexity of all code specifications in this element and all contained elements.
17 ComponentMetricProvider org.fortiss.af3.component.quality.ComponentMetricProvider NUMBER_OF_TOTAL_CODE_LINES Integer Total number of lines of code in all code specifications in this element and all contained elements.
18 ComponentMetricProvider org.fortiss.af3.component.quality.ComponentMetricProvider NUMBER_OF_TOTAL_CODE_COMMENTS Integer Total number of comment blocks in all code specifications in this element and all contained elements.
19 DataDictonaryProvider org.fortiss.af3.component.quality.DataDictonaryProvider - - Provides Metrics also collected by the HierarchicElementProvider, but for the DataDictionary.
20 SafetyMetricProvider org.fortiss.af3.safety.quality.SafetyMetricProvider SAFETY_LEVEL String String representation of the assigned safety level of this element.
21 SafetyMetricProvider org.fortiss.af3.safety.quality.SafetyMetricProvider SAFETY_LEVEL String String representation of the assigned safety level of this element.
22 SafetyMetricProvider org.fortiss.af3.safety.quality.SafetyMetricProvider SAFETY_LEVEL String String representation of the assigned safety level of this element.
23 AllocationTableProvider org.fortiss.af3.task.quality.AllocationTableProvider TASK_ALLOCATED_COMPONENTS Integer Number of allocated Components on this Task. This metric can only be non-null for org.fortiss.af3.task.model.Task Elements.
24 AllocationTableProvider org.fortiss.af3.task.quality.AllocationTableProvider HARDWARE_ALLOCATED_TASKS Integer Number of allocated Tasks on this ExecutionUnit. This metric can only be non-null for org.fortiss.af3.platform.model.ExecutionUnit Elements.
25 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.
26 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.
27 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: