How lamkhanh05/project-slang-word works
Project type and purpose
• This is a standalone JavaFX desktop application for managing and quizzing on “slang words.”
• It follows an MVC-style pattern (Model, View, Controller) with a DAO layer for data access and a service layer for business logic.
High-level file-structure analysis
• Top-level directories:
• data/ — persistent storage files (slang.txt, slang.dat, DAMH#1.pdf)
• src/ — application source code, subdivided into dao, model, service, view, and main packages
• Key packages:
• dao — SlangDAO.java interacts with data files
• model — SlangWord.java and QuizQuestion.java define core domain objects
• service — SlangService.java implements business logic (lookup, quiz generation, scoring)
• view — MainView.fxml, MainViewController.java, style.css define the UI layer via JavaFX
• main — MainApp.java bootstraps the JavaFX application
Core components
a. User Interface (View + Controller)
– MainView.fxml (layout)
– MainViewController (event handlers, input validation)
b. Application Layer
– MainApp (JavaFX Application lifecycle: init → start → stop)
c. Business Logic Layer
– SlangService (business rules: search, random quiz, scoring)
d. Data Access Layer
– SlangDAO (CRUD‐style access to slang.txt / slang.dat)
– data/ directory (source files, optional PDF documentation)
e. Data Models
– SlangWord (fields: word, definitions, history)
– QuizQuestion (question text, options, correct answer)
Relationships and interactions
• MainApp initializes the JavaFX runtime and loads MainView.fxml
→ Instantiates MainViewController
• MainViewController handles user events (e.g., “Search,” “Start Quiz”)
→ Delegates to SlangService
• SlangService applies business logic
→ Calls SlangDAO for data reads/writes
• SlangDAO reads from/writes to files in the data/ directory
• Service returns model objects (SlangWord, QuizQuestion) back to controller
• Controller updates the View (JavaFX scene graph)
Architectural patterns and principles
• MVC: clear separation between View (FXML + CSS), Controller (JavaFX event handlers), Model (POJOs)
• DAO pattern: abstract data‐file operations behind SlangDAO
• Service layer: isolates business logic from both UI and data access
• Convention over configuration: uses package layout and JavaFX defaults to reduce boilerplate
Relevant technologies/frameworks
• Java 8+ / OpenJDK
• JavaFX (FXML, Scene Builder conventions)
• CSS for styling
• Plain text / serialized data files (slang.txt, slang.dat)