Customizing metrics generation

General parameterization

Figure 20 - The "Metrics generation" parameter set

The … parameter	represents …
Documenting notes	the name of the notes used to find out which items are documented. Example: "description;summary"
Precondition stereotypes	the name of the stereotypes used to find out which operations have pre-conditions. Example: "C++PreCondition;JavaPreCondition
Postcondition stereotypes	the name of the stereotypes used to find out which operations have post-conditions. Example: "C++PostCondition;JavaPostCondition
Help directory	The location of the on-line help for Objecteering Metrics. This directory is used during generation. In the results, metrics and hypertext links to the on-line help are generated. Example: "D:\Program Files\Objecteering\help\25"
Messages file	the mapping file for messages generated. This parameter is used to parameterize messages generated in the final result, according to your requirements (for further details, please refer to the "Parameterizing generated messages" section in the current chapter of this user guide). Example: "metrics.us"
Generation path	the generation path where files containing metrics will be generated. Example: "C:\projects\metrics"

Parameterizing HTML options

Figure 21 - The "HTML options" parameter set

The … parameter	represents …
HTML editor	the complete name of the HTML editor used to visualize the files containing the metrics for packages and classes. Example: "C:\Program Files\Internet Explorer\IEXPLORE.EXE"
HTML style sheet (« .css »)	the HTML style sheet associated with the generated document.
Index generation	whether or not to generate an index in the HTML document. If the user chooses to generate the index, a hypertext link called "Index" will appear at the top of the page. Clicking on this link displays the index, organized alphabetically and according to element type.
Model generation	whether or not to generate a model explorer in the HTML document. If the user chooses to generate the model explorer, a hypertext link called "Model" will appear at the top of the page. Clicking on this link displays the model explorer.

Note: If both the "Index generation" and "Model generation" options are active, you can only display either the index or the model explorer at any one time. To switch, simply click on the hypertext link corresponding to the other item (Figure 22).

Figure 22 - The "Index" and the "Model" hypertext links

Parameterizing specific metrics

The upper and lower limits of parameterizable metrics are used to define non-standard items which will be displayed in the package, and to underline the value of these metrics where they exceed the limits set.

The metrics which can be parameterized are as follows:

· Class Responsibility (CR)

· Class Category Relational Cohesion (CCRC)

· Coupling Between Object classes (CBO)

· Depth of Inheritance Tree (DIT)

· Distance from the Main Sequence (DMS)

· Number Of Attributes (NOA)

· Number Of Children (NOC)

· Number Of Methods (NOM)

· Number of Methods Added (NMA)

· Number of Methods Inherited (NMI)

· Number of Methods Overridden (NMO)

· Number Of Parents (NOP)

· Specialization Index (SIX)