City Bike DSL is, as the name suggests, a DSL within the domain of city bikes, which is built with the Eclipse technology Sirius. The project was developed as part of the course TDT4250 Advanced Software Design at the Norwegian University of Science and Technology.
The data of the project is based on the open data API from Trondheim Bysykkel. From their API fetch information about the stations (name, availability, capacity, address..) and historical data about all the trips that have med ridden during a month. The API returns data in JSON format.
Presenting the whole dataset of trips in the is too big to visualize. We have chosen to shrink the numbers of trips down 500 trips. The dataset does not contain any information about the bikes, or which bike that rode which trip. To make the application more interesting we added information about bikes, service information and mechanics. See the Model for more information.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
These are technologies needed to follow this installation guide and get the software up and running:
This project utilizes a set of specific plug-ins. The easiest way to install these is to start Eclipse with the package named "Eclipse Java and DSL developers". When the IDE is opened, plug-ins can be installed through "Help" > "Install New Software...". Between each of the following - click Next and then Finished.
-
From the standard software site (select Eclipse 2020-06 in drop-down) and with Group Items by Category checked:
- Acceleo
- Ecore Diagram Editor (SDK)
- EMF Forms SDK
- Sirius Specifier Environment
- Sirius Properties Views
-
From the standard software site (select Eclipse 2020-06 in drop-down) and with Group Items by Category un-checked:
- Acceleo Query SDK
-
From the software site http://hallvard.github.io/plantuml (type into text field):
- PlantUML Eclipse support > PlantUML Ecore Feature and PlantUML Feature
- PlantUML Library > PlantUML Library Feature
-
From the software site http://download.eclipse.org/tools/orbit/downloads/drops/R20170919201930/repository:
- All Bundles > Jackson-annotations
- All Bundles > Jackson-core
- All Bundles > Jackson-databind
Restart Eclipse when all the plug-ins have been installed.
Follow the instructions below to get a demo of the project running locally.
- Open the Eclipse Wizard by hitting "File" > "Import...".
- Select Git > Projects from Git (with smart import) and press
Next. - Select Clone URL and press
Next. - In the URL field paste the following link and press
Next: https://github.com/olahop/city-bike-dsl.git - To complete the import with the default configurations, press
Nextin the occurring pages, and thenFinish. - To run the DSL: right-click the
tdt4250.cb.modelpackage and run this as an Eclipse Application. This will open an Eclipse runtime environment. - In the runtime environment, open the Eclipse Wizard by hitting "File" > "Open Project from File System...".
- Click
Directory...to find and open the project ("city-bike-dsl") from your file system. - Import all the nested projects and hit
Finish. - Within the runtime environmentns Project Explorer, navigate down to city-bike-dsl > tdt4250.cb.model > tdt4250.cb.design.sample > representations.aird, and click to extend the .aird-file.
- Step 10 will trigger a panel to open suggesting startup representations. Check all and hit
OK.
This will make the representations of the project appear in the runtime environment. Look down in the Views section for more information about the representations and the functionality within the them. The repository comes with a sample xmi-instance for the representations. To update this, run the file ImportDataFromCitybike.java in the Eclipse development environment and wait until the console confirmes that the file has been updated. Then restart the runtime environment, and the representations should contain updated data.
- Eclipse Modelling Framework (EMF) - Used to build a model of the city bike domain as the foundation of the DSL
- Sirius - Used to create custom graphical modeling workbenches
- FontAwesome - Used to find custom icons for diagrams and threes
-
City
- name : EString - the name of the City, e.g. Trondheim
- bikes : Bike - list of bikes in the city
- stations : Station - list of Stations in the city
- mechanics : Mechanic - the meachanics that to service on the bikes in the city
- trips : Trip - list of trips of all the bikes in the city
-
Trip
- id : EInt - unique identifier for the trip
- startStation : Station - where the Bike was picked up
- endStation : Station - where the Bikes was parked
- startTime : Date - the date and time the Bike was picked up
- endTime : Date - the date and time the Bike was parked
- duration : EInt - the duration of the trip in seconds
- bike : Bike - the Bike involved in the Trip
-
Station
- name : EString - the name of the Station
- address : EString - the address of the Station
- xCoordinate : EFloat - the X coordinate
- yCoordinate : EFloat - the Y coordinate
- capacityNum : EInt - how many Bikes can be parked
- availableDocksNum : EInt - how many remaining docks there are for parking
- availableBikes : Bike - list of Bikes that can be picked up
-
Bike
- name : EString - the name of the Bike
- currentStation : Station - the Station the Bike is currently parked at
- lastService : EDate - the last time the Bike was at service
- serviceReports : ServiceReport - the service reports the Bike has received
-
ServiceReport
- content : EString - the description of the service
- bike : Bike - which Bike the service report belongs to
- mechanic : Mechanic - who performed service on the Bike
- timestamp : EDate - the time the service was performed
-
Mechanic
- name : EString - the name of the Mechanic
This section is meant to highlight which features of the Sirius technology has been used to develop the DSL and how these features can be seen and tested within the runtime-environment.
This diagram representation displays Stations, Bikes and edges between Bikes, and the Station they are currently at. It is a very visual representation and the user can right-click to add new Stations or Bikes (or use the NodeCreation tool) and use the EdgeCreation tool to set or change the location of a Bike. Users can also navigate to either bikeTrips or station diagram by clicking on the bike or station nodes. By hovering over a bike node a number appears showing how many trips that bike has done.
Station Diagram consists of the default layer and two custom layers, TripsIn and TripsOut. The default layer contains the domain station. The tripsIn layer contains all station that has a trip that ends in the domain station and tripsOut is all station that has a trip from the domain station. There can be multiple trips between stations. The diagram is only used for visualization and has no functionality.
The bikeTrip diagram show all trips that the bike has done. The goal of the diagram is to get an overview of how bikes have been used and a view of their travel patterns.
This tree representation shows the same information as the BikesAtStation diagram, but is more neatly structured, meaning that a specific station is easier to find. The user can right-click any tree item to add a new Station.
This table representation is an overview of all the Mechanics. New Mechanics can be added through right-clicking, and existing Mechanics can be edited through the properties panel.
This table is to represent the data of the bikes. It includes which stations it is currently parked at, how long it has been ridden, number of trips and the average duration of trips. It is used to quickly get a lot of data from all the bikes. Uses services to fetch data.
This viewpoint consists of a single tree representation - ServiceReportTree. The view consists of a list of the bikes in the current city, sorted by longest time since last service. Note that the lastService-timestamp of the bikes and the threshold distinguishing red and blue bikes are simplified to demonstrate the functionality of the DSL. Within each bike node of the tree, are the service reports related to the bike.
It is possible to create a new service report for a bike by right clicking and selecting "Create Service Report". The new service report, along with other service reports can then be edited with the use of the customized properties panel. The specific features of this panel is mentioned in the CustomProperties section.
Java Services is used to filter and render the bikes of this view correctly. It is also used to set the current timestamp on newly created service reports. The code behind this can be found in /tdt4250.cb.design/src/tdt4250/cb/design/Services.java. Aql is used to give bikes and service reports their labels. The bike labels contain the bikes name, total number of service reports, and the timestamp of the last service report. Service report labels contain the name of the mechanic and the content of the report. Different colored icons indicate if the bike is in need of service or not, based on the time since last service.
This viewpoint consists of a single diagram representation - DiagramView. The purpose of this view is to show an overview of which stations have bikes currently parked there. The view consists of nodes of all the stations in the city, colored based on if there are any bikes parked at the station (blue = bikes are available, red = no bikes available). The label will also tell how many bikes are parked.
The nodes has Conditional Style aql statements that determine the color of the node. The default Shape of the node is blue, but will be changed to red if no bikes are available, and the flavour text: "no bikes available" will be included in the label. Another Condition is used to check if exactly one bike is available, making sure the label doesn't say "1 bikes available".
Initially we had planned to include a map of Trondheim, and use the x and y coordinates of the stations to place the nodes on the exact locations on the map. The plan was to use a Container that would display a map through a Workspace Image, and place the subnodes accordingly using the coordinates. In order to do this we would have to create a custom layout algorithm that would place the nodes on x and y position within the container. This would require us to 1) create the algorithm by subclassing one of the Sirius abstract LayoutProvider classes, and 2) integrate this algorithm into Sirius using an extension from an extension point like org.eclipse.gmf.runtime.diagram.ui.layoutProvider. Due to time constraints, as well as considering the scope of the project, this functionality was not prioritised.
The customized properties view is used to facilitate changing information as part of the DSL.
The ServiceReport panel makes it possible to edit service reports through selecting a mechanic and editing the contents of the report. Aql is used to find the mechanics registered in the same city as the bike, and display these by name through the candidate variable.
The Bike panel gives the user the possibility to alter the "name" of the chosen Bike-object.
- Anders H. Rebner - Sirius Guy - andersrebner
- Henrik Rudi Næss - Sirius Fella - henrikrn-ntnu
- Håvard Farestveit - Sirius Dude - Havfar
- Ola Hermann Opheim - Sirius Bloke - olahop
This project is licensed under the MIT License - see the LICENSE file for details