ArtBook Documentation - media.readthedocs.org · ArtBook Documentation, Release 1.0...
Transcript of ArtBook Documentation - media.readthedocs.org · ArtBook Documentation, Release 1.0...
ArtBook DocumentationRelease 1.0
Team Name
December 17, 2014
Contents
1 User Guide 31.1 Parts Implemented by Mert Karaçam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Parts Implemented by A. Selim Birlik . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.3 Parts Implemented by Sultan Aydogmus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.4 Parts Implemented by Ali Ercan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.5 Parts Implemented by Gülenay Yıldırım . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2 Developer Guide 132.1 Database Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.2 Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
i
ii
ArtBook Documentation, Release 1.0
Team itudb 1410
Members
• Mert Karaçam
• A.Selim Birlik
• Sultan Aydogmus
• Ali Ercan
• Gülenay Yıldırım
** Artbook... **
Contents:
Contents 1
ArtBook Documentation, Release 1.0
2 Contents
CHAPTER 1
User Guide
General Information about Project
ArtBook is a web application which is basically about keeping some information of events. Our web site havestages such as cinema, theater, dance, musical productions, museum and operas
Development and Runtime Environment
Used Units
• Eclipse Kepler
• JDK 1.7_27
• Apache Wicket 1.6
• SQLite Manager
• JazzHub, Bluemix
• Ajax, CSS
General view of ArtBook website is as the following:
Our Website’s member types are as below:
• Admin: Managing website, events, users.
• User: Users can only list and search the events. Also users can edit their member information.
1.1 Parts Implemented by Mert Karaçam
1.1.1 Cinema Page
General Information of Events of Cinema
In this section gives informations about some top rated movies. Furthermore, some operations can bemade in there by the admin. These operations are add,**delete**, update and search
Operations are made some parameters:
3
ArtBook Documentation, Release 1.0
• Movie Name
• Year
• Place
• Director
• Genre
Cinema Page Overview:
Figure 1.1: Figure.2: Cinema Page
Event Operations
Operations screenshots and their explanations are shown as the following:
Add Operation:
4 Chapter 1. User Guide
ArtBook Documentation, Release 1.0
When the necessary informations of parameters are filled, movie is recorded with the aid of save button:
Figure 1.2: Figure.3: Add Page
Delete Operation
After adding movie, admin can delete it with aid of delete button:
Figure 1.3: Figure.4: Delete Page
Update Operation
Admin can also update event with the aid of edit button:
Figure 1.4: Figure.5: Update Page
– Search Operation
Admin and User can list the and search the events in terms of the parameter of place:
–
–
1.1. Parts Implemented by Mert Karaçam 5
ArtBook Documentation, Release 1.0
Figure 1.5: Figure.6: Search Page
Figure 1.6: Figure.7: List Page
When the visitors login web site as the user, they can only list and search informations in terms of place. If theuser clicks add cinemas link, error message is occured:
Figure 1.7: Figure.8: Error Page
1.2 Parts Implemented by A. Selim Birlik
1.2.1 Theatre Home Page
In the theatre home page, there are links to accessing subpages and main menu.
1.2.2 Add Function
User can access the adding page with “add theatre” link from the theatre home page. User can add events withfundamental informations in this page.
Information Parameters
6 Chapter 1. User Guide
ArtBook Documentation, Release 1.0
• Name
• Year
• Dramatist
• Category
• Country
Information Page
When user click the save button, list page opens. Informations of events can be seen in this screen. There is alsoedit link in this page..
1.2.3 Update Function
When user click the edit button, edit screen is opened. User can edit parameters of events and can save them.
1.2.4 Search Function
User can search events with parameters. If user does not write anything to searching text box, all the events list inthe screen.
1.2. Parts Implemented by A. Selim Birlik 7
ArtBook Documentation, Release 1.0
8 Chapter 1. User Guide
ArtBook Documentation, Release 1.0
1.2.5 Delete Function
After list the events, user can delete events in this screen.
1.3 Parts Implemented by Sultan Aydogmus
Müze
1.4 Parts Implemented by Ali Ercan
Opera
1.5 Parts Implemented by Gülenay Yıldırım
1.5.1 Dance Page
This is a general information about part of dance events our art web site
Dance page have these operations: add, delete, update and search add, delete, update operations canbe done only from admin, list and search aperations can be done both of them.
Thesee are operations parameters:
• Name
• Type
• Location
• Date
Dance Page Overview:
1.3. Parts Implemented by Sultan Aydogmus 9
ArtBook Documentation, Release 1.0
Figure 1.8: Figure.1: Dance Page
Event Operations
Add Operation:
Admin can add a new dance event by entering necessary parameters
– .. figure:: gul_image/3.png
scale 60 %
alt map to buried treasure
Figure.3: Dance Page
Update Operation
Admin can update events.
Figure 1.9: Figure.6: Dance Page
Delete Operation
And admin can delete which event we want after adding dance event.
– .. figure:: gul_image/6.png
scale 60 %
10 Chapter 1. User Guide
ArtBook Documentation, Release 1.0
Figure 1.10: Figure.4: Dance Page
alt map to buried treasure
Figure.5: Dance Page
List
Admin and User can list a dance event according to location of event.
Figure 1.11: Figure.9: Dance Page
Search Operation
Admin and User can search a dance event according to location of event.
–
1.5. Parts Implemented by Gülenay Yıldırım 11
ArtBook Documentation, Release 1.0
Figure 1.12: Figure.7: Dance Page
Figure 1.13: Figure.8: Dance Page
12 Chapter 1. User Guide
CHAPTER 2
Developer Guide
2.1 Database Design
Database Diagrams for Cinema, Theatre, Person, Musical, Museum, Dance and Opera are shown as the following:
–
–
Also connected table for Cinema,Theatre, Musical and Person are indicated as below:
–
13
ArtBook Documentation, Release 1.0
2.2 Code
Our Database connection is implemented with SQLite Manager. Related code which is called “DatabaseConnec-tion.java” is shown as below:
2.2.1 Parts Implemented by Mert Karaçam
In my section, I am responsible for the event of cinema in terms of add, delete, update and search operations. Mypages in our project are listed as the following:
• Cinema.java
• CinemaBasePage.java
14 Chapter 2. Developer Guide
ArtBook Documentation, Release 1.0
• CinemaHomePage.java
• CinemaNavigationPanel.java
• MovieListLink.java
• CinemaCollection.java
• CinemaDisplayPage.java
• CinemaDisplayPageLink.java
• CinemaEditForm.java
• CinemaEditPage.java
• CinemaFilterForm.java
• CinemaFilterPage.java
• CinemaListForm.java
• CinemaListPage.java
• ICinemaCollection.java
• package-info.java
Html pages:
• Cinema.html
• CinemaHomePage.html
• CinemaNavigationPanel.html
• CinemaDisplayPage.html
• CinemaEditPage.html
• CinemaFilterPage.html
• CinemaListPage.html
Cinema.java page is for defining of paramaters.
CinemaBasePage page is extended WebPage which is used for created mainnavigation.
CinemaHomePage.java page is extended CinemaBasePage.
CinemaNavigationPanel page is necesssary to click link on the web site.
CinemaCollection.java page is used for creating database in each operations (add, delete, update, search)
ICinemaCollection page is an implement class of CinemaCollection.java. Methods od operations are called inthere.
The other class of DisplayPage, DisplayPageLink, EdiForm, EditPage, FilterForm, FilterPage, ListForm, ListPageare necessary for process of each operations.
Some important codes which are related to CinemaCollection.java are given as below:
Add Process:
2.2. Code 15
ArtBook Documentation, Release 1.0
–
Delete Process:
–
List and Search Operations
–
2.2.2 Parts Implemented by A. Selim Birlik
As a part of our project, I implemented theatre page. Theatre page has add, delete, update and search operations.
Classes
• Theatre.java
• TheatreBasePage.java
• TheatreHomePage.java
• TheatreNavigationPanel.java
16 Chapter 2. Developer Guide
ArtBook Documentation, Release 1.0
• TheatreCollection.java
• TheatreDisplayPage.java
• TheatreDisplayPageLink.java
• TheatreEditForm.java
• TheatreEditPage.java
• TheatreFilterForm.java
• TheatreFilterPage.java
• TheatreListForm.java
• TheatreListPage.java
• ITheatreCollection.java
• package-info.java
Html pages
• Theatre.html
• TheatreHomePage.html
• TheatreNavigationPanel.html
• TheatreDisplayPage.html
• TheatreEditPage.html
• TheatreFilterPage.html
• TheatreListPage.html
Descriptons and Screenshots
Theatre.java class has parameters of events.
TheatreBasePage.java class is extended from WebPage which is used for created mainnavigation.
TheatreNavigationPanel.java class is extended from Panel which has links to event operations:
TheatreCollection.java class is an important part of my section. Add, delete, update and search methods areplaced in this class.
TheatreDisplayPage.java class is extended from TheatreBasePage which adds labels.
TheatreHomePage.html
TheatreNavigationPanel.html
2.2. Code 17
ArtBook Documentation, Release 1.0
18 Chapter 2. Developer Guide
ArtBook Documentation, Release 1.0
TheatreDisplayPage.html
2.2.3 Parts Implemented by Sultan Aydogmus
Database Management System Project ArtBook Group 10 SultanAydogmus040090599 (H. Turgut Uyar)
24.11.2014
General Information
Project Description
ArtBook is a web application which is basically about keeping some information of events. Our web site havestages such as cinema, theater, dance, musical productions, museum and operas. Detailed characteristics of themember types are given below:
2.2. Code 19
ArtBook Documentation, Release 1.0
Admin: Admin manages(create, update, list, delete) all ArtBook classes and user delete operations and updatejust own password.Users can be listed by admin. User-type number is 1 for session attributes.
User: User can see all pages(theater, museum) sign in to website. User can list or search all attribution but cannot create, delete and update operations.
First seen of website:
Firstly, when a website opened by anyone, they saw some information in Home Page.But theycan not access other pages until sign in. When they will sig in, they are redirected to their ownpages. If user is Admin, they directed Admin Home Page else directed their own User Page.
Runtime Environment and Development of Project
Project implemented by Java programming language, and using SQLite database management system. AlsoApache Wicket is framework which we use. Eclipse(Kepler) compiler on Windows 8 is used to write source codecode. For designing of website we used Javascript, Ajax and CSS. Our website tested on Windows 8 versions ofbrowsers(Mozilla, Opera, Chrome), it work good and thanks to CSS it have a good impression on users.
Java part Section
Sultan Aydogmus * AdminHomePage.java * AdminClass.java * AdminDelete.java * AdminDeletePage.java* AdminUpdate.java * IPersonCollection.java * MySession.java * PersonClass.java * PersonCollection.java *ShowPerson.java * UserHomePage.java * UserClass.java * UserUpdate.java * UserUpdatePage.java * User-HomePage.java * UserErrorPage.java * IMusicalCollection.java * MusicalClass.java * MusicalCollection.java* MusicalDisplayPage.java * MusicalDisplayPageLink.java * MusicalEditForm.java * MusicalEditPage.java *MusicalFilterForm.java * MusicalFilterPage.java * MusicalListForm.java * MusicalListPage.java * Musical-HomePage.java * MusicalBasePage.java * MusicalNavigationPanel.java * IMuseumCollection.java * Muse-umClass.java * MuseumCollection.java * MuseumDisplayPage.java * MuseumDisplayPageLink.java * Muse-umEditForm.java * MuseumEditPage.java * MuseumFilterForm.java * MuseumFilterPage.java * MuseumList-Form.java * MuseumListPage.java * MuseumHomePage.java * MuseumBasePage.java * MuseumNavigation-Panel.java * HomePage.java * HomePageLinkList.java * InitDb.java * LoginLink.java * SignIn.java * Sign-InCreate.java * SignInErrorPage.java * SignUpPage.java * SignUpPageCreate.java * WicketApplication.java *DataBaseConnection.java
Installation
For running of project we install, Jetty server which inside of Kepler Compiler and also Java SQLitedrivers.
Connection of SQLite Server The connection must be established to SQLite servers thanks to JDBC drivers. OurDatabase connection is write in DatabaseConnection.java class
User Part
Sign Up
Sign up link is seen until anybody log in in website. If user log in is occured than sign up link will invisible untillog out happen.
Being a User
To be a User of the website, they must enter name, surname and e-mail address and choice a radioboxto type of which they want.
20 Chapter 2. Developer Guide
ArtBook Documentation, Release 1.0
Sign In
Users can sign in to the website with their user name and password.
If users try access with a wrong username or an password they have a error massage.
Log out
When users wants to log out own account, choose Logout at the upper right of the webpage then directed to homepage.
Admin Home Page
Admin manages other users, can do all implements of any class(update, delete, create) and also can update ownpassword.
See All Members
Admin click list person link and popup open.
Delete Users
Delete a users with users ID.
Update Password
Admin can update only own password and email. Click Update Person link
Implementation of classes Admin can do all implementations. Example in musuem page
User Page
User can list and search in other pages
Update Account
User can change its own password and email.
Home Page
All users can see home page.Site name and log in page link are at upper of the webpage. Also sign up page’slink is placed at same place. Even, unregistered users can see but when they click the link to go other page theyredirected to sign in page.
Users
Implementetion can be done by users is just listing and searching in any page of website other implmentetion isrestricted:
When users logged in from homepage they can list any attributes. Example list of museums and searching
The Technical Guide
Database Design
Person Table
All users features is saved in person class. Id username password email ord type foreign key (1)->admin, (2)->user.All attributes are given below:
2.2. Code 21
ArtBook Documentation, Release 1.0
Software Design
Developing the code in the project layout is as follows:
Java Class PersonClass.java All users attributes are kept in PersonClass.
AdminClass.java This class extends from PersonClass.
Interface Java Class IPersonollection.java
All People methods are kept in this java interface class.
PersonCollection.java Person’s all database operations are kept in this file. It extends from IPersonCollection javainterface file. Methods are:
getPerson(): This method gets person list whose registered in the webpage.
findPerson(String name, String pass): This method gets specific person to sign in process.
updatePerson(PersonClass personClass): This method updates person.
deletePerson(int id): This method deletes person by taking its id.
2.2.4 Parts Implemented by Ali Ercan
2.2.5 Parts Implemented by Gülenay Yıldırım
22 Chapter 2. Developer Guide