bobbert/cvbuilder_0

0 Fork 0

Files

T

David Livingstone e5947aba58 Restoring cvbuilder_0 to starting position

2024-02-23 00:48:57 +00:00

32 KiB

Raw Blame History

CI5105

Programming II

Software Application Development Coursework (30%)

Java CV Management Application

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.

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.

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

 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

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.

Knumber ends with	CV Sections required
0	User and Contact Information
1	User and Core Competencies
2	User and Core Competencies
3	User and References
4	User and Training and Qualifications
5	User and Contact Information
6	User and Education
7	User and Experience
8	User and Project and Interests
9	User and Publications

 Table 2. CV Sections that you should implement according to the last digit of your Kingston ID Number.It is important that you follow this rubric.

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.

@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.

@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.

@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.

@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.

@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.

@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.

@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.

@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.

@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.

@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.

@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.

@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.

@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.

@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

Implement the application using Java.
Implement a graphical user interface (GUI) using Java Swing.
Use the software development techniques and patterns that we taught, including Gitlab.
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.