UML Diagram

[jayden-andrews]

@startuml

title Scholarship Application System
left to right direction
scale 2

package entities {
class User {
- userId: long
- username: String
- password: String
- role: String
+ getUserId(): long
+ getUsername(): String
+ getPassword(): String
+ getRole(): String
+ setUsername(name: String): void
+ setPassword(password: String): void
+ setRole(role: String): void
}

class Profile {
    - profileId: int
    - userId: long
    - name: String
    - gpa: Double
    - major: String
    - enrollmentStatus: String
    - needsFinancialAid: Boolean
    - state: String
    - ethnicity: String
    - careerGoals: String
    - interests: String
    + getters / setters for all fields
}

class Scholarship {
    - scholarshipId: int
    - name: String
    - description: String
    - amount: Double
    - deadline: LocalDate
    - eligibilityCriteria: String
    - applicationUrl: String
    - fieldOfStudy: String
    - state: String
    - sourceApi: String
    + getters / setters for all fields
}

class Application {
    - applicationId: int
    - user: User
    - scholarship: Scholarship
    - status: ApplicationStatus
    - savedDate: LocalDate
    - submittedDate: LocalDate
    - deadlineAlert: LocalDate
    - notes: String
    + getters / setters for all fields
}

enum ApplicationStatus {
    SAVED
    IN_PROGRESS
    SUBMITTED
    AWARDED
    REJECTED
}

}

User "1" -- "1" Profile : has
User "1" -- "0.." Application : tracks
Scholarship "1" -- "0.." Application : receives
Application --> ApplicationStatus : has an

package repositories {
note "All repositories extend JpaRepository and use SpringBoot's @repository annotation" as N
interface UserRepository {
+ findByUsername(username: String): User
}

interface ProfileRepository {
    + findByUserId(userId: long): Profile
    + deleteByUserId(userId: long): void
}

interface ScholarshipRepository {
    + findByFieldOfStudy(field: String): List<Scholarship>
    + findByState(state: String): List<Scholarship>
}

interface ApplicationRepository {
    + findByUserId(userId: long): List<Application>
    + findByStatus(status: ApplicationStatus): List<Application>
}

JpaRepository <|-- UserRepository : is a
JpaRepository <|-- ProfileRepository : is a
JpaRepository <|-- ScholarshipRepository : is a
JpaRepository <|-- ApplicationRepository : is a
UserRepository ..> User
ProfileRepository ..> Profile
ScholarshipRepository ..> Scholarship
ApplicationRepository ..> Application

}

package services {

class UserService {
    - userRepository: UserRepository
    + register(username: String, password: String): User
    + login(username: String, password: String): User
    + deleteAccount(userId: long): void
    + getUserById(userId: long): User
}

class ProfileService {
    - profileRepository: ProfileRepository
    + createProfile(profile: Profile): Profile
    + updateProfile(profileId: long, profile: Profile): Profile
    + getProfile(userId: long): Profile
    + deleteProfile(userId: long): void
}

class ScholarshipService {
    - scholarshipRepository: ScholarshipRepository
    - externalApiClient: ExternalApiClient
    + fetchFromApi(): List<Scholarship>
    + searchScholarships(query: String): List<Scholarship>
    + filterByField(field: String): List<Scholarship>
    + filterByState(state: String): List<Scholarship>
}

class ApplicationService {
    - applicationRepository: ApplicationRepository
    + saveScholarship(userId: long, scholarshipId: long): Application
    + updateStatus(applicationId: long, status: ApplicationStatus): Application
    + getTrackedApplications(userId: long): List<Application>
    + deleteTracked(applicationId: long): void
}

class MatchingService {
    - profileRepository: ProfileRepository
    - scholarshipRepository: ScholarshipRepository
    - aiClient: AIClient
    + getMatchesForUser(userId: long): List<Scholarship>
    + buildPrompt(profile: Profile, scholarships: List<Scholarship>): String
    + rankByDeadlinePriority(matches: List<Scholarship>): List<Scholarship>
    + refreshMatchesForUser(userId: long): void
}

class AIClient {
    - apiKey: String
    - apiUrl: String
    - restTemplate: RestTemplate
    + getCompletion(prompt: String): String
}

UserService --> UserRepository
ProfileService --> ProfileRepository
ScholarshipService --> ScholarshipRepository
ApplicationService --> ApplicationRepository
MatchingService --> ProfileRepository
MatchingService --> ScholarshipRepository
MatchingService --> AIClient : uses

}

package controllers {
class UserController {
- userService: UserService
+ register(): ResponseEntity
+ login(): ResponseEntity
+ deleteAccount(): ResponseEntity
+ getUser(): ResponseEntity
}

class ProfileController {
    - profileService: ProfileService
    + createProfile(): ResponseEntity
    + updateProfile(): ResponseEntity
    + getProfile(): ResponseEntity
    + deleteProfile(): ResponseEntity
}

class ScholarshipController {
    - scholarshipService: ScholarshipService
    + getAllScholarships(): ResponseEntity
    + getScholarshipById(): ResponseEntity
    + searchScholarships(): ResponseEntity
    + fetchFromApi(): ResponseEntity
}

class ApplicationController {
    - applicationService: ApplicationService
    + saveScholarship(): ResponseEntity
    + updateStatus(): ResponseEntity
    + getTrackedApplications(): ResponseEntity
    + deleteTracked(): ResponseEntity
}

class MatchController {
    - matchingService: MatchingService
    + getMatches(): ResponseEntity
    + refreshMatches(): ResponseEntity
}

UserController --> UserService
ProfileController --> ProfileService
ScholarshipController --> ScholarshipService
ApplicationController --> ApplicationService
MatchController --> MatchingService

}

@enduml

[coreyeross25]

This is a solid UML with a clear structure that follows good Spring Boot layering. The separation between controllers, services, repositories, and entities is well organized, and the relationships between User, Profile, Scholarship, and Application are logical. The inclusion of MatchingService and AIClient is a strong addition and shows good thinking around extended functionality. A few things could be improved: some services like ScholarshipService and MatchingService feel a bit overloaded and could be split to keep responsibilities more focused, method naming could be more consistent across the board, and some relationships would benefit from clearer cardinality labels. It would also help to explicitly enforce the 1:1 relationship between User and Profile and think through validation on Application. Overall, it’s a strong design that just needs a bit more refinement for clarity and scalability.

[jayden-andrews]

@startuml

title Scholarship Application System
left to right direction
scale 2

package entities {
class User {
- userId: long
- username: String
- passwordHash: String
- role: String
+ getUserId(): long
+ getUsername(): String
+ getRole(): String
+ setUsername(name: String): void
+ setPassword(password: String): void
+ setRole(role: String): void
}

class Profile {
    - profileId: long
    - userId: long
    - name: String
    - gpa: Double
    - major: String
    - enrollmentStatus: String
    - needsFinancialAid: Boolean
    - state: String
    - ethnicity: String
    - careerGoals: String
    - interests: String
    + getters / setters for all fields
}

class Scholarship {
    - scholarshipId: long
    - name: String
    - description: String
    - amount: Double
    - deadline: LocalDate
    - eligibilityCriteria: String
    - applicationUrl: String
    - fieldOfStudy: String
    - state: String
    - sourceApi: String
    + getters / setters for all fields
}

class Application {
    - applicationId: long
    - user: User
    - scholarship: Scholarship
    - status: ApplicationStatus
    - savedDate: LocalDate
    - submittedDate: LocalDate
    - deadlineAlert: LocalDate
    - notes: String
    + getters / setters for all fields
}

enum ApplicationStatus {
    SAVED
    IN_PROGRESS
    SUBMITTED
    AWARDED
    REJECTED
}

}

User "1" -- "1" Profile : owns (cascade delete)
User "1" -- "0.." Application : tracks
Scholarship "1" -- "0.." Application : referenced by
Application --> ApplicationStatus : has status

package repositories {
note "All repositories extend JpaRepository\nand use Spring Boot's @repository annotation" as N

interface UserRepository {
    + findByUsername(username: String): User
}

interface ProfileRepository {
    + findByUserId(userId: long): Profile
    + deleteByUserId(userId: long): void
}

interface ScholarshipRepository {
    + findByFieldOfStudy(field: String): List<Scholarship>
    + findByState(state: String): List<Scholarship>
    + findByDeadlineAfter(date: LocalDate): List<Scholarship>
}

interface ApplicationRepository {
    + findByUserId(userId: long): List<Application>
    + findByStatus(status: ApplicationStatus): List<Application>
    + findByUserIdAndStatus(userId: long, status: ApplicationStatus): List<Application>
}

JpaRepository <|-- UserRepository : extends
JpaRepository <|-- ProfileRepository : extends
JpaRepository <|-- ScholarshipRepository : extends
JpaRepository <|-- ApplicationRepository : extends
UserRepository ..> User : queries
ProfileRepository ..> Profile : queries
ScholarshipRepository ..> Scholarship : queries
ApplicationRepository ..> Application : queries

}

package services {

class UserService {
    - userRepository: UserRepository
    + createUser(username: String, password: String): User
    + authenticate(username: String, password: String): User
    + getUserById(userId: long): User
    + deleteUser(userId: long): void
}

class ProfileService {
    - profileRepository: ProfileRepository
    + createProfile(profile: Profile): Profile
    + getProfile(userId: long): Profile
    + updateProfile(profileId: long, profile: Profile): Profile
    + deleteProfile(userId: long): void
}

class ScholarshipQueryService {
    - scholarshipRepository: ScholarshipRepository
    + getScholarshipById(id: long): Scholarship
    + searchScholarships(query: String): List<Scholarship>
    + filterByField(field: String): List<Scholarship>
    + filterByState(state: String): List<Scholarship>
}

class ScholarshipSyncService {
    - scholarshipRepository: ScholarshipRepository
    - externalApiClient: ExternalApiClient
    + syncFromExternalApi(): List<Scholarship>
    + refreshScholarships(): void
}

class ApplicationService {
    - applicationRepository: ApplicationRepository
    + createApplication(userId: long, scholarshipId: long): Application
    + updateStatus(applicationId: long, status: ApplicationStatus): Application
    + validateTransition(from: ApplicationStatus, to: ApplicationStatus): void
    + getApplications(userId: long): List<Application>
    + deleteApplication(applicationId: long): void
}

class MatchingService {
    - profileRepository: ProfileRepository
    - scholarshipRepository: ScholarshipRepository
    - promptBuilder: MatchPromptBuilder
    - aiClient: AIClient
    + getMatchesForUser(userId: long): List<Scholarship>
    + refreshMatchesForUser(userId: long): void
    + rankByDeadlinePriority(matches: List<Scholarship>): List<Scholarship>
}

class MatchPromptBuilder {
    + buildPrompt(profile: Profile, scholarships: List<Scholarship>): String
    + parseResponse(response: String): List<Scholarship>
}

class AIClient {
    - apiKey: String
    - apiUrl: String
    - restTemplate: RestTemplate
    + getCompletion(prompt: String): String
}

UserService --> UserRepository : persists via
ProfileService --> ProfileRepository : persists via
ScholarshipQueryService --> ScholarshipRepository : reads from
ScholarshipSyncService --> ScholarshipRepository : writes to
ApplicationService --> ApplicationRepository : persists via
MatchingService --> ProfileRepository : reads profile from
MatchingService --> ScholarshipRepository : reads scholarships from
MatchingService --> MatchPromptBuilder : delegates prompt to
MatchingService --> AIClient : requests completion from

}

package controllers {
class UserController {
- userService: UserService
+ register(): ResponseEntity
+ login(): ResponseEntity
+ getUser(): ResponseEntity
+ deleteUser(): ResponseEntity
}

class ProfileController {
    - profileService: ProfileService
    + createProfile(): ResponseEntity
    + getProfile(): ResponseEntity
    + updateProfile(): ResponseEntity
    + deleteProfile(): ResponseEntity
}

class ScholarshipController {
    - scholarshipQueryService: ScholarshipQueryService
    - scholarshipSyncService: ScholarshipSyncService
    + getScholarshipById(): ResponseEntity
    + searchScholarships(): ResponseEntity
    + syncFromApi(): ResponseEntity
}

class ApplicationController {
    - applicationService: ApplicationService
    + createApplication(): ResponseEntity
    + updateStatus(): ResponseEntity
    + getApplications(): ResponseEntity
    + deleteApplication(): ResponseEntity
}

class MatchController {
    - matchingService: MatchingService
    + getMatches(): ResponseEntity
    + refreshMatches(): ResponseEntity
}

UserController --> UserService : delegates to
ProfileController --> ProfileService : delegates to
ScholarshipController --> ScholarshipQueryService : queries via
ScholarshipController --> ScholarshipSyncService : syncs via
ApplicationController --> ApplicationService : delegates to
MatchController --> MatchingService : delegates to

}

@enduml