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:cultivate:tutorial_generic_features [2014/04/07 17:17]
127.0.0.1 external edit
research:cultivate:tutorial_generic_features [2018/05/09 01:59] (current)
Line 1: Line 1:
 +{{page>​tutorial_index&​fullpage&​nofooter}}
 +----
 +====== Generic Features ======
 +
 +
 +Cultivate is all about supporting the developer producing good structured software by providing the opportunity to constantly reflect on the written code. The following generic features help to make the cultivate experience even more intuitive, using the marker every user of eclipse is used to or providing an easy way to query arbitrary prolog queries and getting the results in an exportable sorted table.
 +
 +===== Marker =====
 +
 +You can configure Cultivate to show smells as markers next to your code in the editor.
 +
 +|{{:​research:​cultivate:​enabling_a_smell_warning.png?​800|}}|
 +^  Enabling a smell warning ​ ^
 +
 +The smell warning is shown in the same way as any other compiler warning in the problems view or in the editor:
 +
 +|{{:​research:​cultivate:​smell_warning.png?​800|}}|
 +^  Example of a smell warning ​ ^
 +
 +===== Query View =====
 +The Query View allows the developer to query Prolog predicates directly. The results are displayed as a table which can be exported for further reference in various formats.
 +
 +|{{:​research:​cultivate:​queryview.png|}}|
 +^   Query View   ^
 +
 +=== Usage ===
 +The user simply needs to type the Prolog Query into the corresponding editable field on top of the view, then to press ENTER. The result will be displayed as a table, where each variable in the query is assigned to a column. The columns are ordered alphabetically but can be manually reordered.
 +
 +You may use the variable ''​Target''​ to specify the element a double click should lead to. You may use the variable ''​Selection''​ to filter your query with respect to the selected package, class or interface. For variables starting with an underscore no column will be shown.
 +
 +
 +=== Exporting Query Results ===
 +There can be found three buttons in the toolbar, each allowing the user to export specific query results into one of three formats, namely
 +  * .CSV, separated by semicolon,
 +  * .CSV, separated by tabulator,
 +  * .TXT, conform to DokuWiki table syntax.
 +
 +|{{:​research:​cultivate:​generictable_toolbar_screenshot.png|}}|
 +^  The toolbar of the Generic Table View   ^
 +
 +  - Exports the current query results.
 +  - Exports the descriptions of all currently available smell detectors.
 +  - Exports the descriptions of all currently available metrics.
 +
  
research/cultivate/tutorial_generic_features.txt · Last modified: 2018/05/09 01:59 (external edit)

SEWiki, © 2019