SDA SE Wiki

Software Engineering for Smart Data Analytics & Smart Data Analytics for Software Engineering

User Tools

Site Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
research:dpd:dpjf:engineers [2012/03/14 17:06]
alex.binun
research:dpd:dpjf:engineers [2018/05/09 01:59] (current)
Line 1: Line 1:
 +====== DPJF: DPD for Software Engineers ======
  
 +===== SET OUTPUT FOLDER=====
 +Choose a factbase as described above. Go to the Prolog console (Eclipse Main Menu->​Prolog->​Prolog Console), open it and enter the query **setOutputFolder(Dir)**. This is in order **Dir** to contain the output of DPJF. ++Example|: For example, **setOutputFolder('​W:/​output'​)** will redirect all output of DPJF into the directory '​W:/​output'​.++ ​
 +
 +{{:​research:​dpd:​dpjf:​dpjfperspective-setout.png?​980|Setting Output Folder. Click to enlarge.}}
 +
 +<note important>​ __Important!__ \\
 +If you do not set the output folder explicitly, the results will be stored in the folder **resultFolder** that resides within the directory of the analyzed project. Just refresh this folder (right-click on the analyzed project and select **Refresh**) and you get the results. ​
 +</​note>​
 +
 +===== RUN=====
 +
 +Choose a factbase as described above. Then
 +  - Go to the JTransformer Control Center. ​
 +  - Locate the desired DP detector that you want to run. ++How to|: In the list of plugin tools supplied with JTransformer (**Useless Code**, etc) you find **Design Pattern Detection (DPJF)**. Below it you find all supported pattern detectors. ++ 
 +  - Right-click on the desired detector and select **Run analysis** from the context menu.
 +    * To run all enabled analyses click the Run button (green triangle pointing to the right) in the Control Center
 +  - Go to the Result View. For each program element playing some role in a detected DP candidate, it will display a line showing the role name, the program element name and the file and line in which this program element resides. Roles are nested according to program element containment (methods in types, calls in methods). ​
 +
 +
 +===== INSPECT ​ =====
 + ​Double-clicking a line in the Result View displays the the corresponding ​
 +program element in an Eclipse editor. ​
 +
 +{{:​research:​dpd:​dpjf:​dpjfperspective-inspect.png?​880|Running DPJF and inspect results. Click to enlarge.}}
 +
 +/* ******************************************************************************
 + TO be enabled and completed when DPJF is integrated with the new JT release that
 +    provides a generic analysis assessment API and end user support:
 +     
 +===== ASSESS =====
 +If you consider that the displayed element is a false positive ​
 +you can tell DPJF about your assessment by ... Also, if you see elements ​
 +that have not been detected but actually play a role in a pattern, you 
 +can let DPJF know (by ...).
 +
 +  FIXME <- include screenshots:​ Quick fix options and their effects on the code 
 +  ******************************************************************************
 +*/
 +  ​
 +===== CLEANUP =====
 +If you do not want to see the markers of a particular DPD run anymore,
 +you can remove them by right-click on the respective analysis in the
 +**Design Pattern Detection (DPJF)** group of the JT Control Center ​
 +and selecting **Remove Analysis Markers**. ​
 +
 +
 +DPJF saves the markers displayed in the Result View before exit. 
 +So they are immediately available at the start of a new session. ​
 +If the project has been changed outside Eclipse, the stored markers ​
 +might be outdated. Then rerun the analysis or cleanup the outdated ​
 +markers as described above. ​
research/dpd/dpjf/engineers.txt · Last modified: 2018/05/09 01:59 (external edit)

SEWiki, © 2020