Project: Sisu Unraveled¶

Program use¶

When starting the program a settings dialog is shown. On the dialog for example the student’s name and student number and possible start year of studies or target graduation year can be given. After providing the needed start information the program moves into the main window of the program where the study program, orientation and possible other needed information is given. The study program and the orientation can be changes in the main window. In addition to the study program selection view the student’s study progress view can be shown. On it the student’s current situation of completed courses is shown. On this view the student can also mark new courses as completed.

Student information is personal data so a JSON file has been defined for handling them in the program. The program execution ends by pressing a button on the main window. Student progress is stored into the JSON file at program exit.

Below is a draft of what the UI might look like:

Many details on the program implementation are intentionally left open and they can be implemented as the team sees fit. Such details include:

• The exact starting point of the program: What is the start state of the program and what information it asks from the user at start?

• The program UI: How the different functionality is run on the program?

• The user’s role in the program: How student progress is shown?

• Showing course information:L What kind of view is used to present course data? What amount of detail the information of one course contains?

A simple JavaFX project, which simply creates an empty window, has been provided through version control. It is meant for mainly those who plan to achieve grade 1.

Compulsory Features¶

You must implement at least the listed basic features to get the project work accepted. Moreover, there some optional additional features, and by implementing them you can increase your grade. With the minimum implementation you can pass (grade 1). Implementing the requirements set for the intermediate implementation, you can get the grade 3. A higher grade requires the implementation of some additional features.

The points collected from the project form a partial grade with grade = points/100. The project amounts to 45% of the grade.

Minimum requirements (Max Grade 1): maximum of 140 points. The minumum implementation must contain the following features:

• The program compiles

• The program contains one dialog window (e.g. the initial dialog)

• The prorgam uses the course provided UI as its main window

• The program gets the structures of the degrees from a defined JSON file and uses the provided interface in implementing the file handling

• The program is able to show the selected study program structure in the main window

• The program uses inheritance in implementing the study program structure

• A final document that contains:

  • Class responsibilities (class diagram is good tool in this)

  • Division of labour in the team.

By implementing intermediate and additional requirements and other merits of the project more project points can be collected.

Intermediate requirements (Max Grade 3): at minimum 300 points

• A graphical user interface has been fully implemented by the team (the simple readily provided JavaFX project is not used)

• The program gets the degree structures from the Sisu API and utilizes the provided interface in implementing the API handling

  • Sisu API is described further below.

• The program works i.e. the degree shown can be changes and the progress situation of the student’s degree is shown.

• The program handles errors in file handling.

• Unit tests have been implemented for the program

• Bonuspoints can compensate up to one grade’s worth of mistakes.

Top-grade requirements (Max Grade 5): at minimun 500 points

• At least two additional features have been implemented (one additional feature is worth 50-100 points)

• Bonuspoints can compensate up to one grade’s worth of mistakes.

Additional Features¶

The features listed below do not need to be implemented but a good implementation is worth an increase in the gradfe. Each additional feature is worth 50-100 points. The effect of a feature can be increased if it turns out to require more work than expected. In order to get the grade increase, the feature must be documented in the submission. The TAs do not search for additional features from the code.

• Course view. On hovering the mouse cursor on a course additional information is shown on the course.

• Student settings. At start of the program a settings window is opened and the student using the program can be set. The situation for the degree is read and stored in a JSON file.

• Showing the schedule of student progress in respect to the degree structure

• Adding a teacher role into the program

• Showing some information entity available in the Sisu API such as assesment items as part of the program

• Unit tests have been implemented for the graphical user interface (see the TestFX framework for testing JavaFX programs).

• Own feature. An additional feature outside this list has been implemented. Note! The feature needs to clearly require coding.

• Note! Additional features must clearly require coding.

• Note! ALL ADDITIONAL FEATURES MUST BE DOCUMENTED TO GET THE POINTS