How angelikimt/retailhub_project works
Project Type and Purpose
• RetailHub is a monolithic, console-based Java application for managing retail operations (clients, products, stores, stock, transactions).
• It follows a layered pattern (presentation → service → persistence) with domain models and JSON export capabilities.
File Structure
Top-level files:
– Main.java: application entry point (CLI or driver).
– TestData.java: bootstraps sample data.
– Domain model classes: Client.java, Product.java, Store.java, Stock.java, Transaction.java, Includes.java (models “line items”).
– Service classes: ClientService.java, ProductService.java, StoreService.java, StockService.java, TransactionService.java.
– README.md: overview & features.
Under src/main/java:
– Transaction.java (duplicate or extension?)
– TransactionDAO.java: data-access object for persisting transactions (likely to JSON files).
README
• Core modules: client, product, store, stock, transaction management.
• All entities support JSON export.
• No external database is specified; persistence is file‐based via JSON.
Main Components & Their Relationships
a. Presentation Layer
– Component: Main (CLI)/TestData
– Role: triggers CRUD and export operations via Services.
b. Service Layer
– Components: *Service classes (ClientService, ProductService, etc.)
– Role: business logic (validations, discount calculations, inventory checks).
c. Persistence Layer
– Component: TransactionDAO (and potentially file-writers within each Service).
– Role: serialize/deserialize entities to/from JSON files.
d. Domain Model
– Components: Entities (Client, Product, Store, Stock, Transaction, Includes).
– Role: data structures passed between layers.
e. External Systems
– JSON file storage (flat files on local filesystem).
Architectural Patterns & Principles
• Layered architecture: Presentation → Service → Persistence → Data Store
• Single Monolith: all modules packaged together.
• Separation of concerns: Services orchestrate domain logic; DAOs handle I/O.
• Dependency flow: Presentation depends on Services → Services depend on Models + DAOs.
1) Presentation (Main.java, TestData)
2) Service Layer (ClientService, ProductService, StoreService, StockService, TransactionService)
3) Persistence Layer (TransactionDAO + JSON Export modules)
4) Data Store (Local JSON files)
– Main.java → ClientService, ProductService, etc.
– Each Service → Domain Entities + TransactionDAO (or File I/O)
– TransactionDAO → JSON file store
– Services may also call each other (e.g., TransactionService checks StockService and ClientService).