Using Analyst4j - How to do

1. Analyze

• 1.1 Selective Analysis
• 1.2 View last analysis report

2. Accessing Views & Perspectives

3. Search using Metrics

• 3.1 Create new query
• 3.2 Edit saved query / remove condition.
• 3.3 View search results
• 3.4 Save query/ Copy results to clipboard/ Add matches to "Task List"
• 3.5 Delete saved query
  

4. Quality Analysis Perspective

• 4.1 Open QA Perspective
• 4.2 Visualize an analysis
• 4.3 Customize Categories [ Distribution Analysis ]
• 4.4 List and locate matching cases of an analysis
• 4.5 Generate report / Copy matching cases to Clipboard / Add matches to "Task View".
  

5. Custom Analysis based on search queries

• 5.1 Create new analysis
• 5.2 Edit Analysis
• 5.3 Visualize metrics distribution in custom analysis
  

6.[** New] Quality Analysis - Version Comparison
7.[** New] Search View

• 7.1 Multi Project Search
• 7.2 Problem Marker Visualization

Analyze 

Analyst4j has an independent powerful static code analysis engine for Java, it is designed to work on any fragments of Java source files. Create a Java Project in Eclipse JDT environment, import your sources and start analyzing. Works even if there are missing dependencies.

It is necessary to analyze your sources to use the features of Analyst4j. To analyze

1.) Bring up the context menu of "Package Explorer View" by right clicking on the <Project> node and choose "Analyst4j->Analyze".

2.) Selective analysis: You can choose to analyze selected files/packages. While analyzing all sources is advisable you may need this feature when you want to eliminate unwanted packages/files such as "unit testing" packages. When you decide your selection, click "Finish" to initiate the analysis.

3.) Upon completion, an overall statistics report is displayed along with time taken and other info. The information would accessible using the menu option "Analyze->View Last Analysis Report".

4.) Now Analyst4j would be ready to answer your queries. 

Analys4j Perspectives & Views

To open a "QA Perspective" or any of Analyst4j view use the "Analyst4j" Menu in Eclipse Main Menu.

Search using metrics

1.) To perform a search using software metrics, Choose "Analys4j - Search" or Eclipse "Search" tool bar button to bring up the search dialog.

 2.) Create new query

   Choose "--New Search--" in the combo box labeled "New / Load Search".

   Choose the "Project To Search"

   Choose the level of items to search [ Method or Class or File or Package]

   In the "Custom Search" table,

   Click on the first row and first column, to avail a drop down of possible measurement of the level chosen.

   Form your query and press "Search" when done.

   Analyst4j runs your query against the analyzed data and find the items that matches your query.

3.) Edit  query / remove a condition in the query

   Load the save query by choosing the query in "New / Load Search" combo box.

   The system loads your query in the "Custom Search" table.

   Modify the query as you see fit. 

   To remove a row (condition), click on the first column of the row(Metrics column) and press "Delete" key.

    Click "Search" when you are done, to see the matching resources in the search results page.

4.) Save query / Copy results to clipboard / Add matches to "Tasks View".

5.) Delete saved query

To remove saved search queries use the "Remove Search" dialog accessible via the menu option "Analyst4j -> Remove Search".

The dialog displays a list of saved search queries and their respective in "Custom Analysis" which uses the query. Removing a query which is used in a "Custom Analysis" is not allowed.

Quality Analysis Perspective

1.) Open QA Perspective

Analyst4j Quality Analysis Perspective

 2.) Visualize an Analysis.

In "Quality Analysis View" of QA Perspective, expand the treeview and choose the analysis (Double Click) to visualize the graph for the analysis. Optionally "Right Click" on the analysis node, brings up a popup menu to choose from the type of chart(usually Line,Scatter,Bar or Pie charts). 

 3.) Customize Categories

Click open "Edit Categories" in the visualization view, modify the category name, range values and click "Update" when done. The graph is refreshed immediately to reflect your changes and the changes are permanently stored.

 4.) List and locate matching cases of an analysis

Make sure "QA Cases View" is visible and click on "Graph" to list the cases matching the category / graph element.

5.) Generate report / Copy matching cases to Clipboard / Add matches to "Task View".

"Quality Analysis View" Pop Menu

"Visualization View" Coolbar options

"QA Cases View" Toolbar options

Custom Analysis based on search queries

1.) Create new analysis

In the "Quality Analysis View", "Right Click" on "Custom Analysis" node to bring a popup menu "Define Chart/ Custom Analysis".

2.) Edit / Define custom analysis

3.) Visualize Custom Analysis Distribution

" Right Click" on a custom analysis definition, to bring up a popup menu, choose "Distribution -> <Metrics>"

6. Quality Analysis - Version Comparison

• 1.Create two or more project in Eclipse JDT and Import different version of the same system, Analyze all projects one by one.
• 
• 2.Switch to "Quality Analysis - Perspective" and select a Project in the "QA Scope View".
• 
• 3.The above action lists available analysis in the "QA Analysis View". Right Click on any Analysis -> Choose "Across Analyzed Projects" in the context menu.
• 
• 4. Select the versions for which you want to plot a comparison graph.
• 
• Click "Ok" to generate the graph.
• 

7. Search View

Search view lists the saved search queries ,open the "Search View" from Eclipse Main Menu "Analyst4j -> Search View".

7.1 Multi Project Search

1. Open "Search View". Right Click on a "Saved Search Definition Node", Choose "Across Analyzed Projects" in the context Menu.

2. Select one or more projects.

3.) Click "Ok" to visualize the results as graph.

7.2 Visualize Problem Markers for Search Results 

Show / Hide the problem markers for the search results, using the toolbar button in the graph.

Problem markers visualization : Sample