Online Manual

Analysis Report View

Analysis Report is the main and the most powerful all-in-one way of representation of analysis outcome. It is designed to display everything that SourceGlider knows about some particular Java Element. The view contains the set of dataflow queries, grouped by sections. You can find the list of all available queries in the Reference.

Intuitive UI provides the easiest way to navigate from the view directly to the source code, launch other views for concrete elements, show and hide groups of queries, mark the results of the queries in the code, etc. Powered by comprehensive precomputed analysis, this view goes far ahead of standard Eclipse code browsing views, such as Type Hierarchy, Call Hierarchy, Outline, Javadoc and others. It displays the dataflow information that is never shown in Eclipse. For example, in one report you can watch the call graph of some particular method, its usages, dependencies, thrown exceptions, threads, monitors, actual result values, their types and many other useful information. You can even control the analysis process from this view.

Analysis Report View basically appears at the right of Eclipse workbench, but you can drag it to any place you want. To get the Analysis Report information on some Java Element, you need to select that Java Element and to display the view by either of the following ways:

• Press Ctrl+` on the keyboard (` is the button on the keyboard above the Tab button). If there's no active analysis, the Quick Analysis will be computed on the current Compilation Unit (which contains the current Java Element, if there is any).
• Select Source Analysis > Show Analysis Report in the Eclipse menu. If there's no active analysis, the Quick Analysis will be computed on the current Compilation Unit (which contains the current Java Element, if there is any).
• Select Source Analysis > Show Analysis Report in the context menu of the selected Java Element. If there's no active analysis, the Quick Analysis will be computed on the current Compilation Unit (which contains the current Java Element, if there is any).
• Select Window > Show View > Other... and choose Analysis Report from the Source Analysis group. In this case no analysis will be computed if there's no active analysis.

In addition, if the corresponding option is switched on (it is switched on by default), Analysis Report View will be automatically displayed when user selects the Java Element for the first time after the analysis is computed.

Once the Analysis Report View is open, it will change its content each time you select the new Java Element. You may disable this feature by the button at the toolbar of the view.

Analysis Report View has the toolbar with the following buttons:

• button will open the Analysis Query Tree for the current Java Element
• button will open the Metrics View.
• button will freeze the Report View: it will not change its content each time you select the new Java Element, but it will still change the content when you follow the hyperlinks of the Java Elements or press Ctrl+`.
• and buttons will guide you through the history of selected Java Elements. The more comprehensive view of this history is displayed in the Analysis Query Tree.

Analysis Report View has several view contexts, which one is displayed depends on the current state of analysis:

This context is displayed when there's no active analysis

This context is displayed when there is an active analysis but no Java Element is selected

This context is displayed when the analysis is out-of-date

This context is displayed when the current Java Element is located in the Compilation Unit that is outside of the current Working Set

This context is displayed when SourceGlider was unable to pick the selected Java Element

This is an essential context that displays the report on the selected Java Element

The features that are marked with numbers are described in detail below:

1: If you mark some part of code in the Java editor, it may refer to the number of Java Elements. For example if you mark the name of constructor MessageDialog in the context of new instance creation:

you will get three Java Elements binded to that part of code:

Type MessageDialog

Method MessageDialog.MessageDialog(...) (constructor for type MessageDialog)

Invocation site new MessageDialog(...)

To select the different Java Element for the single piece of code, select the tab with the corresponding Java Elements Type icon.

2: The upper part of Analysis Report displays the type and the source value for the selected Java Element.

3: The report page consists of the number of Sections. You can expand and collapse each section individually in order to see the rest part of the Analysis Report View.

4: Each section contains the number of Queries. Each query denotes some particular piece of dataflow information for the current Java Element. The query has the caption (black text) and the list of Java Elements (purple text) that represent the answer for that query. If the answer is empty the string empty list appears. You can find the list of all available queries in the Reference.

5: If the list of answers is too large, only few of them are displayed. To get the others, use the scrollers at the right.

6: Most of Java Elements in the Report have hyperlinks. If you follow that link for some particular Java Element, it will become the current Java Element and the whole Analysis Report View will change to display the dataflow information for it. Also this Java Element will be revealed in the source.

7: Click on the button at the right of some Java Element to reveal it in the source. When you press this button, the Compilation Unit that declares that Java Element opens up and the part of code that corresponds to the Java Element is marked.

8: Pull down the small blue line at the bottom of the section to expand it or pull it up to retract it back. This is very useful when you want to see more Java Elements for some particular section.

9: Click on the down arrow below the blue line to expand the section completely. Click on the up arrow to return it to the initial size.

10: Resize the Report View to fit the more information on the screen. If you increase the height, more Java Elements will fit into the Analysis Report View. If you increase the width, the wider source code strings will represent the Java Elements.

11: Click on the button to reveal all the answers for some query in the Eclipse Search View. It is very useful if the number of answers for the query is quite big and you want to see which files contain the answers:

When you hover the mouse over the link in some Java Element, the tooltip window will show the part of source code that contains this Java Element: