Celem projektu jest stworzenie modułu do aplikacji internetowej służącej i usprawniającej proces obsługi Ośrodka Szkolenia Kierowców. Wspomniana platforma ma umożliwiać zarządzającym szkołą, instruktorom i kursantom nauki jazdy wygodny dostęp do narzędzi pozwalających i ułatwiających efektywne zarządzanie ośrodkiem szkolenia kierowców oraz kursami, w których uczestniczą klienci
Moduł, który zostanie dodany do aplikacji, będzie umożliwiał zaznaczanie na mapie danego miasta miejsc ciekawych pod względem komunikacyjnym, a więc szczególnie przydatnych w ramach szkolenia początkujących kierowców. Moduł będzie zintegrowany z Google Maps. Instruktorzy i kursanci poprzez kliknięcie w wybranym miejscu mapy będą mogli zaznaczyć interesujące ich miejsce i dodać jego opis.
Aktualnie na rynku istnieje niewiele rozwiązań pozwalających na zarządzanie ośrodkiem szkolenia kierowców. Większość rozwiązań dostępnych na rynku nie jest aplikacjami internetowymi i nie umożliwia interakcji z osobami uczestniczącymi w kursach (OSK Manager i Easy OSK). Ich funkcjonalność jest ograniczona do formalnego zarządzania ośrodkiem. Jedyna dostępna na rynku aplikacja internetowa wspomagająca obsługę ośrodka szkolenia kierowców jest bardziej rozbudowana w stosunku do wspomnianych wyżej aplikacji, jednak jej szata graficzna pozostawia wiele do życzenia i nie jest według nas przystępna. Najważniejszą rzeczą w przypadku naszego projektu jest to, że żadna z dostępnych na polskim rynku aplikacji nie oferuje modułu, który ma powstać w ramach niniejszego projektu. Kursanci i instruktorzy nie mogą dzielić się informacjami o miejscach komunikacyjnych, które powinien poznać kursant podczas trwania szkolenia. Miejsca takie są niezwykle cenne z dydaktycznego punktu widzenia. Pomocne mogą być także lokalizacje, które często odwiedzają osoby egzaminowane. Zapoznanie z takimi miejscami pozwoli na uzyskanie praktyki i zmniejszenie stresu podczas jazdy egzaminacyjnej.
Moduł jest częścią projektu aplikacji do zarządzania ośrodkiem szkolenia kierowców. W aplikacji wyróżniamy kilka rodzajów użytkowników: administratora, instruktora, kursanta, osobę zarządzającą ośrodkiem oraz użytkownika niezalogowanego.
Analiza wymagań odnosić się będzie głównie do tworzonego modułu dodawania nowych miejsc. Nowe miejsca będą mogli dodawać wszyscy zalogowani użytkownicy aplikacji. Jedynym ograniczeniem będzie fakt, że wszystkie miejsca dodane przez kursanta będą podlegać moderacji i będą publikowane dopiero po formalnej akceptacji przez instruktora.
Do podstawowych funkcjonalności projektowanego modułu będą należeć:
Ponadto cała aplikacja internetowa umożliwia w kontekście projektowanego modułu udostępnia:
Gość
Platforma do zarządzania OSK
Rejestracja
Gość chce zarejestrować się w systemie
Użytkownik wybiera na stronie opcję rejestracja
Użytkownikowi udaje się poprawnie zarejestrować i potwierdzić wybrany adres poczty elektronicznej
Użytkownik nie zostanie zarejestrowany, użytkownik nie potwierdzi rejestracji, wyświetlony zostanie odpowiedni komunikat.
Platforma do zarządzania OSK
Logowanie
Użytkownik chce zalogować się do systemu
Użytkownik wybiera na stronie opcję logowanie
Użytkownik musi posiadać konto w systemie
Użytkownikowi udaje się poprawnie zalogować do systemu
Użytkownik nie zostanie zalogowany do system, zostanie powiadomiony o braku zalogowania (niepoprawne dane).
Platforma do zarządzania OSK
Moduł map - dodanie nowego miejsca
Użytkownik chce dodać nowe miejsce na mapie
Użytkownik klika na mapie współrzędne danego miejsca
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje się poprawnie dodać miejsce (w przypadku kursanta miejsce może oczekiwać na akceptację)
Użytkownikowi nie uda się dodać nowego miejsca.
Instruktor
Platforma do zarządzania OSK
Moduł map – edycja miejsca
Użytkownik chce zmienić dane dotyczące zapisanego miejsca
Użytkownik klika na mapie współrzędne danego miejsca (marker)
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje się edycja danych dotyczących miejsca
Użytkownikowi nie uda się zmienić informacji o danym miejscu
Instruktor
Platforma do zarządzania OSK
Moduł map – usuwanie miejsca
Użytkownik chce usunąć zapisane miejsce
Użytkownik klika na mapie współrzędne danego miejsca (marker)
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje usunąć wybrane miejsce
Użytkownikowi nie udaje się usunąć danego miejsca
Platforma do zarządzania OSK
Moduł map – komentarz danego miejsca
Użytkownik chce dodać komentarz, opinię na temat danego miejsca
Użytkownik klika na mapie współrzędne danego miejsca (marker)
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje się dodać komentarz
Użytkownikowi nie udaje się dodać komentarza
Instruktor
Platforma do zarządzania OSK
Moduł map – dodanie kategorii
Użytkownik chce dodać nową kategorię
Użytkownik wybiera odnośnik „dodaj nową kategorię”
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje się dodać kategorię
Użytkownikowi nie udaje się dodać kategorii
Instruktor
Platforma do zarządzania OSK
Moduł map – usuwanie kategorii
Użytkownik chce usunąć kategorię
Użytkownik wybiera odnośnik „usuń kategorię”
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje się usunąć kategorię
Użytkownikowi nie udaje się usunąć kategorii
Platforma do zarządzania OSK
Moduł map – wyszukiwanie miejsc
Użytkownik chce odnaleźć miejsce
Użytkownik wybiera odnośnik „wyszukaj miejsce”
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje się odnaleźć miejsce
Użytkownikowi nie udaje się odnaleźć miejsca
Instruktor
Platforma do zarządzania OSK
Moduł map – moderowanie miejsc
Instruktor chce ocenić i ewentualnie dodać miejsca wprowadzone przez kursantów
Użytkownik wybiera odnośnik „moderuj dodane miejsca”
Użytkownik musi posiadać konto w systemie i być zalogowanym
Użytkownikowi udaje się dokonać moderacji danego miejsca
Użytkownikowi nie udaje się dokonać moderacji danego miejsca
CREATE TABLE address (
id integer NOT NULL,
street VARCHAR(64),
house_number VARCHAR(10) NOT NULL,
flat_number VARCHAR(10),
town VARCHAR(64) NOT NULL,
postal_code VARCHAR(6) NOT NULL,
post_office varchar(64) not null
);
ALTER TABLE address ADD CONSTRAINT address_pk PRIMARY KEY (id);
CREATE TABLE users (
id integer NOT NULL,
username VARCHAR(32) not null,
pass_sha256 char(64) not null,
pass_salt char(64) not null,
code_sha256 char(64),
email varchar(128) not null,
phone varchar(16),
mobile varchar(16),
status integer not null,
first_name VARCHAR(64),
last_name VARCHAR(64),
pesel char(11),
birth_date DATE,
nationality VARCHAR(64),
home_address integer not null,
mailing_address integer,
register_date timestamp,
last_login_date timestamp
);
ALTER TABLE users ADD CONSTRAINT users_pk PRIMARY KEY (id);
ALTER TABLE users ADD CONSTRAINT users_home_address_fk FOREIGN KEY (home_address)
REFERENCES address (id);
ALTER TABLE users ADD CONSTRAINT users_mailing_address_fk FOREIGN KEY (mailing_address)
REFERENCES address (id);
CREATE TABLE "payments_status" (
"id" integer NOT NULL,
"description" varchar(200) NOT NULL
);
ALTER TABLE "payments_status" ADD CONSTRAINT "payments_status_pk" PRIMARY KEY ("id");
CREATE TABLE "students" (
"user_id" integer NOT NULL
);
ALTER TABLE "students" ADD CONSTRAINT "students_pk" PRIMARY KEY ("user_id");
ALTER TABLE "students" ADD CONSTRAINT "students_user_id_fk" FOREIGN KEY ("user_id")
REFERENCES "users" ("id");
CREATE TABLE "payments" (
"id" integer NOT NULL,
"amount" numeric(9,2) NOT NULL,
"date" date NOT NULL,
"student_id" integer NOT NULL,
"accepted_by" integer NOT NULL,
"status" integer NOT NULL,
"due_date" date,
"description" integer
);
ALTER TABLE "payments" ADD CONSTRAINT "payments_pk" PRIMARY KEY ("id");
ALTER TABLE "payments" ADD CONSTRAINT "payments_student_id_fk" FOREIGN KEY ("student_id")
REFERENCES "student" ("user_id");
ALTER TABLE "payments" ADD CONSTRAINT "payments_status_fk" FOREIGN KEY ("status")
REFERENCES "payments_status" ("id");
CREATE TABLE "categories" (
"category_code" varchar(4) NOT NULL,
"category_name" varchar NOT NULL
);
ALTER TABLE "categories" ADD CONSTRAINT "categories_pk" PRIMARY KEY ("category_code");
CREATE TABLE "student_categories" (
"student_id" integer NOT NULL,
"category_code" varchar(4) NOT NULL
);
ALTER TABLE "student_categories" ADD CONSTRAINT "student_categories_pk" PRIMARY KEY ("student_id","category_code");
ALTER TABLE "student_categories" ADD CONSTRAINT "student_categories_student_id_fk" FOREIGN KEY ("student_id")
REFERENCES "students" ("user_id");
ALTER TABLE "student_categories" ADD CONSTRAINT "student_categories_category_code_fk" FOREIGN KEY ("category_code")
REFERENCES "categories" ("category_code");
CREATE TABLE "courses" (
"id" integer NOT NULL,
"start_date" date NOT NULL,
"type" varchar(3) NOT NULL,
"practical_training" integer NOT NULL,
"theoretical_training" integer NOT NULL
);
ALTER TABLE "courses" ADD CONSTRAINT "courses_pk" PRIMARY KEY ("id");
CREATE TABLE "cars" (
"id" integer NOT NULL,
"registration_number" varchar(7) NOT NULL,
"brand" varchar(50) NOT NULL,
"model" varchar(50) NOT NULL,
"colour" varchar(50) NOT NULL,
"year" integer NOT NULL,
"examination_date" date,
"insurance_date" date,
"category" varchar(4),
"disctance" integer
);
ALTER TABLE "cars" ADD CONSTRAINT "cars_pk" PRIMARY KEY ("id");
ALTER TABLE "cars" ADD CONSTRAINT "cars_category_fk" FOREIGN KEY ("category")
REFERENCES "categories" ("category_code");
CREATE TABLE "student_courses" (
"course_id" integer NOT NULL,
"student_id" integer NOT NULL,
"medical_certificate" bool,
"instructor" integer,
"certificate_number" varchar(10),
"end_date" date
);
ALTER TABLE "student_courses" ADD CONSTRAINT "student_courses_pk" PRIMARY KEY ("course_id","student_id");
ALTER TABLE "student_courses" ADD CONSTRAINT "student_courses_course_id_fk" FOREIGN KEY ("course_id")
REFERENCES "courses" ("id");
ALTER TABLE "student_courses" ADD CONSTRAINT "student_courses_student_id_fk" FOREIGN KEY ("student_id")
REFERENCES "students" ("user_id");
ALTER TABLE "student_courses" ADD CONSTRAINT "student_courses_instructor_fk" FOREIGN KEY ("instructor")
REFERENCES "instructors" ("user_id");
CREATE TABLE "internal_exams" (
"id" integer NOT NULL,
"student_id" integer NOT NULL,
"course_id" integer NOT NULL,
"type" char(1) NOT NULL,
"result" bool NOT NULL DEFAULT False,
"date" date NOT NULL,
"instructor" integer NOT NULL,
"errors" varchar(500)
);
ALTER TABLE "internal_exams" ADD CONSTRAINT "internal_exams_pk" PRIMARY KEY("id","student_id","course_id");
ALTER TABLE "internal_exams" ADD CONSTRAINT "internal_exams_student_course_id_fk" FOREIGN KEY ("student_id", "course_id")
REFERENCES "student_courses"("student_id", "course_id");
ALTER TABLE "internal_exams" ADD CONSTRAINT "internal_exams_instructor_fk" FOREIGN KEY ("instructor")
REFERENCES "instructors" ("user_id");
CREATE TABLE "status" (
"id" integer NOT NULL,
"name" varchar(100)
);
ALTER TABLE "status" ADD CONSTRAINT "status_pk" PRIMARY KEY("id");
CREATE TABLE "driving_lessons" (
"id" integer NOT NULL,
"student_id" integer NOT NULL,
"instructor_id" integer NOT NULL,
"start_time" timestamp NOT NULL,
"end_time" timestamp NOT NULL,
"course_id" integer NOT NULL,
"status" integer NOT NULL,
"distance" integer,
"car_id" integer NOT NULL
);
ALTER TABLE "driving_lessons" ADD CONSTRAINT "driving_lessons_pk" PRIMARY KEY("id");
ALTER TABLE "driving_lessons" ADD CONSTRAINT "driving_lessons_student_id_fk" FOREIGN KEY ("student_id")
REFERENCES "students" ("user_id");
ALTER TABLE "driving_lessons" ADD CONSTRAINT "driving_lessons_instructor_id_fk" FOREIGN KEY ("instructor_id")
REFERENCES "instructors" ("user_id");
ALTER TABLE "driving_lessons" ADD CONSTRAINT "driving_lessons_course_id_fk" FOREIGN KEY ("course_id")
REFERENCES "courses" ("id");
ALTER TABLE "driving_lessons" ADD CONSTRAINT "driving_lessons_status_fk" FOREIGN KEY ("status")
REFERENCES "status" ("id");
ALTER TABLE "driving_lessons" ADD CONSTRAINT "driving_lessons_car_id_fk" FOREIGN KEY ("car_id")
REFERENCES "cars" ("id");
CREATE TABLE "theoretical_lessons" (
"id" integer NOT NULL,
"course_id" integer,
"instuctor_id" integer,
"subject" varchar(200),
"date" timestamp NOT NULL,
"hours" integer NOT NULL,
"class" varchar(5)
);
ALTER TABLE "theoretical_lessons" ADD CONSTRAINT "theoretical_lessons_pk" PRIMARY KEY("id");
ALTER TABLE "theoretical_lessons" ADD CONSTRAINT "theoretical_lessons_course_id_fk" FOREIGN KEY ("course_id")
REFERENCES "courses" ("id");
ALTER TABLE "theoretical_lessons" ADD CONSTRAINT "theoretical_lessons_instructor_id_fk" FOREIGN KEY ("instuctor_id")
REFERENCES "instructors" ("user_id");
CREATE TABLE "comments" (
"id" integer NOT NULL,
"place_id" integer,
"comment" varchar(1024) NOT NULL,
"author" integer,
"date" date,
"grade" integer
);
ALTER TABLE comments ADD CONSTRAINT comments_pk PRIMARY KEY (id);
CREATE TABLE "interesting_places" (
"id" integer NOT NULL,
"lattitude" float8 NOT NULL,
"longitude" float8 NOT NULL,
"type_id" integer,
"description" varchar(512),
"accepted" bool NOT NULL,
"city" varchar(32) NOT NULL,
"author" varchar(32) NOT NULL,
"date" date NOT NULL
);
ALTER TABLE interesting_places ADD CONSTRAINT interesting_places_pk PRIMARY KEY (id);
CREATE TABLE "types" (
"id" integer NOT NULL,
"name" varchar(256) NOT NULL,
"description" varchar(1024),
PRIMARY KEY("id")
);
ALTER TABLE "types" ADD CONSTRAINT types_pk PRIMARY KEY (id);
ALTER TABLE "comments" ADD CONSTRAINT "comments_users_fk" FOREIGN KEY ("author") REFERENCES "users"("id")
ALTER TABLE "comments" ADD CONSTRAINT "comments_interesting_places_fk" FOREIGN KEY ("place_id") REFERENCES "interesting_places"("id") on delete cascade
ALTER TABLE "interesting_places" ADD CONSTRAINT "interesting_places_types_fk" FOREIGN KEY ("type_id") REFERENCES "types"("id") on delete cascade
ALTER TABLE "interesting_places" ADD CONSTRAINT "interesting_places_users_fk" FOREIGN KEY ("author") REFERENCES "users"("id") on delete cascade
Pierwsza postać normalna - 1NF
Wszystkie atrybuty spełniają warunek atomiczności, czyli pierwsza postać normalna jest zachowana.
Druga postać normalna - 2NF
Baza jest w pierwszej postaci normalnej i każdy atrybut niekluczowy relacji jest w pełni funkcjonalnie zależny od wszystkich kluczy niezależnych.
Trzecia postać normalna - 3NF
Baza jest w drugiej postaci normalnej oraz brak jest w niej przechodnich zależności funkcjonalnych. Spełnia więc warunki 3NF.
Poniżej przedstawiono przykładowe instrukcje SQL realizujące funkcjonalności systemu.
1. Rejestracja kursanta:
insert into address (id, street_number, street, house_number, city, postcode, phone, mobile, email) values(1, '12b', 'Akacjowa', '39C', 'Kraków', '30-031', null, '503323332', 'mail@gmail.com'); insert into users (id, username, pass_sha256, pass_salt, code_sha256, status, first_name, last_name, pesel, birth_date, nationality, home_address, mailing_address) values(1, 'login', 'fdf9136b1e83481e68f9d94deba79539dd4aee8df5e6d5cb8e38466d24b9d89e', 'LIkQyqduKEkKsTCaZAqIFN4gwQtorxzKyXbi24GaBsLUOr6NgDwSGWFozhpS2aLo', '40d6ab39842f7fa95a7c71a528d0885a7ee9b9534d0bd3c2c380fc098d55b25f', 1, 'imie', 'nazwisko', '82031209214', '1982-03-12', 'polskie', 1, null); insert into students (id) values(1);
2. Dodawanie kategorii:
insert into types(id, name, description) values (1, 'Ronda', 'Ronda, na których kursanci najczęściej popełniają błędy');
2. Dodawanie miejsca (przez kursanta):
insert into interesting_places(id, latitude, longitude, type_id, description, accepted, city, author, date) values (421, 50.05, 19.95, 1, 'Rondo grzegórzeckie - tutaj najczęściej...', false, 'Kraków', 1, current_date);
3. Akceptacja miejsca przez moderatora:
update interesting_places set accepted = 'true' where id = 423;
4. Edycja danych miejsca (współrzędne i opis):
update interesting_places set latitude = 20.33, longitude = 55.64, description = 'nowy, lepszy opis' where id = 423;
5. Usuwanie miejsca:
delete from interesting_places where id = 4224;
6. Dodanie komentarza na temat miejsca:
insert into comments(id, place_id, comment, author, date, grade) values (23, 523, 'Tutaj oblałem egzamin', 4, current_date, 5);
7. Usuwanie miejsca:
delete from interesting_places where id = 423; -- relacje są typu on delete cascade, komentarze do miejsca również się usuną
8. Usuwanie kategorii:
delete from types where id = 123; -- relacje są typu on delete cascade, więc wszystkie miejsca kategorii również się usuną (wraz z komentarzami)
9. Wyszukiwanie miejsc w pewnym obszarze:
select * from interesting_places where latitude between 50.05 and 52.10 and longitute beetwen 19.95 and 23.10
Implementacja bazy danych nastąpiła w oparciu o skrypt SQL przygotowany w ramach części projektowej zadania.
Do stworzenia skryptu wykorzystano przygotowany schemat ERD znajdujący się również w projekcie logicznym modułu aplikacji do zarządzania Ośrodkiem Szkolenia Kierowców.
Projektowany moduł aplikacji dotyczy możliwości zaznaczania na mapie danego miasta ciekawych pod względem komunikacyjnym miejsc i ich komentowania oraz oceniania. Z tego względu moduł nie będzie posiadał funkcjonalności prezentacji i tworzenia dokumentów oraz raportów, gdyż zakres modułu nie dotyczy bezpośrednio dokumentacji ośrodka szkolenia kierowców.
Istnieje ewentualnie możliwość generowania informacji o dodanych miejscach (wszystkich lub wybranych wg odpowiedniego kryterium) np.:
Wyszukanie wszystkich miejsc:
select * from interesting_places
Wyszukanie miejsc w intersującym nas obszarze:
select * from interesting_places where latitude between 50.05 and 52.10 and longitute beetwen 19.95 and 23.10
Aplikacja została stworzona przy wykorzystaniu narzędzia Eclipse w języku Java EE. Baza danych została zaimplementowana na koncie hostingowym umożliwiającym korzystanie z PostgreSQL. Aplikacja uruchamia się poprzez przeglądarkę i jest dostosowana do dwóch popularnych przeglądarek internetowych: Firefox oraz Opera.
Dane można wprowadzać za pomocą stworzonych formularzy. Są one narzędziem wystarczającym, jednak w przypadku konieczności wprowadzenia dużej ilości danych, można stworzyć odpowiednie skrypty zapisujące je bezpośrednio do bazy danych.
Wdrożenie będzie obejmować następujące czynności:
Klientowi zostanie dostarczona dokumentacja aplikacji wraz z jej instrukcją obsługi. Aplikacja jest na tyle intuicyjna, że inne rodzaje szkoleń nie będą konieczne.
System będzie wymagał zatrudnienia administratora obsługującego panel administracyjny, kontrolującego poprawność danych w bazie i zgłaszającego ewentualnie znalezione błędy w działaniu systemu.
Aplikacja będzie poprawiana na podstawie zgłaszanych przez klienta błędów. Jest również możliwe podpisanie nowego kontraktu obejmującego dodanie nowych funkcjonalności na które klient zgłasza zapotrzebowanie.
Ważnym doświadczeniem wyniesionym z realizacji projektu są podstawy konfigurowania serwera aplikacji JBoss. Poprawne skonfigurowanie go, tak żeby działał wydajnie, stabilnie i zawierał wszystkie potrzebne funkcje jest trudną i wymagającą dużej wiedzy czynnością.
Dowiedzieliśmy się też, że na poprawne zaprojektowanie bazy danych dla tak dużej aplikacji potrzeba dużo czasu i bardzo gruntownego jej przemyślenia. Trzeba rozwiązać problemy związane z jednoznacznością i spójnością danych, szybkością bazy oraz jej rozmiarem.
Z wykorzystaniem bazy danych w aplikacji wiążą się mapowania obiektowo-relacyjne. Do ich realizacji użyliśmy biblioteki Hibernate. Sprawiła nam ona nieco problemów, gdyż ciężko było stworzyć kod który nie pobierałby połowy bazy danych niepotrzebnie. Trudnym do zlokalizowania błędem okazała się nazwa kolumny zawierająca słowo kluczowe języka wykorzystywanego przez Hibernate do komunikacji z serwerem bazodanowym.
Inną istotne umiejętności nabyte podczas pracy nad projektem, to poprawne planowanie czasu potrzebnego na wykonanie projektu, zwłaszcza w sytuacji mocnego obłożenia innymi projektami i wykorzystanie biblioteki RichFaces. Zwłaszcza tą ostatnią poznaliśmy bardzo dokładnie, z uwzględnieniem występujących w niej błędów.
