After extracting the zip file to the desired location, double click on the cyvis.jar file to run the application. This will launch the application. If your machine does not support double clicking on jar files, you can run the cyvis.bat in the bin folder.
Creating and Saving a Project
Click on the File->New Project to create a new Project. This brings a screen as shown here. Then follow the steps given below to create a project
Once the metrics has been extracted you are presented with a screen as shown here. The screen is divided into two basic components.
What do the charts mean or what can you infer by looking at them? This section answers this question. The chart panel visualises the metrics.The charting is done in three levels
Colouring and Metrics:
The colouring of the methods in each of the views is done according to their Cyclomatic Complexity. By default any method with a Cyclomatic Complexity less that or equal to three is coloured green, anything beyond that and less than seven is coloured yellow and everything else is red. Interfaces are coloured grey, and empty interfaces are white. You can change these defaults (colours and cyclomatic complexity ranges) in the preferences dialog.
The table is just below the chart panel. It displays the metrics for that particular view.
The toolbar looks like this. Please refer to the picture to find what the numbers actually mean.
To change the Cyclomatic Complexity, Chart Colouring and the directory where report should generated in click Metrics->Preferences in the menubar. Doing so shows this dialog. The dialog shows the defaults. The report directory by default is the directory where the project is saved (the *.cys file) which can be changed if you choose to. The Metrics section allows you to change the range of cyclomatic complexity and the color that represents them. Clicking on the colours launches a colour palette. Remember to save any changes you have made, so that they get applied. Restore Defaults restores the default for you.
When you click File->Edit Project, CyVis can take different actions based on whether a project is currently open or not. If a project is already open, CyVis displays the edit dialog with all the information of the current project. You can add/remove files, change the workspace or even the project name. Once you have finished editing save the project like you generally do.
On the other hand if a project is not currently open, CyVis pops up an open dialog. Select the project file(*.cys) which you want to modify. Once you have selected your project, CyVis opens the edit menu.
Two types of reports are possible, HTML and TXT formats. The reports can be generated by either clicking Metrics->Generate HTML Report or Metrics->Generate TXT Report.
You may also choose to do an XML Dump by clicking on Metric->Generate XML Dump.
The report and the dump files are automatically generated at the report directory. The report directory is the same as the project directory unless changed via preferences dialog.
|© 2005-2006 Pradeep Selvaraj, Vinay Iyer.|