Assignment
Overview
This is an individual assignment that requires you to design, develop and test a small Java program using object-oriented approaches.
Learning Outcomes Assessed
The following course learning outcomes are assessed by completing this assessment:
- Identify and use the correct syntax of a common programming language
- Recall and use typical programming constructs to design and implement simple software solutions
- Reproduce and adapt commonly used basic algorithms
- Utilise pseudocode and/or algorithms as a major program design technique
- Write and implement a solution algorithm using basic programming constructs
- Demonstrate debugging and testing skills whilst writing code
- Develop self-reliance and judgement in adapting algorithms to diverse contexts
- Design and write program solutions to identified problems using accepted design constructs
Assessment Details
Maths Whiz! is a competition for local school children to compete against each other to find out who is the ultimate Maths Whiz Champion for the region. Two students from each school are selected to compete in the Championship Round.
Your task is to design, develop and test a small application for managing the Championship results.
Stage 1: Design
This stage requires you to prepare documentation that describes the function of the program and how it is to be tested. There is no coding or code testing involved in this stage. A document template has been provided for your use.
Requirements:
1) Read through Stage 2: Program Development to obtain details of the requirements of this program.
2) Write an algorithm that describes how the program will operate.
a. All program requirements must be included, even if you do not end up including all these requirements in your program code.
b. The algorithm must be structured logically so that the program would function correctly.
3) Prepare and document test cases that can be used to check that the program works correctly, once it has been coded. You do NOT need to actually run the test cases in this stage; this will occur in Stage 3: Testing.
a. All program requirements must be included, even if you do not end up including all these requirements in your program code.
b. Make sure the test cases include checking of data entered by the user to make sure that only valid data is accepted. If the user enters invalid data, the user should be informed of this and given another chance to enter the data. NB: As we have not covered exception handling, you may assume that the user will always enter the expected data type.
c. Test cases should be documented using a template like the one below. You may include extra information if you wish. At this stage, the Actual Result column will be left blank.
Stage 2: Program Development
Using the Design Documentation to assist you, develop a Java program that uses object-oriented coding approaches to record and report upon the Maths Whiz! Championship round, implementing the requirements outlined in this section.
You must follow coding conventions, such as proper layout of code, using naming conventions and writing meaningful comments throughout your program.
Overview of the Program:
This section provides an overview of how the program works from the user's perspective. You may change the appearance of the program provided you implement the same functionality.
1. When the program starts, it provides a short message for initializing the contest administration system and prompts the user to enter the number of questions in the competition. The user must enter a whole number greater than or equal to 1, otherwise the system keeps prompting for the required number of questions until a valid entry is made.
2. Once the number of questions required is obtained, the program automatically initialises. This initialisation includes creating the contest, creating the schools, creating the students and registering the students in the contest.
3. When initialisation is complete, a menu appears providing the user with options to Enter Results, Display Results, View Program Credits or Exit Program.
4. When the user selects the Enter Results option, the user is prompted to enter the scores each student obtains on each question in the contest.
a. When all results have been entered for the contest, a message "Score entry complete" appears and the menu is shown again.
5. When the user chooses the Display Results option, the results of the championship are displayed by student. Students are listed in order of their total scores across all questions, from highest to lowest. This list is followed by the placings for the event, with those students who achieve the highest three scores shown in first, second and third place, with the school they represent also identified. The menu is then redisplayed.
6. When the user selects the option to View Program Credits, a message is displayed providing authorship information for this program. The main menu is then redisplayed.
7. When the user selects the option to Exit program, a message thanks the user for using the system, and the program terminates.Initialising the Program:
Initialising the program requires the following steps:
1. Prompt the user to enter the number of questions required for the championship. This must be a minimum of 1 question and is a whole number to be stored as an int. Initialisation cannot proceed until this number has been obtained.
2. Create a new Contest for the Maths Whiz! Championship. For this task, you will set the maximum number of entrants to 8 and the maximum entrants from any one school to be 2.
3. Create a new School for each of the participating schools.
a. You must select any four schools that are local to your university campus and create a School to represent each of these.
b. Each School's name must match the name of a local school you have selected. You can make up any id for that school.
c. For testing purposes, you must create a fifth school that will not end up competing in the contest. This is to demonstrate that further entries will not be accepted into the contest once all available entries have been filled. This school must be named after you.
4. Create new Students to compete in the contest. Each Student has an attribute that stores their School. You may choose the names for your own students.
a. Make sure you have enough students to fill the contest and for testing, to demonstrate that the limit on entrants from any one school is enforced and that further entrants cannot be registered once the contest is full.
5. Register the Students to compete in the contest. Registration occurs by creating new Entries, which comprise a Student and an integer array that stores the Student's scores for each question. These Entries are stored in the entries array. This array must be full when registration is complete.
a. You will need to make sure that each student is only registered once in the contest.
b. There is a limit on the number of students from a single school in each event. Make sure that this limit is not exceeded.
c. When all places in the event have been filled, no further registrations may be accepted.
The user should be advised with a message if any of these issues occur. Your initialisation code must include attempted registrations that result in each of these issues.
6. Advise the user that initialisation is complete,
Running the Program:
1. Entering Results
a. Scores for each question should be stored in the quizScores array for each Student
b. The user is to be prompted to enter the scores for each question for each Student. All scores for Question 1 will be entered first, continuing for each successive question number until all questions have scores entered. Each score is to be read as an int and updated by accessing each Student in the entries array and using the setScores(int, int) method to update the quizScores array. Tip: This method takes two integer parameters. One of these represents the question number the student has answered. The other represents the score they obtained for that question.
c. You may assume that the user's results entry is the correct data type (that is, an int). You do not need to check to make sure that the user does not enter non-numerical characters.
d. If the user selects the option to Enter Results after having already entered these, the earlier scores will be overwritten.
2. Displaying Results
a. Displaying the contest results requires sorting the Students in order of the total scores they obtained and presenting this information in a readable format. This report is followed by identifying the first, second and third place-getters and the school each of these students represents.
i. To sort the students, you will need to write a sorting method that finds the total score for each student and rearranges their position based in the array based on this total.
ii. If two or more students obtain the same total score, then the order of the students and their placings will be determined based on the order their results were entered.
3. Viewing Program Credits
a. No special processing is required for this section. A simple display of the credit information is all that is needed.
4. Exit Program
a. The program should exit by reaching the end of the main() method. System.exit(int) should not be used.
Stage 3: Testing
Using a copy of the test cases developed in Stage 1: Design, test the program you have developed in
Stage 2: Program Development. Document your results, including both failed and successful tests.
Note: Please do not leave out any failed tests. If your testing highlights that your program has not worked correctly, then the failed tests help to demonstrate that you have been testing your program properly.
To show that you have tested your program, include small (but readable) screen captures in your Actual Results as well as any explanatory comments. Microsoft Windows includes a Snipping Tool that is useful for taking captures of the relevant parts of the screen.
Attachment:- Assignment - specification.rar