REFERENCE:
There are two dialogs that perform Quality Assurance (QA) functions on your project:
Both are launched from the Quality Assurance command of the diagram speedmenu (duplicated on the main Object menu when diagram is selected).
Note: Metrics and Audit are only available if the Quality Assurance module is activated.
Select panel
This panel displays the list of available metrics and a set of options that can differ for different metrics.
List of available metrics contains the fields:
Title: full name of the metric
Abbreviation: shorthand name that appears in the metrics result report.
Chosen: check to include the metric in the analysis
The options pane allows to define the settings of the analysis. Options listed below are common to actually all the metrics.
Lower limit and Upper limit: enter maximum and minimum number of occurrences to be included into the analysis.
Aggregation: select the type of aggregation from the drop-down list (sum, average, maximum etc.)
Granularity: defines the depth of analysis (project, package, class etc.)
Properties panel
Provides a brief description of a metric highlighted in the list.
Buttons
Select all and Unselect all: global quick-select/deselect buttons
Set defaults: press to select the default set of metrics.
Save set As: press to save your customized list of metrics.
Load set: press to invoke the file chooser dialog and select the desired metrics file (*.mts).
Start: runs the metrics report
Cancel: abandons all changes and quits the dialog.
Help: invokes this page.
Displays the results of the analysis run on the selected metrics in a treeview:
Item: name of the analyzed object.
Metrics fields: the number of metrics fields varies according to the metrics selected for analysis. One column is displayed per each selected metric. Information can be sorted in ascending or descending order by each column of the report.
Right click on a Metrics field cell of the result report invokes a speedmenu.
Open: allows to open the selected element in the Diagram and Editor panes.
Select All: highlights all items in the report
Copy: copies the selected rows to the clipboard.
Refresh: syncronizes the report with updates to the source code.
Show Description: displays a window with the description of the selected metric.
Export: saves the whole report or selected rows in a text file.
Bar Graph: displays graphic representation of the selected metric.
Kiviat Graph: displays distribution of metrics for the selected item.
Select panel
Provides a list of available audit checks with the following fields:
Title: full name of the audit check.
Abbreviation: shorthand name that appears in the result report.
Chosen: check to include the audit check in the analysis
Severity: select severity level from the drop-down list.
Properties panel
Provides a brief description of each audit check highlighted in the list.
Buttons
Select all and Unselect all: global quick-select/deselect buttons
Set defaults: press to select the default set of audit checks.
Save set As: press to save your customized list of audit checks.
Load set: press to invoke the file chooser dialog and select the desired audit file (*.adt). There are two predefined configuration sets: default.adt and SunCodeConventionForJava.adt, which contain settings for code conventions check.
Start: runs the audit report
Cancel: abandons all changes and quits the dialog.
Help: invokes this page.
Displays the results of analysis run on the selected audit checks in the following fields:
Severity: indicates the severity of found errors. Critical displays in red.
Abbreviation: Shorthand for the check name.
Explanation: Describes why the check flagged the item.
Element: of the diagram where the problem is encountered.
Item flagged by the audit check.
File that contains the problem code.
Line number in this file.
Right click on a line of the audit report invokes speedmenu:
Open: allows to open selected element in the Diagram and Editor panes.
Select All: highlights all items in the report
Copy: copies the selected rows to the clipboard.
Refresh: syncronizes the report with updates to the source code.
Show Description: displays a window with the description of the selected metric.
Export: saves the whole report or selected rows in a text file.
Dispose of: allows to exclude certain rows from the audit report.
Group by: allows to group the report by rows of the selected column.
Sort Ascending: sorts the report rows in the asending order of the selected column
Sort Descending: sorts the report rows in the dessending order of the selected column
Note:QA plugins reside in $TGH$/modules/com/togethersoft/modules/qa. You can find detailed API for the QA plugins in $TGH$/modules/com/togethersoft/modules/qa/doc.
