johnosullivan / aoop

Facilities are the building units (buildings and rooms inside) that a company uses to support the activities of the business. This system will support the management of buildings, their constant use, and maintenance support when it is needed. The following are the three main functionalities of this system.

AOOP

Facility Management System

Project Dependencies

• MongoDB - Install Here
• Java 8 Install Here
• JUnit 4.+ Install Here
• Spring 4.+ Install Here

After importing the project into Eclipse, navigate to the "Project Properties" and then to Java libraries. Next, click on "Add External Jars," and within the project root directory is a folder labeled "jars" which contains all the mongo drivers to connect and make a query in Java. Import the following:

• bson-3.6.3.jar
• mongodb-driver-3.6.3.jar
• mongodb-driver-core-3.6.3.jar
• spring 4.3.9 (compatible with Java 8)

Once those three Jars have been included, the project is ready to run the client and JUnit tests. The UML/DB diagram is located Here. To run the test client and junit tests please ensure mongodb is running in the terminal like so,

mongod --dbpath .

.

Clients

• edu.comp373.view.FacilityClient_WithDAOAccess.java
• edu.comp373.view.FacilityClient_WithSpring.java
• edu.comp373.view.FacilityClient_WithSpringAndDAO.java
• edu.comp373.view.FacilityClient_WithSpringPatternsOne.java
• edu.comp373.view.FacilityClient_WithSpringPatternsTwo.java

There are currenlty three clients that interface with the Facility manager system. "FacilityClient_WithDAOAccess" requires a mongoDB session to run on the localhost. "FacilityClient_WithSpring" uses the spring container configuration for dependency injection along with application context. "FacilityClient_WithSpringAndDAO" uses both of the requirements above to operate correctly. "FacilityClient_WithSpringPatterns" uses the spring framework and patterns in a client demo. The dependency relationship using XML is located at META-INF/app-context.xml

Patterns

Bridge Pattern - The bridge patterns were used in the project with the different user types, like the Inspector and FacilityUser. The bridge pattern allowed for the abstraction and implemention to be designed independently along with the client code to access the abstract parts without being worried about the concrete implementaion in the case of the Users in the system (Inspector/FacilityUser). The implementation of the pattern can be found in the following Java source files: FacilityUser.java, Inspector.java, User.java, UserAbstract.java, and UserInterface.java.

Observer Pattern - The observer patterns, which are behavioral patterns, were utilized in the bridge to allow users to attach to different Requests (Inspections/MaintenanceRequest/Reservation), in which any changes to the state of said request will notify any of the users (Observers) who are attached to it. This required the modification of the different requests to be abstract so they could meet the requirements of the Subject in the Observer Pattern. The observer patterns solve the problem of having the Users knowing when Request is updated in state. The implementation of the pattern can be found in the following Java source files: FacilityUser.java, Inspector.java, User.java, UserAbstract.java, UserInterface.java, Observer.java, InspectionInterface.java, MaintenanceRequestInterface.java, ReservationInterface.java, and Request.java.

FacilityClient_WithSpringPatternsOne - The demo will begin with two users using the concrete implementaion of Inspector and FacilityUser. Next, two requests are going to get instances from the spring getBean method. The two different users then attach to the request, where the request will retain all the observers (aka Users). Once the requests are updated it will notifyAllObservers and print an update message from the concrete user implemention.

Visitor Pattern - The visitor pattern allows for abstract functionality which can be applied to a hierarchy of objects. For the project, the visitor pattern is used to visit different Requests (a.k.a. Inspection, Reservations, etc.) to generate a report using the concrete derived class called GenerateReport.java. The implementation of the pattern can be found in the following Java source files: Request.java, ReportPartVisitor.java, Report.java, GenerateReport.java, Reservation.java, Inspection.java, and MaintenanceRequest.java.

Mediator Pattern - The mediator pattern allows for the communication between objects which is actually encapsulated within the mediator object itself. In the case of this project, the mediator is the AppAnnouncementMediator. Users in the management system have the ability to post announcements to the meditor or main hub to which it will nofity the proper users with the announcement object. The implementation of the pattern can be found in the following Java source files: AppAnnouncementMediator.java, AnnouncementMediator.java, UserAbstract.java, UserInterface.java, and User.java.

FacilityClient_WithSpringPatternsTwo - The demo will begin with a Report being generated and printed to the console using the visitor pattern. Lastly, a mediator and two users are created so an announcement can be posted by one and recieved by the other and printed to the console.

Features

Facility.java

• public String getFacilityInformation()
• public boolean assignFacilityToUse(final FacilityUser facilityUser, final LocalDateTime start,final LocalDateTime end)
• public boolean isInUseDuringInterval(final LocalDateTime start, final LocalDateTime end)
• public ArrayList listInspections()

FacilityManager.java

• public ArrayList listFacilities()
• public ArrayList requestAvailableCapacity(Integer capslimit)
• public ArrayList vacateFacility(final LocalDateTime start, final LocalDateTime end)
• public Facility addNewFacility(Facility facility)
• public void addFacilityDetail(Facility facility, DetailType type,Object obj)
• public boolean removeFacility(Facility facility)
• public TreeMap<String, Long> listActualUsage()
• public Double calcUsageRate(Facility facility, LocalDateTime datetime)

MaintenanceManager.java

• public boolean makeFacilityMaintRequest(MaintenanceRequest maintenance)
• public boolean scheduleMaintenance(MaintenanceRequest maintenance)
• public Double calcMaintenanceCostForFacility(Facility facility)
• public Double calcProblemRateForFacility(Facility facility)
• public Double calcDownTimeForFacility(Facility facility)
• public ArrayList listMaintRequests()
• public ArrayList listMaintenance()
• public ArrayList listFacilityProblems()

Additional Supporting Classes

• Address.java / AddressInterface.java
• FacilityInterface.java
• LocalTimeRange.java
• Location.java / LocationInterface.java
• Inspection.java / InspectionInterfacce.java
• MaintenanceRequest.java / MaintenanceRequestInterface.java
• FacilityManagerInterface.java
• MaintenanceManagerInterface.java
• Reservation.java / ReservationInterface.java
• FacilityUser.java / Inspector.java / UserInterface.java