How kyrillosmaher/university_java_labs works
This project is not a single monolithic application but rather a collection of independent Java lab assignments (and midterm exams) for what appears to be a university-level course (COMP 301). Each lab folder (Lab1, Lab2, …, Lab8, lab5, and the MIDTERMEXAM modules) contains its own self-contained source code, documentation (in the form of assignment sheets and README files), and sometimes compiled binaries. Although each lab solves a different assignment or implements different functionality (for example, Lab2 and Lab3 include "Author" and "Book" model classes; Lab6, Lab7, and others are grouped by questions), the overall structure is essentially modular – each lab is an independent module within a larger learning repository.
Main Components
• Top-Level Container: Represent the overall "University_Java_Labs" repository.
• Modules: Create a distinct component for each lab and exam (e.g., Lab1, Lab2, Lab3, Lab4, lab5, Lab6, Lab7, Lab8, MIDTERMEXAM2022, MIDTERMEXAM23). Each of these modules is a self-contained Java application.
• Within Each Module:
– Source Code (src): Indicate the presence of main drivers (e.g., Main.java, App.java) which act as entry points.
– Models Directory: Represent the domain classes (e.g., QuestionOne.java, Author.java, Car.java, etc.) that encapsulate business logic or data models.
– Configuration/IDE Files: Note the presence of .vscode directories (which are less architecturally relevant but indicate development environment configuration).
Relationships and Interactions
• For every lab module, map out:
– The flow from the entry point (e.g., App.java or Main.java) to the various model classes that it instantiates and manipulates.
– How helper utilities (if any) or secondary classes (for instance, utility methods in ArrayListSimulator or specialized classes in different question folders) are used by the main application driver.
Architectural Patterns and Design Principles
• Modular Design: Emphasize how each lab is self-contained with its own entry point and a set of model or utility classes.
• Layered Structure: Although simple, each module follows a basic layered structure where the main application (UI or main logic) interacts with the models (data representation). Explain this for labs that follow a clear procedural or object-oriented architecture.
• Educational Focus: Note that the purpose is to demonstrate core Java concepts and object-oriented programming principles rather than a sophisticated enterprise architecture.
Relevant Technologies, Frameworks, or Libraries
• Java is the primary programming language used across all labs.
• The presence of .vscode folders indicates that Visual Studio Code or a similar IDE might be in use.
Instructing the Principal Software Engineer
– Label “Lab1” and within it, indicate “Main.java” as the entrance and a cluster of “QuestionX” classes as the business logic.
– Label “Lab2” with its own “Lab2.java” and its “Models” (Author, Book, etc.), showing how the application likely simulates or manages a domain (like a library or book management system).
– Continue similarly for each lab.
– The control/data flow from the application driver to the model classes.
– Interdependencies (if any) within a module; for example, if one model uses or calls another model’s functions.
• Provide annotations where needed to describe:
– The purpose of each component.
– Any patterns (such as “MVC-like separation” though basic).
– The role of key files (e.g., assignment sheets and READMEs that provide context for each lab).