Group ASA Low Level Design Report - Bilkent University

Department of Computer Engineering
Bilkent University
Senior Design Project
Project short-name: EGOguide
Low-Level Design Report
Project Group Member: SERCAN VARLI 20503287
AHMET YUKSEKER 20701206
ANIL YASAR 20602664
MUHAMMET EROL 20702668
DATE : 18/02/2012
Supervisor: OZCAN OZTURK
Jury Members: IBRAHIM KORPEOGLU and BEDIR TEKINERDOGAN
1

Table of Contents
1. Introduction ................................................................................................................................. 3
Object Design Trade-offs ................................................................................................................ 3
Space vs. Time: ............................................................................................................................ 3
Existing Components vs. New Components: .............................................................................. 4
Object-Oriented Database Design vs. Performance and Interoperability: ................................. 4
Development Time vs. Performance: ......................................................................................... 4
Interface Documentation Guidelines .............................................................................................. 4
Engineering Standards .................................................................................................................... 5
Definitions, acronyms, and abbreviations ...................................................................................... 5
References ...................................................................................................................................... 5
2. Packages ...................................................................................................................................... 6
Overview ......................................................................................................................................... 6
Package Decomposition .................................................................................................................. 7
GUI Package ................................................................................................................................ 7
Application Package .................................................................................................................... 7
Database Package ....................................................................................................................... 8
3. Class Interfaces ........................................................................................................................... 9
4. Glossary ..................................................................................................................................... 14
2

1. Introduction
This project aims effectively to use the developing technology. The project name is
“EGOguide”. “EGOguide” is a simple android phone application for Ankara city of Turkey. This is
designed to find how a person go to somewhere where he want to go by using public
transportation for Ankara city of Turkey. In other words, the system helps to find a route for the
target address and gives you information which is number of buses or subway, addresses of bus
stations or subway stations and also it can give you your current location and approximate
distance of between departure and arrival points. Besides, the system can inform you about
time of buses and subway. In addition to this, it can help you to find a simplest or alternative
route to go from departure point to arrival point on foot. When this system can observe your
location, it can warn you in the location where you close to arrival. Generally, this is a magic
city transportation guide system. If you don’t know addresses of bus and subway stations, time
of them, ID’s of them and general addresses of the city, the application is the most important
helper for you.
The previous report described the high level design of the project. In this report we are
going to describe low level design of the project. In part 1, we will describe the object design
trade offs, interface documentation guidelines and definitions, acronyms, and abbreviations. In
part 2, we will introduce our packages and their figures. In part 3, we will describe the class
interfaces in detail in terms of interface documentation guidelines. Finally, in the 4th part, the
references will be stated.
Object Design Trade-offs
Space vs. Time:
When user tries to find the shortest path between current location and destination point
or between any given two place, the system has to be online to use Google Maps to make
calculations which means much response time compared to offline systems. However our system
requires less disk space.
3

Existing Components vs. New Components:
Our system will be using some existing components such as Google Map’s own
components to simplify implementation of the project. By using existing components instead of
building new ones, we plan to create more reliable system with less effort, time and space.
Another existing component that we will be using is open database connectivity(ODBC) to
connect to system database.
Object-Oriented Database Design vs. Performance and Interoperability:
We will use object oriented design (Java) to implement our system since our project will be
used in Android mobile phones. Although the implementation part will be easy to develop, easier,
faster and the system will be more reliable since we use OOP, the performance of the system will
decrease. In addition, object orientation causes interoperability problems.
Development Time vs. Performance:
In order to gain best performance from the whole system, we may exceed the time which
is required to implement the system. Estimated development time can be considered as a main
constraint but we need to spare an extra time for testing processes in order to make an efficent
and accurate result.
Interface Documentation Guidelines
We use the following documentation style to present the classes:
Description: Brief explanation of the class/interface.
Parameter Name: The name of parameter
Parameter Type: The type of parameter
Function Name: The name of function.
Return Type: The return type of function.
Function Description: Brief explanation of the function.
Exception Name: The name of the possible exception that may be thrown.
Exception Reason: The possible reason of the exception.
Package Name: The name of the package that class belongs to.
4

Class Name: Name of the class or interface
Engineering Standards
First of all, in the project we have planned to follow IEEE standarts to model our UML
components. At the beginning of this stage, we specified the project’s requirements and
constraints to formulate the system’s UML class hierarchy. Then we removed potential risks by
carefully analyzing the system. At the end of this step, the system’s prototype is ready to
implement which will be followed with testing. In other words, the program’s validation is
satisfied. If the validation is unsuccessful, we repeat some previous steps as in waterfall software
development model.
Definitions, acronyms, and abbreviations
ACRONYM / ABBREVIATIONS
EXPANSION
EGOguide
Default Route
ODBC
Sqlite
Google Maps
Bus and route tracking system
The most used routes by users
Open database connectivity
Android database system
Api of the google maps for developers on android system
References
1- http://ug.bcc.bilkent.edu.tr/~i_yasar/C491HighLevelDesignReportGroupASA.pdf
2- https://developers.google.com/maps/
3- http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html
4- http://www.princeton.edu/~achaney/tmve/wiki100k/docs/Waterfall_model.html
5

2. Packages
This section presents the packages of our application, EGOGuide. When this part is compared
to subsystem decomposition, there is no obvious difference because our application contains only
one package for all layers. This section is more meaningful for the projects that have more than
one package for each layer.
Overview
Our application has three packages which are Presentation Package, Application Package
and Database Package. Subsystem decomposition of our project is shown below.
GUI is the top level of our packages and it provides interaction views between user and
application. Main function of this package is to take necessary information from the user and
6

showing the desires of users like path, common places and map. Application package is the most
important package of our application. It performs main job. The application package is allowed to
use database package and it brings necessary information from database and sends to GUI.
Database package keeps the information that users want. In addition to it, if user wants to add a
favorite to his application, that information is saved here.
Package Decomposition
GUI Package
GUI Package provides interaction between application package and GUI package. It detects
users’ desires to send application. GUI package contains two subsystems called Activities and
GestureDedector.
Activities: Our project is an Android application. In Android every screen that user will interact is a
class called Activity. Activities subsystem will provide all necessary screens for users.
GestureDedector: This application will be used in smart phones and input will not be given by a
mouse or keyboard, input will be given by touch-operated screen and Gesture Dedector
subsystem will realize the users’ touches.
Application Package
Manager: Manager will take the users’ demands from GUI package send desired data to GUI.
7

Manager class will make some calculations like time and distance. This subsystem will need
current location and station information. Manager will take current location from GPS subsystem
and others from database.
UpdateController: UpdateController will update GPS and Database to provide fresh information
to Manager permanently. Therefore Manager can take current location from GPS correctly and
users can see their movement on the map.
GPS: GPS will provide freshness of information that Manager will use. It will be updated by
UpdateController.
Database Package
DatabaseAdapter: This will connect Application and Database Package.
Database: This component will keep all information that will be used probably and new
information created by user will be saved here.
8

3. Class Interfaces
CLASS :
Description
Package
Attributes
Operations
Manager
This class manages the whole system and main operations
Manager
vehicle : Vehicle
dbManager: Database
vList: VehicleList
setNotification(notType) : void
create and set the notification
update():boolean
update the datas
getGPS(gpsType): GPS
get the current gps data
setStartLocation(loc):boolean
set the start location
getStartLocation(): String
get the start location
setFinishLocation():boolean
set finish location
setVehicleList():boolean
set vehicle lists
addVehicleList():boolean
add a vehichle to vehicle list
getVehicleList():VehicleList
get the wanted vehicle list of route
setVehicle():boolean
set the vehicle
setVehicleDetail():boolean
take detais of the vehicles
findRoute(): ArrayList
find the route by using user instructions
setRoute(): boolean
set the route by user pereferences
setVehicleID(): boolean
get and set vehicle id to choose details of the vehicle
calculateEfficiency(): int
calculate efficiency of the routes
getTemplateLocation(): arrayList
get template location by using ArrayList fuction
updateDatabase(): boolean
update the database information
9

CLASS :
Description
Package
Attributes
Operations
Vehicle
Create and get details of vehicles
Manager
ID : int
routes : ArrayList
setID(ID) :boolean
set id by using database info
getID(): int
get the id by using databes info
setRoutes():boolean
set the routes of the bus by using database info
getRoutes(): ArrayList
get routes of the list
setStartTimes():boolean
set start time of the bus
getStartTimes():
get start time of the bus
CLASS :
Description
Package
Attributes
Operations
Efficiency
Calculate efficiency of the routes
Manager
calculateTime() : int
calculate time of the route
calculateRoute() : int
calculate route distance
setBestRoute() : String
set the best Route
CLASS :
Description
Package
Attributes
Operations
VehicleList
Get and take lists of vehicles
Manager
ID : Vehicle
addVehicle() : boolean
add new vehicle
getVehicleList() : ArrayList
get Vehicle list by ArrayList
setVehicleList(): boolean
set the Vehicle List
getNextVehicle(): Vehicle
get the next vehicle of choosen route
10

CLASS :
Description
Package
Attributes
Operations
CLASS :
Description
Package
Attributes
Operations
Notification
Create and control the notifications of the system
Manager
notType : int
setNotification() : boolean
set the notification
setNotificationType() : boolean
set the notification type
getNotification() : String
get the notification
GPS
Determine and control the coordinates of the users and buses
Manager
x : int
y : int
determineCoordinates() : boolean
determine coordinates of wanted location
getCoordinate() : int
get the current coordinates of wanted location
setCoordinate(): boolean
set the current coordinates of the wanted location
update(): boolean
update the wanted location
CLASS :
Description
Package
Attributes
Operations
Updating
This class aims to update the database data and current GPS data
Manager
updateDatabase() : boolean
update the database information
updateGps() : boolean
update the GPS location
CLASS :
Description
Package
Attributes
Operations
Template
Get and set the templates of the most used routes
Manager
getTemplateList() : ArrayList
get the template list of the routes
addToList() : boolean
add to list as template route
11

CLASS :
Description
Package
Attributes
Operations
Activity
This class aims to manage GUI and user pereferences of andriod system
EGOActivity
m : Manager
onCreate() : void
create the page
onPause() : void
click pause
onResume() : void
click resume
onTouchEvent() : void
determines the touched event on the screen
setContentEvent() : void
determines the user pereferences
CLASS :
Description
Package
Attributes
Operations
RouteFinding
This class aims to create and get the operations and route finding page
design.
EgoActivity
Activity a
onCreate() : void
create the page
onPause() : void
click pause
onResume() : void
click resume
onTouchEvent() : void
determines the touched event on the screen
setContentEvent() : void
determines the user pereferences
12

CLASS :
Description
Package
Attributes
Operations
CLASS :
Description
Package
Attributes
Operations
RouteTemplate
This class aims to create and get the operations and RouteTemplate page
design.
EgoActivity
Activity a
onCreate() : void
create the page
onPause() : void
click pause
onResume() : void
click resume
onTouchEvent() : void
determines the touched event on the screen
setContentEvent() : void
determines the user pereferences
DetailShowing
This class aims to create and get the operations and DetailShowing page
design.
EgoActivity
Activity a
onCreate() : void
create the page
onPause() : void
click pause
onResume() : void
click resume
onTouchEvent() : void
determines the touched event on the screen
setContentEvent() : void
determines the user pereferences
CLASS :
Description
Package
Attributes
Operations
RouteShowing
This class aims to create and get the operations and RouteShowing page
design.
EgoActivity
Activity a
onCreate() : void
create the page
onPause() : void
click pause
onResume() : void
click resume
onTouchEvent() : void
determines the touched event on the screen
setContentEvent() : void
determines the user pereferences
13

CLASS :
Description
Package
Attributes
Operations
CLASS :
Description
Package
Attributes
Operations
RouteChecking
This class aims to create and get the operations and RouteChecking page
design.
EgoActivity
Activity a
onCreate() : void
create the page
onPause() : void
click pause
onResume() : void
click resume
onTouchEvent() : void
determines the touched event on the screen
setContentEvent() : void
determines the user pereferences
Notification
This class aims to create and get the operations and Notification page
design.
EgoActivity
Activity a
onCreate() : void
create the page
onPause() : void
click pause
onResume() : void
click resume
onTouchEvent() : void
determines the touched event on the screen
setContentEvent() : void
determines the user pereferences
4. Glossary
Default Route: Default routes are options which were created before by us. They
were created for end user to choose some frequently used routes such as airport to
terminal. It can be useful for the end user for typing, searching and address mapping.
Current location: Current location can be considered as a real time location of user.
This information is provided by GPS to make whole program’s working principle
easier.
14

GPS: Global Positioning System is a satellite navigation system that provides an
information about current location and current time.
JDK7: Java Se Development Kit 7. It is a very useful development environment for
creating applications.
Android: It is Linux based operating system for touchscreen mobile devices which
was created by Goggle.
15