First steps - short introduction

In this section we present a short description of the system for users who just want to test the Monitor but don't want to learn all of its features now. We have found that short examples are the best way to understand the behavior of the system. We have chosen a couple of scenarios with the data already available in the system and we will present these scenarios step-by-step in the latter part of this section.

The web-based application itself can be accessed from the following internet address:

http://www.frontendart.com/

When we access the internet address of the monitor, the Java Virtual Machine loads the application. If you have trouble loading this page, please refer to the System Requirements in Section 2 and to the FAQ in Section 4. When the system starts, we can see a screen divided into two major parts with a vertical bar and several menu items on the top left side of the screen (we can see the screen after the startup in Figure 1).

 

Figure 1: The screen at the startup of the system

The first thing we can see on the left side of the screen is the Full view tab. It contains the different elements of the analyzed source (namespaces, classes, functions, etc.). We can open each element recursively to get its children items. Also if we perform any searches, we will get the results in the Search result tab on the left side. The Component view tab contains the list of different components which were analysed, and it can be browsed just like the Full view tab. The File view tab serves a similar role as the Component view, for the files that form the system.

On the right side of the screen we can see an empty panel labeled Diagram1. This will be the place of the charts and queries we will make during the use of the Monitor. Beneath this large panel we can find a smaller one. This will hold the properties of the different items that we put on our charts.

The menu items in the top left part of the screen have a similar function as any menu system you have used before, the only difference is that in this case we do not have the usual items in the menu (File, Edit, etc.), but we have items that are specific for the Monitor.

In the rest of the section we will go through a few scenarios. This should give you enough information to start using the Monitor. Still, if you are interested in a more detailed description of the system, please refer to the latter parts of this User's Guide starting in the next section.

First let us make a simple chart by using one of the built-in scenarios of the Monitor. To do this simply, select the Shortcuts menu item and choose the Biggest classes scenario. If we do it right a new chart appears in the right part of the screen. This way we have performed a very simple query, that gives us the biggest classes in the system (we can see the screen after performing this scenario in Figure 2). As this is the first time we can see a chart let's say a few words about them. We can make different charts: barcharts, timelines and histograms. The Biggest classes scenario made a barchart for us. The vertical axis of the chart holds the values that we want to present, and on the horizontal axis we have bars with the hight and color corresponding to the matching program elements value. Beneath the chart we can see the properties of the program elements that are present on the chart (lines of code - LOC - in this example).

 

Figure 2: The screen when we have visualized some charts

After this short introduction let us see how to build a similar scenario. We would like to select the top 20 program elements according to their lines of code (LOC) and we would like to present them divided by their logical lines of code value (lLOC). To do this, first we have to make a search for the top 20 items for LOC. From the Search menu we should select the Search by metric value - Global search menu item. This way a new window opens, where we can set the parameters of our search. In the top left part of the window we select 'Top' from the combo box labeled Search criteria and set the value to 20. In the top right part of the window we can find the Metrics box. We should open the category named Size and should select the 'LOC' metric. Beneath this box we can find three options about the use of metric values. We select the Relative to size (divided by lLOC) option. If we have set up all of the parameters we can press 'Search' to perform the search.

The results of the search will appear on left side of the screen in the Search result tab. Most probably we have the names of some namespaces and classes as the results of the search, but it doesn't matter now. Now we would like to put these program elements on a barchart. We should select one of the lines among the results, press Ctrl+A (to select all of them), open the Charts menu and select the Barchart - New... item. A new window opens, which is similar to the search window seen before. Again we select the 'LOC' metric from the Size group in the Metrics box and we check the Relative to size (divided by lLOC) option. Now we can press the 'OK' button to make the chart (also we can press Preview to check to results first). If we have done everything right, we have a colorful barchart in the middle of the screen (we can see the screen with the new barchart in Figure 3).

 

Figure 3: The screen when we have done the instructions in the example

In the following section of the User's Guide a detailed description of the Monitor will be given.