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:jtransformer:tutorial_old:viewing_results [2014/04/03 18:29]
Günter Kniesel
research:jtransformer:tutorial_old:viewing_results [2018/05/09 01:59] (current)
Line 1: Line 1:
 +====== Viewing and Acting on Results ======
  
 +
 +Every predicate loaded into the current factbase can be run at any time interactively,​ in the [[stepbystep#​your_first_jtransformer_query|Prolog Console]]. However, this is recommended only for development / debugging purposes since typing queries is tedious and the possibly long textual results are hard to understand for most users.
 +
 +For predicates that had been [[jt_analysis|declared as analyses]], JTransformer offers much nicer ways to 
 +  * view their results -> [[#result view]] and [[#​markers]]
 +  * assess the correctness of the results -> [[#result assessment]]
 +  * improve the code if the result indicates a problem -> [[#code improvement]]
 +
 +===== Result View =====
 +
 +  * The result view displays all found results, grouped by detector. ​
 +  * The icon associated to a particular result indicates its kind (error, warning or information). If an assessment is available only the assesment status icon (accepted or rejected) is shown -> [[#​evaluation quick fixes]].
 +  * Double-klicking on any line in the Result view opens an editor that displays the associated code -> [[#​markers]]
 +
 +|{{result_view.png|Result View. Click to enlarge.}}|
 +| Result view displaying info and warning results. |
 +
 +===== Markers =====
 +
 +The editor marks each result with an icon and colored underline, which indicate the kind of result: ​
 +  * Error ({{:​research:​jtransformer:​tutorial_old:​quickfix_error_obj.gif|Error marker icon}}, red underline)
 +  * Warning ({{:​research:​jtransformer:​tutorial_old:​quickfix_warning_obj.gif|Info marker icon}}, yellow underline)
 +  * Info ({{:​research:​jtransformer:​tutorial_old:​info_tsk.gif|Info marker icon}}, blue underline)
 +
 +|{{marker.png|A warning marker.}}|
 +| A warning marker |
 +
 +
 +
 +===== Quick Fixes =====
 +
 +  * Each [[#​markers|marker]] has an associated quick fix that pops up when the mouse stays over the underlined code
 +
 +|{{quick_fix_categories.png|Four categories of quick fixes: Code Improvement (blue box), Result Assessment (red box), Supress (orange box), Deactivate (gray box) }}|
 +|Quick fix categories: -> [[#code improvement|Code Improvement]] (blue box), -> [[#result assessment|Result Assessment]] (red box), -> [[#supress| Supress]] (orange box), -> [[#​deactivate|Deactivate]] (gray box)  |
 +
 +=== Code Improvement ===
 +  * A Code Improvement Quick Fix lets you fix the problem indicated by the result.
 +  * It can be //local// (fix only the indicated problem) or //global// (fix all similar problems in the entire project)
 +  * It can be performed //​immediately//​ or by going first through a //preview// that shows all occurrences of the problem and all changes that would be performed by the quick fix.
 +
 +=== Result Assessment ===
 +
 +  * A Result Assessment Quick Fixe lets you assess the result'​s correctness. You can
 +    * accept (a correct result)
 +    * reject (a wrong result)
 +  * These actions add annotations to the marked element so that you can easily share your assessment with your team.
 +
 +|{{:​research:​jtransformer:​tutorial_old:​jt_annotations_accept-reject_in_code.png|}}|
 +|  Annotations added by '​Accept'​ quick fix. The developer extended it by signing his initials ('-- GK') to let others know whose opinion is expressed here. |
 +
 +  * The inserted annotations are also used by JTransformer in the Result View, to indicate the assessment status of each result
 +
 +|{{:​research:​jtransformer:​tutorial_old:​jt_annotation_status_overview.png|}}|
 +| The result view shows the assesment status of results (based on the annotations). |
 +
 +=== Supress ===
 +If the result is correct but you have good reasons to ignore it, you can suppress the related marker. ​
 +Then the result will also be ignored in the Result View. 
 +
 +=== Deactivate ===
 +This is the same as deactivating the analysis in the [[control_center|Control Center]]. There you can reactivate it again. ​
research/jtransformer/tutorial_old/viewing_results.txt · Last modified: 2018/05/09 01:59 (external edit)

SEWiki, © 2019