# ngoctien0110/slang-dictionary architecture

> Architecture diagram of the GitHub repository ngoctien0110/slang-dictionary, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ngoctien0110/slang-dictionary
- Repository: https://github.com/ngoctien0110/slang-dictionary

## Overview

##### Project type and purpose
- This is a standalone Java application (Console or Swing/JavaFX GUI) implementing a Slang Dictionary.
- It supports searching by slang or definition, history tracking, add/edit/delete, reset, random word, and two quiz modes.

##### File structure
- src/
- Main.java – application entry point
- Home.java – main menu UI
- *Page.java classes (AddPage, DeletePage, EditPage, …) – each represents a screen or dialog in the UI layer
- FileManager.java – handles all Java I/O with slang.txt and history.txt
- SlangWord.java, SlangWordList.java – data model and in-memory collection (using Java Collections, e.g., Map<String, List<String>>)
- Top-level files:
- slang.txt – initial data store of slang words and definitions
- history.txt – log of user searches

##### README for additional insights
- Emphasis on Java IO, Collections, OOP.
- The data must load once into a structure for fast (<1s) lookups, persist changes back to files, and preserve indexed data across sessions.
- GUI must present a menu and delegate to concrete page classes.

##### Main components
a. User Interface Layer
- Home (menu)
- Individual Page screens: SearchPage, SearchDefinitionPage, SearchSlangPage, GamePage, GameFindDefinitionPage, GameFindSlangPage, AddPage, EditPage, DeletePage, ManagePage, HistorySearchPage
- Each Page implements event handlers (buttons, text inputs) and calls the Controller/Service layer.
b. Controller / Service Layer
- In Main.java or a dedicated controller class: routes user actions from the UI to model operations; enforces business rules (e.g., duplicate confirmation).
c. Model Layer
- SlangWord (represents a single slang term + definitions)
- SlangWordList (in‐memory collection, indexing, search operations)
d. Data Access Layer
- FileManager (reads slang.txt into SlangWordList on startup; writes back on add/edit/delete; appends to history.txt on search).
e. External Data
- slang.txt (persistent data store)
- history.txt (search history log)

##### Relationships and interactions
- UI → Controller: user clicks/searches → Controller methods invoked
- Controller → Model: request search/add/edit/delete/random → Model updates or queries the SlangWordList
- Model → Data Access: on data mutation → FileManager writes changes to slang.txt
- Controller → Data Access: on search → FileManager appends entry to history.txt
- On startup: Main loads FileManager → reads files → populates SlangWordList

##### Architectural patterns and design principles
- Layered (UI → Controller → Model → Data Access)
- Separation of concerns:
- UI classes only handle rendering & user events
- Business logic in Controller/Service
- Data model encapsulates data structures & search logic
- Persistence abstracted in FileManager
- Use of Java Collections for fast lookup (Map for slang→definitions, List for multiple definitions)
- OOP: each page is a class, SlangWord is a value object

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "UI Layer"
        direction TB
        Home["Home"]:::ui
        AddPage["AddPage"]:::ui
        DeletePage["DeletePage"]:::ui
        EditPage["EditPage"]:::ui
        SearchPage["SearchPage"]:::ui
        SearchDefinitionPage["SearchDefinitionPage"]:::ui
        SearchSlangPage["SearchSlangPage"]:::ui
        ManagePage["ManagePage"]:::ui
        HistorySearchPage["HistorySearchPage"]:::ui
        GamePage["GamePage"]:::ui
        GameFindDefinitionPage["GameFindDefinitionPage"]:::ui
        GameFindSlangPage["GameFindSlangPage"]:::ui
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        Main["Main (Controller)"]:::controller
    end

    %% Model Layer
    subgraph "Model Layer"
        direction TB
        SlangWordList["SlangWordList"]:::model
        SlangWord["SlangWord"]:::model
    end

    %% Data Access Layer
    subgraph "Data Access Layer"
        direction TB
        FileManager["FileManager"]:::dataaccess
    end

    %% External Data
    subgraph "External Data"
        direction TB
        slangTxt(("slang.txt")):::external
        historyTxt(("history.txt")):::external
    end

    %% UI to Controller
    Home -->|"user actions"| Main
    AddPage -->|"user actions"| Main
    DeletePage -->|"user actions"| Main
    EditPage -->|"user actions"| Main
    SearchPage -->|"user actions"| Main
    SearchDefinitionPage -->|"user actions"| Main
    SearchSlangPage -->|"user actions"| Main
    ManagePage -->|"user actions"| Main
    HistorySearchPage -->|"user actions"| Main
    GamePage -->|"user actions"| Main
    GameFindDefinitionPage -->|"user actions"| Main
    GameFindSlangPage -->|"user actions"| Main

    %% Controller to Data Access on startup
    Main -->|"loadData()"| FileManager
    FileManager -->|"loadData()"| SlangWordList

    %% Controller to Model
    Main -->|"search/add/edit/delete/random"| SlangWordList
    SlangWordList -->|"contains"| SlangWord

    %% Model to Data Access on mutations
    SlangWordList -->|"saveData()/resetData()"| FileManager

    %% Controller to Data Access for history logging
    Main -.->|"appendHistory()"| FileManager

    %% Data Access to External Files
    FileManager -->|"write"| slangTxt
    FileManager -->|".append"| historyTxt

    %% Click Events
    click Home "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/Home.java"
    click AddPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/AddPage.java"
    click DeletePage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/DeletePage.java"
    click EditPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/EditPage.java"
    click SearchPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/SearchPage.java"
    click SearchDefinitionPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/SearchDefinitionPage.java"
    click SearchSlangPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/SearchSlangPage.java"
    click ManagePage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/ManagePage.java"
    click HistorySearchPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/HistorySearchPage.java"
    click GamePage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/GamePage.java"
    click GameFindDefinitionPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/GameFindDefinitionPage.java"
    click GameFindSlangPage "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/GameFindSlangPage.java"
    click Main "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/Main.java"
    click FileManager "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/FileManager.java"
    click SlangWord "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/SlangWord.java"
    click SlangWordList "https://github.com/ngoctien0110/slang-dictionary/blob/master/src/SlangWordList.java"
    click slangTxt "https://github.com/ngoctien0110/slang-dictionary/blob/master/slang.txt"
    click historyTxt "https://github.com/ngoctien0110/slang-dictionary/blob/master/history.txt"

    %% Styles
    classDef ui fill:#D6EAF8,stroke:#21618C;
    classDef controller fill:#D5F5E3,stroke:#1D8348;
    classDef model fill:#FCF3CF,stroke:#B7950B;
    classDef dataaccess fill:#F2F3F4,stroke:#7F8C8D;
    classDef external fill:#E8DAEF,stroke:#6C3483;
```
