Design Description

foreheadsobstinacySoftware and s/w Development

Aug 15, 2012 (4 years and 10 months ago)

278 views




















Schematizing maps

Design Description


Version
1.0


Doc. No.:





Schematizing maps


Version:
1.0

Design Description


Date: 2010
-
10
-
0
8





Page
2



Revision History


Date

Version

Description

Author

2010
-
10
-
0
8

0.0
5

Initial Draft

Dominik Pavlović














Schematizing maps


Version:
1.0

Design Description


Date: 2010
-
10
-
0
8





Page
3



Table of Contents
1.

Introduction

................................
................................
................................
................................
........................

4

1.1 Purpose of this document

................................
................................
................................
........................

4

1.2 Intended Audience

................................
................................
................................
................................
..

4

1.3 Scope

................................
................................
................................
................................
.......................

4

1.4 Definitions and acronyms

................................
................................
................................
.......................

4

1.4.1 Definitions

................................
................................
................................
................................
....

4

1.4.2 Acronyms and abbreviations

................................
................................
................................
........

4

1.5 References

................................
................................
................................
................................
...............

4

2. External interfaces

................................
................................
................................
................................
..............

5

3. Software architecture

................................
................................
................................
................................
..........

5

3.1 Conceptu
al design

................................
................................
................................
................................
...

5

3.2 System specification

................................
................................
................................
...............................

5

3.3 Error handling

................................
................................
................................
................................
.........

5

4. Approvals

................................
................................
................................
................................
...........................

5

Schematizing maps


Version:
1.0

Design Description


Date: 2010
-
10
-
0
8





Page
4



1.

Introduction


1.1

Purpose of this document


The purpose of this document is to describe the design of the Schematizing maps project.


1.2

Intended Audience

The Audience that is going to

use this document includes:



customer



project supervisor



team leader



team members.


1.3

Scope


The focus of this document lays on the design of the project, along with the conceptual model of the
software architecture.

1.4

Definitions and acronyms


1.4.1

Definitions


K
eyword

Definitions

Schematizing map

Project name

and also team name.









1.4.2

Acronyms and abbreviations


Acronym or

abbreviation

Definitions

IDE

Integrated development environment

API

Application programming interface

GUI

Graphical user interface

MVC

Model
-

View
-

Controller












1.5

References







Schematizing maps


Version:
1.0

Design Description


Date: 2010
-
10
-
0
8





Page
5



2.

External interfaces



Our application will be the standalone application, so the interfaces between users and the application
will consist mostly of the windows with toolbars for drawing the s
chematizing map, importing different maps as
a templates upon which the schematizing map will be drawn and importing and exporting the schematizing map.

The main frame of the GUI is where the user will mark the stations and draw the lines that connect thos
e
stations. In order to provide the user with the easier way of drawing stations and lines he will have the ability to
import a real map as a template upon which the schematic map can be drawn, and also the ability to zoom in or
out, to get the better view

of the template map, or of the sketch that he drew.


3.

Software architecture


The software architecture of the Schematizing maps application will be the modified MVC (Model
-
View
-
Controller) architecture. The view includes the GUI of the application. The mod
el is the applications logic
layer and will present the schematizing maps algorithm along with the two sets of entities: stations and lines.
The controller is the link between the model and the view. When the user inputs the stations or lines or clicks
the

generate button the controller reacts and delegates the necessary data to the model. Also, when model
p
er
forms some task and prepares some data for presentation on the GUI, the controller delegates that data from
model to view.




3.1

Conceptual design


The
view is where the user will input his data, mark the stations and draw a sketch of a schematizing
map, and after the algorithm reformats the map, this is where the result will be displayed for the user, so he can
validate the result, and make some addition
al changes if needed. The controller will take the data that user
inputs and delegate it to the model. When the user hits the generate button the algorithm will invoke, form the
schematizing map from the data that user inputs, and return the result. Then t
he controller takes the result and
delegates it to the view for displaying. There is no need for the database, the final product (fully finished
schematizing map) of the application can be saved to disk, much easier then into the database.


Schematizing maps


Version:
1.0

Design Description


Date: 2010
-
10
-
0
8





Page
6



3.2

System specifi
cation


The system specification can be divided into the software specification and hardware specification. For
the software specification we will build a standalone application by using the NetBeans IDE, based on a Java
Swing API.
The core of our applicat
ion is the schematizing maps algorithm which task is
automatic generation
of the schematic map.

Considering hardware specification,
all what user needs is a computer and two hands.
Even one would do…


3.3

Error handling


Error

Action

Placing the station
at

th
e
same
area

where another
station is

User is not allowed to do this. A
error
message with the brief
problem description is displayed.

I/O errors on importing
template map or
exporting schema map

User is notified
by an error
message, importing / exporting
is
aborted

and user is returned to the state from before he tried to
import / export.

Algorithm errors.

If the algorithm fails to generate the map, user will be notified
and prompted for retry.




4.

Detailed
software design




5.

Approvals



Name

Title

Date

yyyy
-
mm
-
dd

Signature