SE design principles for this project

Introduction

Although this is a somewhat smaller project I’ve decided to follow some simpler design principles to make modifying, extending and understanding this software as easy as possible. The preprocessing part is mostly implemented in Java so the design guidelines apply to code written in Java.

Separation of Concerns

To make the data processing logic separated from data parsing implementations. I have mainly categorized my code into 3 types of classes:

• Model
  • bgt.Model.Boundaries
  • bgt.Model.Accident
  • bgt.Model.Grid
  • bgt.Model.GridElement
  • bgt.Model.Record
  • bgt.Model.Node.java
  • bgt.Model.Routes
  • bgt.Model.Segment
  • bgt.Model.Way
• Processer/Algorithm - deals only with implemented models. Does not do any parsing.
  • MapMatcher.java
    • RouteSegmentor.java
    • LinearInterpolation.java
    • LabelData.java
  • AppendSpeedPanel.java
  • SpeedPanelToProjectFormater.java
• Parser
  • OSMparser.java
  • SpeedPanelObsParser.java
  • ParseMapMatchResults.java

Model - TODO

I loosely follow the UML standard 2.0 when designing models (and later on Sequence Diagrams) Loosely, because although this project is a giant from my perspective, I rather need UML for helping to describe the overall System so its a secondary, but still helpful, tool. I use IBM rational for modeling which is provided to me by Hong Kong University.

To follow separation of concerns principle as much as possible Ive decided to use the Spring framework.

Testing

To avoid wasting time in later phases of training due to some random errors in the first phases I create simple automated tests. I use Junit. for that. In addition to that in the Test folder I also keep something called ManualTest.java. I use these for printing out examples of Data parsing test to visually identify that everything is in order where it is possible.

Deployment

I use a build tool to make the project eaily added to other systems. For Java source code build and dependency management I use Gradle and Maven