Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • W Wiki Home
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Create a new issue
  • Jobs
  • Issue Boards
Collapse sidebar
  • SDK4ED WikiSDK4ED Wiki
  • Wiki Home
  • Wiki
  • technical debt toolbox usage

technical debt toolbox usage · Changes

Page history
Technical-Debt Usage authored May 27, 2020 by Angeliki Tsintzira's avatar Angeliki Tsintzira
Hide whitespace changes
Inline Side-by-side
technical-debt-toolbox-usage.md
View page @ b6353a3d
......@@ -497,4 +497,122 @@ The response includes the cumulative interest of the project for each version. F
## Design-Level Refactorings Service
**End Points - URLS**
{GET} http://195.251.210.147:7070/extractMethodOpportunities/search?projectID=
{GET} http://195.251.210.147:7070/moveClassRefactorings/search?projectID=&isNew=
| Parameter | Description | Required | Type |Notes |
|:------------:|:---------------------------------------------------------------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| projectID | The name of the project. The name should be the same as the name that given through the analysis phase. | Yes | String |
| isNew | This parameter takes 2 values, 0 and 1. 0 represents the initial code design and 1 refers to the proposed code design. | yes for the second URL | Boolean |
**Extract Method Opportunities**
Returns extract method opportunities, the name of the method, the start line to start the extraction and the end line.
**Sample Request**
In this example, we want to retrieve the extract method opportunities for the project with ID ‘Neurasmus’. Same output for java and c projects.
{GET} http://195.251.210.147:7070/extractMethodOpportunities/search?projectID=Neurasmus
Headers: -
Authorization: -
**Response**
An array with all the opportunities.
```
{
   "opportunities":[
      {
         “name":"imdcode.c:main(void))
Line Start: 200<br> Line End: 270",
         "colorValue":1990,
         "value":77
      },
      {
         "name":"sisc.cpp:sisc()<br> 
Line Start: 112<br> Line End: 208",
         "colorValue":4658,
         "value":126
      }
]
}
```
**Move Class Refactorings**
Returns a tree structure that presents the packages and the files inside them based on coupling and cohesion.
**Sample Request**
In this example, we want to retrieve the extract method opportunities for the project with ID ‘Neurasmus’ and isNew ‘1’, which means, the proposed code design architecture. Same output for java and c projects.
{GET} http://195.251.210.147:7070/moveClassRefactorings/search?projectID=Neurasmus&isNew=1
Headers: -
Authorization: -
**Response**
A tree structure with the proposed or initial code design architecture.
```
{
   "moveClassRefactorings":{
      "name":"root",
      "toggled":true,
      "children":[
         {
            "name":"1",
            "children":[
               {
                  "name":"Neurasmus8.imd-emulator.misty1"
               },
               {
                  "name":"Neurasmus8.imd-emulator.sec_primitives"
               },
               {
                  "name":"Neurasmus8.imd-emulator.reader"
               },
               {
                  "name":"Neurasmus8.imd-emulator.resources.imdcode"
               },
               {
                  "name":"Neurasmus8.imd-emulator.resources.imdcode_v1.3.misty1"
               },
               {
                  "name":"Neurasmus8.imd-emulator.resources.imdcode_v1.3.imdcode"
               }
            ]
         },
         {
            "name":"2",
            "children":[
               {
                  "name":"Neurasmus8.imd-emulator.sims"
               },
               {
                  "name":"Neurasmus8.imd-emulator.api"
               },
               {
                  "name":"Neurasmus8.imd-emulator.sisc"
               },
               {
                  "name":"Neurasmus8.imd-emulator.body"
               },
               {
                  "name":"Neurasmus8.imd-emulator.main"
               }
            ]
         }
      ]
   }
}
```
\ No newline at end of file
Clone repository
  • Advanced
  • Architectural Toolbox Description
  • Architectural Toolbox Front End
  • Architectural Toolbox Home
  • Architectural Toolbox Installation
  • Architectural Toolbox Usage
  • Decision Support Toolbox Description
  • Decision Support Toolbox Front end
  • Decision Support Toolbox Installation
  • Decision Support Toolbox Usage
  • Decision Support Toolbox
  • Energy Toolbox Description
  • Energy Toolbox Front end
  • Energy Toolbox Installation
  • Energy Toolbox Usage
View All Pages