gym management system user manual

GYM Management System

Accelerated Object Oriented Programming 2: Peter Given

Submitted By: David O’ Connor (KCOMP_G_Y6)

Submitted on: 30th April 2015

Table of Contents

1. Introduction.................................................................................................................................3

2. Design...........................................................................................................................................4

3. Implementation............................................................................................................................4

4. Coding the Domain classes..........................................................................................................5

5. Testing the Domain Classes........................................................................................................5

6. Collections....................................................................................................................................5

7. UserInterface................................................................................................................................6

8. Save and Load..............................................................................................................................7

9. Search/Algorithm.........................................................................................................................8

10. Robustness................................................................................................................................8

11. Inheritance...............................................................................................................................9

12. Use Case Diagram..................................................................................................................10

13. Class Descriptions..................................................................................................................11

14. USER GUIDE:.......................................................................................................................12

14.1. Load Data...........................................................................................................................12

14.2. Member..............................................................................................................................12

14.2.1. Member Details..................................................................................................................12

14.3. Employee............................................................................................................................13

14.3.1. Employee Details................................................................................................................13

14.4. Equipment..........................................................................................................................14

14.4.1. Equipment Details.............................................................................................................14

14.5. Fitness Classes....................................................................................................................15

14.5.1. Fitness Classes Details.......................................................................................................15

14.6. Adding Members to Classes..............................................................................................16

15. Conclusion..............................................................................................................................17

1. Introduction

For my project I have chosen to design a system that will manage the day to day business of a gym. This system will allow the user to add new members to the gym, add new employees for the gym and also add new fitness classes. Once a person has become a member they are assigned a membership number and the new member will therefore be allowed to book a fitness class.

The administrator of the gym system can add, delete and view member details. The administrator can also view and search the members of the gym. All the information can be saved and loaded by the administrator. The system can also view and search employee details and fitness classes.

2. Design

3. Implementation Within the implementation I have applied my knowledge of using:

JMenu Frame:

JOptionPane:

4. Coding the Domain classes

In this project I have written five domain classes which are person class, member class, employee class, equipment class and fitnessClasses class. In these classes they is class header, private attributes, null constructor, full constructor, other constructor (so as to give the user flexibility) set and get methods and a to String method in each one of these classes.

5. Testing the Domain Classes

For each one of these domain classes I’ve tested the null constructor, full constructor, other constructors, the set and get methods and the to string method.

6. Collections

For data collection within this project I used Arraylists to store the relevant information. An Arraylist is a data structure and is used to store the temporary values.

Above are an example of an arraylists within this project that I used an array list was as follows, there are five array list of type memList, empList, equipList, fitClassList and classList are values which will be stored temporally.

7. UserInterface

8. Save and Load

There are two types of streams that can be used in Java

Output stream has a destination to which the data items are going, which allows the user to output a sequence of values of data type byte. This is done when saving data.

Input stream is a source from which the data items come from and allows us to read an array of bytes. This is done when loading/retrieving data that’s already been saved

9. Search/Algorithm

Search algorithm finds the position of a specified value that is required within a sorted array list.

Within this code the search algorithm is looking for a name in which will retrieve the user’s input employee’s details. It will go through the array list until it finds a matching identifier once it finds a match it will display those details if no id is found it should return no results.

10. Robustness

GYM Management System Accelerated Object Oriented Programming 2 David O’ Connor t00130990

11. Inheritance

In the member and employee classes I’ve used the keyword extends (inheritance) in the class header. Member and Employee is a child class of the Person class. This means that member and employee class inherits all the attributes and methods of the person class. I used the super() in member class to call on these from the person class. I also used super.toString to call on a string representation.

Aggregation

I’ve used aggregation in the hold class and the loan class. I’ve used an aggregate (composite) class that models a book in the hold class. I’ve also used an aggregate (composite) class that models a book in the Loan class.

of 17


12. Use Case Diagram

of 17

Add New Member

Add New Employee

Add New Equipment

Add New Fitness Class


13. Class Descriptions

In the person class the variables include String name, int age and char gender. Each variable has setters and getters.

In the member class inherences variables from the person class and also has the variable include int memberID, String memberAddress, int memberPhoneNo, String memberEmail, String memberType, double membershipPrice, String startDate, String finishDate and also int nextMemID. Each variable has setters and getters.

In the employee class inherences variables from the person class and also has the variables include int employeeID, String employeeAddress and int employeePhoneNo. Each variable has setters and getters.

In the equipment class the variables include String equipmentName, String equipmentDescription and also double equipmentSize. Each variable has setters and getters.

In the fitnessClasses class the variables include String className, String activity, int classCapacity, double price, double duration and also int numberOfClasses. Each variable has setters and getters.

of 17


14. USER GUIDE:

14.1.Load DataOnce the user has opened the Interface they may Load the data which has data stored on the system which was saved by a pervious user.

The user begins my clicking on UPLOAD DETAILS LOAD DETAILS

14.2.Member

14.2.1. Member DetailsOnce details are successfully retrieved the administrator may now begin add a member, remove a member, display all members, search a member and sort members by name on the system.

Click on the Member Icon Click “ADD MEMBER” Click “REMOVE MEMBER” Click “DISPLAY ALL MEMBERS” Click “SEARCH A MEMBER” Click “SORT MEMBERS BY NAME”

of 17


14.3.Employee

14.3.1. Employee Details

Once details are successfully retrieved the administrator may now begin add an employee, remove an employee, display all employee, search a employee and sort employee by name on the system.

Click on the Employee Icon Click “ADD EMPLOYEE” Click “REMOVE EMPLOYEE” Click “DISPLAY ALL EMPLOYEE” Click “SEARCH AN EMPLOYEE” Click “SORT EMPLOYEES BY NAME”

of 17


14.4.Equipment

14.4.1. Equipment Details

Once details are successfully retrieved the administrator may now begin add equipment, remove an equipment, display all equipment, search equipment and sort equipment by name on the system.

Click on the Equipment Icon Click “ADD EQUIPMENT” Click “REMOVE EQUIPMENT” Click “DISPLAY ALL EQUIPMENT” Click “SEARCH AN EQUIPMENT” Click “SORT EQUIPMENT BY NAME”

of 17


14.5.Fitness Classes

14.5.1. Fitness Classes Details

Once details are successfully retrieved the administrator may now begin add a new class, remove a fitness class, display all classes, search classes and sort classes by name on the system.

Click on the Fitness Class Icon Click “ADD A NEW CLASS” Click “REMOVE FITNESS CLASS” Click “DISPLAY ALL CLASSES” Click “SEARCH A CLASS” Click “SORT CLASSES BY NAME”

of 17


14.6.Adding Members to Classes

Once details are successfully retrieved the administrator may now begin add a new member to a class and display all class member on the system.

Click on the Class Icon Click “ADD A MEMBER TO CLASS” Click “DISPLAY ALL CLASS MEMBERS”

of 17


15. Conclusion

The gym system works efficiently as a gym management system. It is robust and will not crash while running in the event of user input error or user misuse. The system could be expanded to cater for large gyms. There is no limit to the amount of information that this system can hold.

This system holds information about gym members, employees, equipment and also fitness classes. Information can also be removed at any time from the system. This project has proven to be a worthwhile exercise in software development from inception to planning and execution of the code.

A demonstration of this project can be seen on YouTube using the following link:

https://www.youtube.com/watch?v=EZzUh3AsdwM

of 17

https://www.youtube.com/watch?v=EZzUh3AsdwM

gym management system user manual

Software