bobbert/cvbuilder_0
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updating to 2024-25 version

Browse Source
This commit is contained in:
David Livingstone committed 2025-02-16 17:06:50 +00:00
1 parent e5947aba58
commit 6bf0de4899
3 files changed
+4 -758
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+2 -2
View File
@@ -6,14 +6,14 @@ This is the starting point for your cvbuilder coursework. The last number in the
# TB2 Software Development Coursework - CVBuilder App
As part of Unit 2 - Software Application Development you have a [Software Development Coursework Assignment](https://canvas.kingston.ac.uk/courses/26279/assignments/133246) that is worth 30% of your total module mark. There is a [Coursework Assignment Brief](./docs/CourseworkAssignmentBrief.md) which details the Requirements and Assessment Criteria. It is important that you only do the Requirements (CV Sections) that are assigned to you according to the last number in your student id (Knumber). You are provided with some typical [data](./data/cv_repo_0.csv) to get you started with your application. The cvbuilder follows on from the Swing Portfolio Coursework that you did - in particular for the compulsory User Section of the CV. This was all discussed in the [CI5105 TB2 Week 7 - Coursework Lecture Video](https://kingstonuniversity.sharepoint.com/:v:/r/sites/Course_ci5105_all_ty13_23-fmUrIjN9H4HBt/Shared%20Documents/General/Recordings/CI5105TB2Week7Lecture-CWK-20240222_111951-Meeting%20Recording.mp4?csf=1&web=1&e=QpdUcA&nav=eyJyZWZlcnJhbEluZm8iOnsicmVmZXJyYWxBcHAiOiJTdHJlYW1XZWJBcHAiLCJyZWZlcnJhbFZpZXciOiJTaGFyZURpYWxvZy1MaW5rIiwicmVmZXJyYWxBcHBQbGF0Zm9ybSI6IldlYiIsInJlZmVycmFsTW9kZSI6InZpZXcifX0%3D)
As part of Unit 2 - Software Application Development you have a [Java Software Application Development and Demo Assignment](https://canvas.kingston.ac.uk/courses/29973/pages/assessment-and-feedback-schedule-2) that is worth 30% of your total module mark. There is a 'Coursework Assignment Brief' which details the Requirements and Assessment Criteria. It is important that you only do the Requirements (CV Sections) that are assigned to you according to the last number in your student id (Knumber). You are provided with some typical [data](./data/cv_repo_0.csv) to get you started with your application. The cvbuilder follows on from the Swing Portfolio Coursework that you did - in particular for the compulsory User Section of the CV. This is all discussed in the first workshop after EAW week [CI5105 TB2 Week 7 - Workshop](https://canvas.kingston.ac.uk/courses/29973/pages/topic-3-more-advanced-java)
You should follow a development process similar to the specified for your UserProfileBuilder i.e. you must develop your code in this repository with the correct use of KUGitlab with frequent commits and appropriate commit messages as you progress.
# CV Builder App Start Code
You have been provided with a basic Maven Project that includes a single package (cvbuilder) with a .gitkeep file in it. This should be the top-level package for your code and you should create other packages beneath this. You should clone this project as covered in (Using KUGitlab - Access and Workflow)[https://kingstonuniversity.sharepoint.com/:p:/s/CI5105Privatemst/EXORk0ko9Y5EiZaPDW8x0vcBQ4ltw2hfrlRG3kj9UimQSg?e=6lyeEW]
You have been provided with a basic Maven Project that includes a single package (cvbuilder) with a .gitkeep file in it. This should be the top-level package for your code and you should create other packages beneath this. You should clone this project as covered in (Using KUGitlab - Access and Workflow)[https://canvas.kingston.ac.uk/courses/29973/pages/unit-2-week-1]
To get this sample code onto your local machine you will need to:
docs/CourseworkAssignmentBrief.md
-754
View File
@@ -1,754 +0,0 @@
<h1>CI5105</h1>
<h1>Programming II</h1>
<h1>Software Application Development Coursework (30%)</h1>
<h1>Java CV Management Application</h1>
# Coursework Brief
The main objective of this assignment is to provide students with hands-on experience in building a Java application featuring a Java Swing graphical user interface (GUI) and file input/output (I/O) capabilities. In addition, the application must satisfy a number of requirements or use-cases and these are detailed in full below.
To complete this project, you need to develop an application that enables users to manage Curriculum Vitae (CV) data. Users should be able to edit and update different sections of their CV as required, to simplify the creation of a Custom CV tailored to individual job applications.
The project is intended to enhance students' Java programming skills. It involves writing code to implement a data model, crafting Java Swing GUI code and developing code to thoroughly test various use-cases, including storing, managing, and retrieving CV data.
## Submission Details
We consider the CV to have the nine sections listed below. You are not being asked to build an application to handle all nine sections. You need to build an application that handles only the User section and another section, as per the table below.
* The submission deadline: 18th April (Thursday of "revision week" just before exams start...)
* The submission format: GitLab repository accompanied by a walk-through video submitted to Canvas drop box demonstrating and explaining the developed functionality.
<p style="background:yellow; color:black">Every student must do two sections. The User section is compulsory - everyone must do this. The second section is decided on the basis of the last digit of your K-number according to another table below.</p>
<div style="width:75%; font-size:smaller;">
Section|Component|Mandatory/Optional|
--|--|--|
User|Title|Mandatory|
| |Name|Mandatory|
| |Email|Mandatory|
Contact Information|Phone|Mandatory|
| |Address|Optional|
Core Competencies|Profile Statement|Mandatory|
||Skills|Optional|
Education|Certificate 1|Mandatory|
||Certificate 2|Optional|
Experience|Role 1|Mandatory|
||Role 2|Optional|
Training & Qualifications|Qualification 1|Mandatory|
||Qualification 2|Optional|
Projects & Interests|Interests List|Mandatory|
||Accomplishments List|Optional|
Publications|Reference Entry 1|Mandatory|
||Reference Entry 2|Optional|
References|Referee Contact Info 1|Mandatory|
||Referee 2 Contact Info|Optional|
</div>
</br><code> Table 1. CV Sections and Components: For a particular Section, Components that are Mandatory must appear. Those that are optional might be included if selected</code>
<p></p>
A CV management system that supports the nine sections and the list of features we detail below, is quite a complex application. So, we decided to partition the application so that students build slightly different things.
<table>
<tr>
<th style="width:3em">Knumber <br/> ends with</th>
<th style="width:20em">CV Sections required</th>
</tr>
<tr>
<td style="text-align:center">0</td>
<td><a href="#user">User</a> and <a href="#contact-information">Contact Information</a></td>
</tr>
<tr>
<td style="text-align:center">1</td>
<td><a href="#user">User</a> and <a href="#core-competencies">Core Competencies</a></td>
</tr>
<tr>
<td style="text-align:center">2</td>
<td><a href="#user">User</a> and <a href="#core-competencies">Core Competencies</a></td>
</tr>
<tr>
<td style="text-align:center">3</td>
<td><a href="#user">User</a> and <a href="#references">References</a></td>
</tr>
<tr>
<td style="text-align:center">4</td>
<td><a href="#user">User</a> and <a href="#training-and-qualifications">Training and Qualifications</a></td>
</tr>
<tr>
<td style="text-align:center">5</td>
<td><a href="#user">User</a> and <a href="#contact-information">Contact Information</a></td>
</tr>
<tr>
<td style="text-align:center">6</td>
<td><a href="#user">User</a> and <a href="#education">Education</a></td>
</tr>
<tr>
<td style="text-align:center">7</td>
<td><a href="#user">User</a> and <a href="#experience">Experience</a></td>
</tr>
<tr>
<td style="text-align:center">8</td>
<td><a href="#user">User</a> and <a href="#projects-and-interests">Project and Interests</a></td>
</tr>
<tr>
<td style="text-align:center">9</td>
<td><a href="#user">User</a> and <a href="#publications">Publications</a></td>
</tr>
</table>
</br><code> Table 2. CV Sections that you should implement according to the last digit of your Kingston ID Number.<b>It is important that you follow this rubric.</b></code>
<p></p>
## Task Description
Consider this: We want to build an application to provide users with a comprehensive CV-building experience that goes beyond the conventional approach. A CV typically consists of various sections, such as User, Contact Information, Education, Experience, Skills, Interests, and more. However, our vision takes it a step further. We want to let users not only create their initial CV but also manage a repository where they can preserve and access 'choices' to customise these CV sections for different roles.
This approach makes it easier to produce a **customised CV**. Users can tailor their CVs to specific job positions by drawing from the repository and picking their most relevant data. This dynamic approach to CV management helps users prepare CVs for various opportunities with ease.
## Mock-ups of interface
The suggested look-and-feel of the application is shown below.
Do note the following:
* These diagrams were not screen-captures from an actual Java application, these were designed on a mock-up tool and your 'design' will inevitably be different.
### User
__In the User section__, the user may have several ways in which they present their name, title and email.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ **User**| Contact | Core | Education | Experience | Training | Projects | Publications | References }
...
{/ **Name**| Title | Email }
{^"Name"
(X) Scheherazade Taylor | [edit] | [delete]
() SJ Taylor | [edit] | [delete]
() Shaz Taylor | [edit] | [delete]
" " |[add]
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The past choices are there, they may be deleted or updated, or brand-new entries may be added, and once added, they join the list. There are radio buttons next to each choice. The user may pick only one choice from a list.
Note that the "Prev" and "Next" buttons switch the user from one section to another. Switching between _Name_, _Title_ and _Email_ is done directly through the sub-section tabs. But for switching between the main sections, the user may use either the section tabs or the "Prev" and "Next" buttons.
Below is the detail for the _Title_ sub-section of _User_.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ **User**| Contact | Core | Education | Experience | Training | Projects | Publications | References }
...
{/ Name | **Title**| Email }
{^"Title"
[X] Include
\t
(X) Ms. | [edit] | [delete]
() Miss | [edit] | [delete]
() HRH | [edit] | [delete]
" " |[add]
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
Note that there is an _include_ button. If the user does not tick the _include_ button, the information in the _Title_ sub-section will not be saved to the Custom CV.
Below is the detail of the _Email_ sub-section of _User_.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ **User**| Contact | Core | Education | Experience | Training | Projects | Publications | References }
...
{/ Name | Title | **Email**}
{^"Email"
(X) strong@bob.com | [edit] | [delete]
() gmail_account@gmail.com | [edit] | [delete]
() k1234567@kingston.ac.uk | [edit] | [delete]
" " |[add]
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
### [KUID0&5] Contact Information
__In the Contact Information section__, there are components: _Phone_ and _Address_.
If the user clicks on the _Phone_ tab in the Contact Information screen, they see the screen below.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | **Contact**| Core | Education | Experience | Training | Projects | Publications | References }
...
{/ **Phone**| Address }
{^"Phone"
(X) 07910582346 | [edit] | [delete]
() 07910582347 | [edit] | [delete]
" " |[add]
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The user may edit/delete the choices for address entries, select from them, or add to them. Once done, they can move on to the _Address_ sub-section.
Below is the _Address_ detail of the _Contact Information_ section.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | **Contact**| Core | Education | Experience | Training | Projects | Publications | References }
...
{/ Phone | **Address**}
{^"Address"
[X] Include
\t
(X) 11 Rita Road .. | [edit] | [delete]
() 12 Rita Road .. | [edit] | [delete]
() 13 Rita Road .. | [edit] | [delete]
" " |[add]
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The user may edit/delete the choces for telephone entries, select from them, or add to them. The user has the option of including the Address information in the Custom CV or leaving it out, by ticking or un-ticking the _Include_ checkbox.
### [KUID1&2] Core Competencies
__In the Core Competencies section__ — displayed below, there are the components: _Profile Statement_ and _Skills_. The _Skills_ component is required: this means that any CV must have a Skills component. The user may wish to include the _Profile Statement_ by ticking the checkbox.
In the _Profile Statement_ sub-section, the user may manage the entries and pick from the choices. They may edit/delete the choices of Profile Statements, select from them, and add to them. The user should also decide whether to include the profile statement as part of the Custom CV, with the default being to include it.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | **Core**| Education | Experience | Training | Projects | Publications | References }
...
{/ **Profile Statement** | Skills }
{^"Profile Statement"
[X] Include
\t
(X) |
{+
I am a highly energetic student with a strong passion
for various fields, seeking opportunities to contribute
and learn in diverse and dynamic environments.
} | [edit] | [delete]
( ) |
{+
Student with 3+ years of hands-on experience in Python,
specialising in data analysis and machine learning,
now seeking a role to leverage my expertise in developing
advanced data-driven solutions for SAP applications.} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t
" "} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
Below is the _Skills_ detail of the _Core Competencies_ section. Here, the user may manage the skills entries and select from the choices. They may edit/delete the choices of entries, select from them, and add to them. The user should also decide whether to include the skills statement as part of the Custom CV, with the default being to include it.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | **Core** | Education | Experience | Training | Projects | Publications | References }
...
{/ Profile | **Skills** }
{^"Skills"
() Java, Excel, Word, Techwhiz, Analysis, Communication | [edit] | [delete]
(X) Java, Python, PHP, Oracle DBMS | [edit] | [delete]
" " |[add]
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
### [KUID6] Education
__In the Education section__ — displayed below, there are _Institution_ listings. Each educational institution the user attended has its sub-section (tab).
In the screen below, the user is viewing the _Institution 1_ sub-section. They may manage choices from the education section entries(degree or certificate) received at that institute. They can edit or delete existing entries, or add a new entry.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | Core | **Education** | Experience | Training | Projects | Publications | References }
...
{/ **Institution 1** | Institution 2 }
{^"Institution 1"
() | {+
BSc in Computer Science
Kingston University
Sep 2021 – Sep 2024
Built Java desktop application ... } | [edit] | [delete]
(X) | {+
Kingston University London
BSc in Computer Science
Sep 2021 – Sep 2024
First Class (Honours)
} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t
" "} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
In the screen below, the user has clicked the _Institution 2_ tab and is able to edit/add different choices/selections.
Note that the user, from Institution 2 onwards, has a choice whether to include the data in that Institution in the Custom CV or not. In the screen below, the user ticked the _Include_ checkbox.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | Core | **Education** | Experience | Training | Projects | Publications | References }
...
{/ Institution 1 | **Institution 2** }
{^"Institution 2"
[X] Include
\t
() | {+
Ghostbusters Comprehensive
A-Levels Maths (C), Computing (B), Physics (C)
Sep 2016 – Jun 2021} | [edit] | [delete]
(X) | {+
Ghostbusters Comprehensive
Sep 2016 – Jun 2021
A-Level Results: Maths (C), Computing (B), Physics (C)
} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t
" "} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The _Institution_ component is typically several lines long; but it is stored as a whole; the institution name, start date, end date, description are stored separately. If the user wants to change one line and keep the other lines the same, they have to type the other lines again.
### [KUID7] Experience
__In the Experience section__ — displayed below, there are _Position_ listings. Each role or position the user had is contained by its respective sub-section (tab).
This section works very much like the Education section: the first Position is always mandatory (it will be used in the Custom CV), but subsequent positions are optional (so they have an Include checkbox).
In the screen below, the user has clicked the Position 2 sub-section and is able to edit/add different versions.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | Core | Education | **Experience** | Training | Projects | Publications | References }
...
{/ Position 1 | **Position 2** }
{^"Position"
[X] Include
\t
() | {+
Mentor
Kingston University London, Sep 2021 – Sep 2022
Mentoring first-year students and assisting with second-year Labs.
} | [edit] | [delete]
(X) | {+
Student Helper
Kingston University
Sep 2021 – Sep 2022
Helping students with their projects
} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t
" "} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The Position 1 tab would be very similar in appearance but would not have an _Include_ checkbox.
The _Position_ component is typically several lines long; but it is stored as a whole; the position title, organisation name, start date, end date, description are stored separatekl. If the user wants to change one line and keep the other lines the same, they have to type the other lines again.
### [KUID4] Training and Qualifications
__In the Training & Qualifications section__ — displayed below, there are _Training or Qualifications_ listings. Each training or qualification the user accomplished is contained in its respective sub-section (tab).
This section works very much like the Education and Experience sections: the first _Training or Qualification_ is always mandatory (it will be used in the Custom CV), but subsequent positions are optional (have an Include checkbox).
In the screen below, the user has clicked the second sub-section and is able to edit/add different versions.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | Core | Education | Experience | **Training** | Projects | Publications | References }
...
{/ Training and Qualifications 1 | **Training and Qualifications 2** }
{^"Training or Qualification"
[X] Include
\t
() | {+
Certification in Advanced First Aid and Emergency Response
Institute of Emergency Preparedness and Safety (IEPS)
Online Course, January 2023
Successfully completed an intensive training program
from the prestigious Institute of Emergency Preparedness and Safety.
} | [edit] | [delete]
(X) | {+
Advanced First Aid Certification
Institute of Emergency Preparedness and Safety
Completed intensive training in skills in CPR, wound care, and
emergency response, demonstrating a commitment to safety and well-being.
} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t\t
" "
} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The first tab would be very similar in appearance but would not have an _Include_ checkbox.
The _Training or Qualification_ component is typically several lines long; but it is stored as a whole; the training or qualification title, organisation name, start date, end date, description are stored sparately. If the user wants to change one line and keep the other lines the same, they have to type the other lines again.
### [KUID8] Projects and Interests
__In the Projects & Interests section__ — displayed below, there are _Project or Interest_ data. Each project or list of interests that the user records is contained in its respective sub-section (tab).
This section works very much like the Education, Experience and Training & Qualifications sections: the first _Project or Interest_ is always mandatory (it will be used in the Custom CV), but subsequent records are optional (have an Include checkbox).
In the screen below, the user has clicked the second sub-section and is able to edit/add different versions.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | Core | Education | Experience | Training | **Projects** | Publications | References }
...
{/ Projects and Interests 1 | **Projects and Interests 2** }
{^"Project or Interest"
[X] Include
\t
() | {+
Raspberry Pi 2 integration.
This home project involved designing and implementing a home
automation system that uses the capabilities of the Raspberry Pi 2,
incorporating sensors, cameras, and actuators for enhanced
functionality. I programmed custom scripts and interfaces, enabling
seamless control of connected devices through a centralised hub.
This hands-on experience deepened my understanding of embedded
systems and honed my problem-solving skills.
} | [edit] | [delete]
(X) | {+
Developed a home automation system leveraging Raspberry Pi 2
for seamless integration of sensors, cameras, and actuators.
This project enhanced my skills in embedded systems and
problem-solving through hands-on experience.
} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t\t
" "
} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The first tab would be very similar in appearance but would not have an _Include_ checkbox.
The _Project or Interest_ component is typically several lines long; but it is stored as a whole; the specifics of the description are stored individually. If the user wants to change one line and keep the other lines the same, they have to type the other lines again.
### [KUID9] Publications
__In the Publications section__ — displayed below, there are _Publication_ data. Each publication that the user records is contained in its respective sub-section (tab).
This section has no mandatory sub-sections. This means that unless the user ticks the Include tickbox, publications information will not be used in the Custom CV. All records are optional (have an Include checkbox).
In the screen below, the user has clicked the sub-section for the first entry and is able to edit/add different versions.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | Core | Education | Experience | Training | Projects | **Publications** | References }
...
{/ **Publication 1** }
{^"Publication"
[X] Include
\t
(X) | {+
Taylor, S J. (2023). "Unlocking the Potential of AI for UG Students."
Kingston University Ripple Magazine, 21(2), 4-7.
} | [edit] | [delete]
() | {+
_Unlocking the Potential of AI for UG Students._
Kingston University Ripple Magazine
June 2023
} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t\t
" "
} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The _Publication_ sub-section is typically several lines long; but it is stored as a whole; the specifics of the publication details are stored individually. If the user wants to change one line and keep the other lines the same, they have to type the other lines again.
### [KUID3] References
__In the References section__ — displayed below, there are _Referee_ entries. Each referee that the user records is contained in its respective sub-section (tab).
This section has no mandatory sub-sections. This means that unless the user ticks the Include tickbox, refereee information will not be used in the Custom CV. All sub-tabs are optional (have an Include checkbox).
In the screen below, the user has clicked the sub-section for the first entry and is able to edit/add different versions.
```plantuml
@startsalt
scale 1
title CV-Builder
header CI5105 Application Coursework
{
{* File }
...
{/ User | Contact | Core | Education | Experience | Training | Projects |Publications | **References** }
...
{/ Referee 1 | **Referee 2** }
{^"Referee"
[X] Include
\t
(X) | {+
James Denholm-Price
Personal Tutor
Kingston University London
} | [edit] | [delete]
() | {+
James Denholm-Price
Head of Department
School of Computer Science and Mathematics
Kingston University London
j.denholm-price@kingston.ac.uk
} | [edit] | [delete]
.
. | {+
\t\t\t\t\t\t\t
" "
} |[add]
.
}
...
{[Prev Section]| \t\t\t\t\t\t\t\t\t\t\t\t | [Next Section]}
}
@endsalt
```
The _Referee_ sub-section is typically several lines long; but it is versioned as a whole; the specifics of the referee (organisation, position, email, etc) are not versioned. If the user wants to change one line and keep the other lines the same, they have to type the other lines again.
---
### Key use cases
The main use cases that your Java application should demonstrate are:
- The user is able to enter data to populate __two__ CV sections (the two sections, of the nine, are allocated on the basis of the last digit of your k-number).
- The user is able to maintain the set of choices of each CV section (edit & delete).
- The user is able to load the repository of CV data from a file/files (covering both of your two sections).
- The user is able to make changes to the CV data and subsequently store the new data to a repository file(s).
- The user is able to select from the various history/choices of each section to craft a Custom CV.
- The user is able to store the contents of the Custom CV to a file.
- The user is able to print to console the contents of the Custom CV.
- The user is able to interact with an attractive, organised graphical interface.
Further details are provided below.
## Technical Requirements
1. Implement the application using Java.
1. Implement a graphical user interface (GUI) using Java Swing.
1. Use the software development techniques and patterns that we taught, including Gitlab.
1. Do NOT use a code generator of any sort, that includes NO GUI builders, no generated code off an AI engine, etc.
Any deviation from these guidelines automatically opens questions that will very likely necessitate a viva with the student, in person, before a mark can be given.
## Detailed breakdown of requirements
Here are detailed sub-tasks for the main tasks outlined above:
### ==Data Entry and Population==
For each of your two CV sections:
- [must] Create data entry forms for users to input the section information, broadly following the designs shown in the mock-ups, for the two sections.
- [should] Provide a user-friendly interface for easy data input.
- [could] Implement data validation to ensure that the entered information is accurate and complete.
### ==Maintenance of Choices==
For each of your two CV sections:
- [must] Implement options for each CV section so that users can select from the set of choices.
- [must] Allow users to view and select from a set of CV sections.
- [should] Allow users to load from a file a repository of data for each of the sections.
- [could] Allow users to save to a file a new repository containing all the data in the various sections.
- [could] Ensure data persistence so that user data remains intact across application sessions via the repository.
As envisioned in the UI seen above (which you do not have to stick to, but can design your own UI), the key thing is to let the user see and select from a set of choices within the various CV sections, and to let them add new choices. In this way, the 'versioning' or creation of choices/history is useful and doesn't get too much in the way.
### ==CV Storage and Display==
For each of your two CV sections:
- [must] Allow users to print the contents of a Custom CV to the console (the Custom CV will be restricted to your two sections only)
- [should] Format the printed output in a clear and organised manner for easy readability.
- [should] Enable users to save the contents of the Custom CV (i.e, the versions picked in each section by the user) to a formatted file for later retrieval.
- [could] Provide options for users to select which parts of the CV to print (this applies to section that have "include" tick-boxes).
### ==User Interface Design==
For each of your two CV sections:
- [should] Design an attractive, user-friendly graphical user interface (GUI) that provides an organised layout for data entry and retrieval.
- [should] Ensure that the GUI is intuitive and easy to navigate.
### ==CV Editing and Deletion==
For each of your two CV sections:
- [should] Implement the ability for users to edit and delete choices from the "history" (past entries) of the two sections.
The above sub-tasks provide a comprehensive breakdown of the main tasks for creating the Java CV management application. Students should focus on addressing these sub-tasks to meet the assignment's requirements effectively.
## Deliverables
1. Well-documented Java source code for the application – that you wrote yourself — with a history of Gitlab commits.
1. A recorded demo (walk-through) explaining how the app works, including code implementation, design choices etc.
## Assessment Criteria
The [must/should/could] criteria above will be assessed for each of the two CV sections assigned (as per your KU ID last digit).
- For a pass (40-50) the demo must show the application, explaining the core code, which implements at least the [must-haves] for both sections.
- For a B/C (50-70) the demo must show the application, explaining the core code, which implements at least the [must-haves] and [should-haves] for both sections.
- For an A (>70) the demo must show the application and discuss design choices made whilst writing the code, which implements all [must-haves], all [should-haves] and the majority of [could-haves].
## Feedback and Assessment
The practical experience gained from this project aligns with the module's intended learning outcomes, which encompass designing and implementing a data model, creating a user-friendly GUI, and rigorously testing the application. Furthermore, this project serves as a useful exercise, reminding students to prepare their CVs for potential placement or full-time job opportunities. Upon completion, you will have your own CV management system and the ability to claim this accomplishment on your CV!
## Late Submission and Plagiarism
The code and demo must be yours, evidenced by meaningful Gitlab commits. Code that is not well-explained, or is "3rd party" without clear & justifiable reference/origin, may need to be viva'd in-person during the exam period (so make sure your demo, explanation and documentation - comments in the code and Gitlab - are clear and comprehensive).
There is a University-mandated "24h grace period" after the deadline for "IT issues" i.e. you should have finished the work by the deadline and not need the grace period other than for exceptional circumstances (such as Canvas uploads failing etc.) Work that is even 1 minute after the grace period expires will be "late". Work that is "late" but within 5 working days of the deadline will be capped at 40% ("late-capped"), after that work is "too late" and will not be marked. If you need to submit after the deadline (after the drop box on Canvas has closed), contact the module leader for the mechanism (obviously your code will be on Gitlab but your demo will need to be submitted to Canvas for a "late-capped" mark).
<p><strong style="background:yellow; color:black;">Test your work after you submit!</strong> Every year there is at least one person who claims "they submitted the 'old' version by mistake" or "the video was corrupt" as an excuse for the work not being assessable -- such work cannot be marked. Testing (by downloading it from Canvas and running it yourself) is so easy ... please don't forget to <strong style="background:yellow; color:black; text-transform: uppercase;">test your work!</strong></p>
pom.xml
+2 -2
View File
@@ -7,7 +7,7 @@
<packaging>jar</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<maven.compiler.source>21</maven.compiler.source>
<maven.compiler.target>21</maven.compiler.target>
</properties>
</project>