https://github.com/cornelber/block-administration-app
A Java-based project developed for educational purposes, simulating a residential building management system, showcasing the implementation of the MVC architecture pattern.
https://github.com/cornelber/block-administration-app
Last synced: 3 months ago
JSON representation
A Java-based project developed for educational purposes, simulating a residential building management system, showcasing the implementation of the MVC architecture pattern.
- Host: GitHub
- URL: https://github.com/cornelber/block-administration-app
- Owner: cornelber
- Created: 2024-02-13T15:23:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-13T15:53:18.000Z (over 1 year ago)
- Last Synced: 2025-01-10T17:40:14.196Z (4 months ago)
- Language: Java
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Block Administration Application
======================================
Overview
--------
The Block Administration Application is a Java-based application designed to manage various aspects of a residential building, including apartments, residents, and expenses. It provides functionality for CRUD operations on apartments and residents, as well as features for managing utility expenses. The app follows the Model-View-Controller (MVC) architecture pattern to ensure a clear separation of concerns and maintainability of code.
Table of Contents
-----------------
* [Overview](#overview)
* [Project Purpose](#project-purpose)
* [Components](#components)
* [Interactions Between Components](#interactions-between-components)
* [Functionality](#functionality)
* [Usage](#usage)
Project Purpose
---------------
The Block Administration Application serves as an educational project, aiming to demonstrate and understand the MVC architecture pattern commonly used in software development.
Components
----------
In the MVC architecture:
* **Model**: Represents the data and business logic of the application. The Person, Apartment, and UtilityExpenses classes serve as models, encapsulating data related to residents, apartments, and utility expenses, respectively.
* **View**: Represents the user interface components responsible for displaying information to the user and capturing user input. Although not explicitly defined as a separate component, the menu system acts as the view, presenting options to the user.
* **Controller**: Acts as an intermediary between the model and view, handling user input, updating the model accordingly, and updating the view to reflect changes in the model. In this app, the MenuController, BlockAdminController, PersonController, ApartmentController, and ExpensesController classes serve as controllers, managing different functionalities and interactions with the models.
Interactions Between Components
-------------------------------
* **MenuController**: Controls menu navigation and routes user selections to appropriate controllers based on input.
* **BlockAdminController**: Manages CRUD operations for apartments and residents, interacting with PersonController and ApartmentController to perform operations.
* **PersonController**: Handles CRUD operations for residents and provides functionality to display residents by specific properties such as age group.
* **ApartmentController**: Manages CRUD operations for apartments and handles operations related to updating the number of residents in an apartment.
* **ExpensesController**: Manages utility expense-related functionalities, interacting with the UtilityExpenses model to calculate and display expense information.
Functionality
-------------
The application provides the following key functionalities:
* **Management of Apartments and Residents**: Allows CRUD operations on apartment and resident information.
* **Utility Expenses Management**: Enables setting and displaying utility expense details, calculating monthly expenses, and viewing individual owner expenses.
* **Menu-Based Navigation**: Provides an intuitive menu-driven interface for users to navigate through different functionalities of the application.
Usage
-----
To use the Block Administration Application:
1. Compile the Java files and run the AppController class.
2. Follow the menu prompts to perform various operations such as managing apartments, residents, and expenses.
3. Utilize the CRUD operations to create, read, update, and delete apartment and resident information.
4. Manage utility expenses by setting expense details, viewing current cost indexes, and calculating monthly expenses.