Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 Library Management System Detail Level Design Document Version 1.0 Dated: 15th August, 2008 Authors K. Sridharan Revision History Date 15th August, 2008 Confidential Version 1.0 Description First version MCA Mini Project Author Coding Team Page 1 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 Table of Contents 1. Introduction ……………………………………………………………………….. 3 1.1 Reference ………………………………………………………………………………………….. 3 2. Programming platform ……………………………………………………………………… 3 3. Database …………………………………………………………………………………………… 3 4. Database tables ………………………………………………………………………………… 3 5. Classes ………………………………………………………………………………………………4 5.1 Class diagram …………………………………………………………………………………. 4 5.2 Class design detail …………………………………………………………………………….5 6. Activity diagrams/State diagram …………………………………………………………..7 6.1 Activity diagram of whole system …………………………………………………………7 6.2 Activity diagram of each operation ……………………………………………………….8 6.2.1 Student class ……………………………………………………………………………8 6.2.2 Book class ……………………………………………………………………………. 10 6.2.3 Transaction class …………………………………………………………………… 14 6.2.4 MyList class ……………………………………………………………………………16 Confidential MCA Mini Project Page 2 Library Management System Detail Level Design Document 1. Version: 1.0 Date: 15th August, 2008 Introduction This document provides a detailed design of the system. Please refer to the requirement analysis document and high level design document for the overall view and high level design of the system. This document concentrates on the detailed design of the system, including database connection, programming platform, activities diagrams of whole system and each operation of each class. 1.1 References Requirements Document Version 1.0 High level design Document Version 1.0 2. Programming platform The system will be written in Java language. Thus our software is systemindependent and can be run in both MS Windows and Unix system. During development process we will use the MS Windows system. 3. Database The database being used is the DB2 database system, and the connection to the database is made by Java’s JDBC interface. The tables will be created using SQL statements; the runtime SQL will be sent to database and the query result will be sent back to application by JDBC connection. 4. Database tables Confidential MCA Mini Project Page 3 Library Management System Detail Level Design Document 5. Classes 5.1 Class Diagram Confidential Version: 1.0 Date: 15th August, 2008 MCA Mini Project Page 4 Library Management System Detail Level Design Document 5.2 Version: 1.0 Date: 15th August, 2008 Class Design Details Student Class : This class encapsulates all student related operations and details. Book Class : This class encapsulates all Book related operations and details. Confidential MCA Mini Project Page 5 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 Transaction Class : This class encapsulates a single transaction, and maps a student to a book which has been checked out. All associated details of a transaction are also stored in this class (late fees, checkin, checkout dates). MyListClass : This class encapsulates the usecases related to maintaing a temporary subset of user selected books during a search operation. Confidential MCA Mini Project Page 6 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 6. Activity diagrams/State diagrams 6.1 State diagram of whole system Totally 12 windows. All states except "Display Exit Info" can go back to Main Menu. Help Content Get Help Enter Book Info 14 Add a book Main Menu 1 Add a student do/ Insert a student into DB Enter Student Info 7 Reset Search students Search books View Mylist Enter Search Info 2 do/ Insert student into DB Exit Enter Search Info 11 Update/Delete Search Display Exit Info Display MyList 5 New Search exit/ Send from List message Back Display Results 12 Check In/Out entry/ Search students in DB Search Add to list Add to list Back Display Book Detail 4 View Detail / UpdateDelete Update,Delete Check In/Out do/ Update, Delete Update Detail 60 do/ Update,Delete Display Results 3 View Detail Check In/Out entry/ Search books in DB Check In/Out Enter books. student Info 13 do/ Check In, Check Out Confidential MCA Mini Project Page 7 Library Management System Detail Level Design Document 6.2 Version: 1.0 Date: 15th August, 2008 Activity diagram of each operation 6.2.1 Student class AddStudent : add a new student validateStudent [ exists ] return error message [ not exists ] add the student record to Student table return success message DeleteStudent : delete an existing student validateStudent [ not exists ] return error message [ exists ] delete the student record to Student table return success message UpdateStudent : update information of existing student Update the student record in the Student table Confidential MCA Mini Project Page 8 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 SearchStudent : search students Query the student record in Student table return Resultset ValidateStudent : validate student Query the student in Student table according to studentID Return Resultset [ not empty ] Return true [ empty ] Return false Confidential MCA Mini Project Page 9 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 6.2.2 Book class addBook: Add a new book in database Check Book record in database exist yes Return "Book already exist" message no Insert book record in database return success message Confidential MCA Mini Project Page 10 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 exist: Check if the book record already exist in database. Search Book record in database found record? no return not exist message yes return exist message Confidential MCA Mini Project Page 11 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 searchBook: Search books in database search book record in database return resultset updateBook: modify book info update record in database return success message Confidential MCA Mini Project Page 12 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 deleteBook: Delete a book in database check existence exist? no yes delete the record return fail message return success message Confidential MCA Mini Project Page 13 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 6.2.3 Transaction class checkIn() : check in one book SQL Statement (Update.....) Exception? No return true Confidential Yes Print "error message" return false MCA Mini Project Page 14 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 checkOut() : check out one book SQL Statement (Update.....) Exception? No return true Confidential Yes Print "error message" return false MCA Mini Project Page 15 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 6.2.4 MyList class addTolist() : add one book to mylist SQL Statement (Insert.....) Exception? No return true Confidential Yes Print "error message" return false MCA Mini Project Page 16 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 deleteFromList() : delete one book from mylist SQL Statement (Delete.....) Exception? No return true Confidential Yes Print "error message" return false MCA Mini Project Page 17 Library Management System Detail Level Design Document Version: 1.0 Date: 15th August, 2008 Mylist.viewList() : retrieve books in mylist SQL Statement (Select....) Exception? No return true Confidential Yes Print "error message" return false MCA Mini Project Page 18