Go to Metrics Guide

 JMeasure

User Guide: (v0.5_beta1)

Enter java jmeasure.JMeasure

1. Load the Program. Type java jmeasure.JMeasure at the command prompt, or create an icon or shortcut to do the same. The application will open up in a new window.
2. Display the Configure Dialog Box. Click on the Configure button or the Analysis|Configure menu item. The Configure Dialog is shown below:



The JMeasure Configure Dialog with default settings

 

3. Select the desired metrics. Select the appropriate checkboxes, or select the complete set by clicking on the All Metrics checkbox. To restrict the hierarchy metrics (DIT & NOA) to the current package select the Restrict Ancestry checkbox.
4. Select the package to be analyzed. A Java package can be represented as either a directory or an archive (*.zip or *.jar) file. The user does not need to know how it is represented or what its location is, the only condition is that it is visible on the CLASSPATH - as it must be to be used at all. Enter the fully qualified package name in the text box or select it from the drop-down list. (The list is initially empty but will update when a new package name is entered and the <Enter> key is pressed; its contents are saved to the file config.mj in the current directory when the application is closed). To analyze classes in the default package, (i.e. classes in the current directory that do not have a 'package' statement) enter just a dot (.) in the package text box. Note: you must start the application in the required directory in order to analyze the default package.
5. Select the source directory, i.e. the directory where the relevant source code files are kept. Enter the full path name in the text box, or select it from the drop-down list (the list initially contains the current working directory and the directories specified by user.home and java.home, it updates when a new path is chosen). Alternatively, click on the Search... button to activate the Directory Dialog box. If the source files are in more than one directory, select the highest level directory and then select the Include Sub-Directories checkbox.



The Directory Dialog box. A single-click on a directory name will change to that directory, or on ".." will go up to the parent directory. A new path can be typed into the top text box. The list is scrollable as necessary.

 

6. Confirm your selections. Click the OK button. The Configure Dialog will close.
7. Start the Analysis process. Click on the Start button or the Analysis|Start menu item. A Progress Dialog will show whilst the analysis is taking place. Large packages may take some time, the Progress Dialog will keep you informed.

The results can be sorted by metric or class name by clicking the appropriate metric name button at the top of the Results Window (not visible unless a set of results is displayed). Sorting alternates between ascending and descending. A progress bar will be displayed in the fourth panel of the status bar when large lists are being sorted. (note: the sorting itself is fast, it is the re-formatting and re-displaying in the List box that may take time.)

Select the required class's name in the results list and click on the Details button or the File|View Class Details menu item. Detailed information is available for each class relating to each of the areas of analysis.

Select the required class's name in the results list and click on the Source button or the File|View Source menu item. In the case of inner classes it is the source file of the enclosing class that is displayed. Information on file size in bytes and lines is displayed in the status bar of the source viewer, together with a commented line count and a Density of Comments measurement. Note: The source code locations are not saved in the *.mj files, in order that these files are not system- or user-dependent, therefore the source code cannot be viewed for classes in Result Sets that have been opened from a *.mj file.

The name used for the saved file is the full package name plus the extension *.mj (or *.mjx for plain text files).

i) Save in JMeasure format: Click on the Save button or the File|Save menu item. Result sets thus saved can be re-opened with the File|Open option.

ii) Save as plain text: Click on the File|Save As Text� menu item. The Results and all the Class Details will be saved to a single text file with the extension *.mjx. The file can be viewed in any text editor.

Note that the source code of re-opened files is not available from the View Source option.

• Refer to the Metrics Guide for a description of each OO Design Metric
• Refer to the Result Guide for information on what is implied by the results.

contact Tobias Mayer for further information.